Package org.jppf.jmxremote

Interface JMXAuthorizationChecker

All Known Implementing Classes:

JMXAuthorizationCheckerAdapter, JMXAuthorizationDeniedAdapter

public interface JMXAuthorizationChecker

This interface represents a set of authorization checks for a given authenticated subject.

A check is available for each method available in the MBeanServerConnection interface and is implemented as a method whose name is made of the "check" prefix, followed by the name of the method to check.

An authorization failure is raised by throwing an exception in a checkXXX() method.

Author:

Laurent Cohen

Method Summary

Modifier and Type	Method	Description
void	checkAddNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)	Check that the subject can invoke the MBeanServerConnection.addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object) method on the mbean server.
void	checkAddNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)	Check that the subject can invoke the MBeanServerConnection.addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object) method on the mbean server.
void	checkCreateMBean(String className, ObjectName name)	Check that the subject can invoke the MBeanServerConnection.createMBean(String, ObjectName) method on the mbean server.
void	checkCreateMBean(String className, ObjectName name, Object[] params, String[] signature)	Check that the subject can invoke the MBeanServerConnection.createMBean(String, ObjectName, Object[], String[]) method on the mbean server.
void	checkCreateMBean(String className, ObjectName name, ObjectName loaderName)	Check that the subject can invoke the MBeanServerConnection.createMBean(String, ObjectName, ObjectName) method on the mbean server.
void	checkCreateMBean(String className, ObjectName name, ObjectName loaderName, Object[] params, String[] signature)	Check that the subject can invoke the MBeanServerConnection.createMBean(String, ObjectName, ObjectName, Object[], String[]) method on the mbean server.
void	checkGetAttribute(ObjectName name, String attribute)	Check that the subject can invoke the MBeanServerConnection.getAttribute(ObjectName, String) method on the mbean server.
void	checkGetAttributes(ObjectName name, String[] attributes)	Check that the subject can invoke the MBeanServerConnection.getAttributes(ObjectName, String[]) method on the mbean server.
void	checkGetDefaultDomain()	Check that the subject can invoke the MBeanServerConnection.getDefaultDomain() method on the mbean server.
void	checkGetDomains()	Check that the subject can invoke the MBeanServerConnection.getDomains() method on the mbean server.
void	checkGetMBeanCount()	Check that the subject can invoke the MBeanServerConnection.getMBeanCount() method on the mbean server.
void	checkGetMBeanInfo(ObjectName name)	Check that the subject can invoke the MBeanServerConnection.getMBeanInfo(ObjectName) method on the mbean server.
void	checkGetObjectInstance(ObjectName name)	Check that the subject can invoke the MBeanServerConnection.getObjectInstance(ObjectName) method on the mbean server.
void	checkInvoke(ObjectName name, String operationName, Object[] params, String[] signature)	Check that the subject can invoke the MBeanServerConnection.invoke(ObjectName, String, Object[], String[]) method on the mbean server.
void	checkIsInstanceOf(ObjectName name, String className)	Check that the subject can invoke the MBeanServerConnection.isInstanceOf(ObjectName, String) method on the mbean server.
void	checkIsRegistered(ObjectName name)	Check that the subject can invoke the MBeanServerConnection.isRegistered(ObjectName) method on the mbean server.
void	checkQueryMBeans(ObjectName name, QueryExp query)	Check that the subject can invoke the MBeanServerConnection.queryMBeans(ObjectName, QueryExp) method on the mbean server.
void	checkQueryNames(ObjectName name, QueryExp query)	Check that the subject can invoke the MBeanServerConnection.queryNames(ObjectName, QueryExp) method on the mbean server.
void	checkRemoveNotificationListener(ObjectName name, NotificationListener listener)	Check that the subject can invoke the MBeanServerConnection.removeNotificationListener(ObjectName, NotificationListener) method on the mbean server.
void	checkRemoveNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)	Check that the subject can invoke the MBeanServerConnection.removeNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object) method on the mbean server.
void	checkRemoveNotificationListener(ObjectName name, ObjectName listener)	Check that the subject can invoke the MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName) method on the mbean server.
void	checkRemoveNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)	Check that the subject can invoke the MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object) method on the mbean server.
void	checkSetAttribute(ObjectName name, Attribute attribute)	Check that the subject can invoke the MBeanServerConnection.setAttribute(ObjectName, Attribute) method on the mbean server.
void	checkSetAttributes(ObjectName name, AttributeList attributes)	Check that the subject can invoke the MBeanServerConnection.setAttributes(ObjectName, AttributeList) method on the mbean server.
void	checkUnregisterMBean(ObjectName name)	Check that the subject can invoke the MBeanServerConnection.unregisterMBean(ObjectName) method on the mbean server.
Subject	getSubject()	Get the authenticated subject to check for authorization.
void	setSubject(Subject subject)	Set the authenticated subject to check for authorization.

Method Details

getSubject

Subject getSubject()

Get the authenticated subject to check for authorization.

Returns:

the authenticated Subject, if any.

setSubject

void setSubject(Subject subject)

Set the authenticated subject to check for authorization.

Parameters:

subject - the authenticated Subject to set.

checkCreateMBean

void checkCreateMBean(String className,
 ObjectName name)
               throws Exception

Check that the subject can invoke the MBeanServerConnection.createMBean(String, ObjectName) method on the mbean server.

Parameters:

className - the class name of the MBean to instantiate.

name - the object name of the MBean. May be null.

Throws:

Exception - if the subject is not authorized.

checkCreateMBean

void checkCreateMBean(String className,
 ObjectName name,
 ObjectName loaderName)
               throws Exception

Check that the subject can invoke the MBeanServerConnection.createMBean(String, ObjectName, ObjectName) method on the mbean server.

Parameters:

className - the class name of the MBean to be instantiated.

name - the object name of the MBean. May be null.

loaderName - the object name of the class loader to be used.

Throws:

Exception - if the subject is not authorized.

checkCreateMBean

void checkCreateMBean(String className,
 ObjectName name,
 Object[] params,
 String[] signature)
               throws Exception

Check that the subject can invoke the MBeanServerConnection.createMBean(String, ObjectName, Object[], String[]) method on the mbean server.

Parameters:

className - the class name of the MBean to instantiate.

name - the object name of the MBean. May be null.

params - an array containing the parameters of the constructor to invoke.

signature - an array containing the signature of the constructor to invoke.

Throws:

Exception - if the subject is not authorized.

checkCreateMBean

void checkCreateMBean(String className,
 ObjectName name,
 ObjectName loaderName,
 Object[] params,
 String[] signature)
               throws Exception

Check that the subject can invoke the MBeanServerConnection.createMBean(String, ObjectName, ObjectName, Object[], String[]) method on the mbean server.

Parameters:

className - The class name of the MBean to instantiate.

name - the object name of the MBean. May be null.

loaderName - the object name of the class loader to use.

params - an array containing the parameters of the constructor to invoke.

signature - an array containing the signature of the constructor to invoke.

Throws:

Exception - if the subject is not authorized.

checkUnregisterMBean

void checkUnregisterMBean(ObjectName name)
                   throws Exception

Check that the subject can invoke the MBeanServerConnection.unregisterMBean(ObjectName) method on the mbean server.

Parameters:

name - the object name of the MBean to unregister.

Throws:

Exception - if the subject is not authorized.

checkGetObjectInstance

void checkGetObjectInstance(ObjectName name)
                     throws Exception

Check that the subject can invoke the MBeanServerConnection.getObjectInstance(ObjectName) method on the mbean server.

Parameters:

name - the object name of the MBean.

Throws:

Exception - if the subject is not authorized.

checkQueryMBeans

void checkQueryMBeans(ObjectName name,
 QueryExp query)
               throws Exception

Check that the subject can invoke the MBeanServerConnection.queryMBeans(ObjectName, QueryExp) method on the mbean server.

Parameters:

name - the object name pattern identifying the MBeans to retrieve.

query - the query expression to apply for selecting MBeans.

Throws:

Exception - if the subject is not authorized.

checkQueryNames

void checkQueryNames(ObjectName name,
 QueryExp query)
              throws Exception

Check that the subject can invoke the MBeanServerConnection.queryNames(ObjectName, QueryExp) method on the mbean server.

Parameters:

name - the object name pattern identifying the MBean names to retrieve.

query - the query expression to apply for selecting MBeans.

Throws:

Exception - if the subject is not authorized.

checkIsRegistered

void checkIsRegistered(ObjectName name)
                throws Exception

Check that the subject can invoke the MBeanServerConnection.isRegistered(ObjectName) method on the mbean server.

Parameters:

name - the object name of the MBean to check.

Throws:

Exception - if the subject is not authorized.

checkGetMBeanCount

void checkGetMBeanCount()
                 throws Exception

Check that the subject can invoke the MBeanServerConnection.getMBeanCount() method on the mbean server.

Throws:

Exception - if the subject is not authorized.

checkGetAttribute

void checkGetAttribute(ObjectName name,
 String attribute)
                throws Exception

Check that the subject can invoke the MBeanServerConnection.getAttribute(ObjectName, String) method on the mbean server.

Parameters:

name - the object name of the MBean from which the attribute is to be retrieved.

attribute - A String specifying the name of the attribute to retrieve.

Throws:

Exception - if the subject is not authorized.

checkGetAttributes

void checkGetAttributes(ObjectName name,
 String[] attributes)
                 throws Exception

Check that the subject can invoke the MBeanServerConnection.getAttributes(ObjectName, String[]) method on the mbean server.

Parameters:

name - the object name of the MBean from which the attributes are retrieved.

attributes - a list of the attributes to retrieve.

Throws:

Exception - if the subject is not authorized.

checkSetAttribute

void checkSetAttribute(ObjectName name,
 Attribute attribute)
                throws Exception

Check that the subject can invoke the MBeanServerConnection.setAttribute(ObjectName, Attribute) method on the mbean server.

Parameters:

name - the name of the MBean within which the attribute is to be set.

attribute - The identification of the attribute to set and the value to set it to.

Throws:

Exception - if the subject is not authorized.

checkSetAttributes

void checkSetAttributes(ObjectName name,
 AttributeList attributes)
                 throws Exception

Check that the subject can invoke the MBeanServerConnection.setAttributes(ObjectName, AttributeList) method on the mbean server.

Parameters:

name - The object name of the MBean within which the attributes are to be set.

attributes - A list of attributes: the identification of the attributes to set and the values to set them to.

Throws:

Exception - if the subject is not authorized.

checkInvoke

void checkInvoke(ObjectName name,
 String operationName,
 Object[] params,
 String[] signature)
          throws Exception

Check that the subject can invoke the MBeanServerConnection.invoke(ObjectName, String, Object[], String[]) method on the mbean server.

Parameters:

name - the object name of the MBean on which the method is invoked.

operationName - the name of the operation to invoke.

params - an array containing the parameters to set when the operation is invoked.

signature - an array containing the signature of the operation, an array of class names in the format returned by Class.getName().

Throws:

Exception - if the subject is not authorized.

checkGetDefaultDomain

void checkGetDefaultDomain()
                    throws Exception

Check that the subject can invoke the MBeanServerConnection.getDefaultDomain() method on the mbean server.

Throws:

Exception - if the subject is not authorized.

checkGetDomains

void checkGetDomains()
              throws Exception

Check that the subject can invoke the MBeanServerConnection.getDomains() method on the mbean server.

Throws:

Exception - if the subject is not authorized.

checkAddNotificationListener

void checkAddNotificationListener(ObjectName name,
 NotificationListener listener,
 NotificationFilter filter,
 Object handback)
                           throws Exception

Check that the subject can invoke the MBeanServerConnection.addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object) method on the mbean server.

Parameters:

name - the name of the MBean on which the listener should be added.

listener - the listener object which will handle the notifications emitted by the registered MBean.

filter - the filter object.

handback - the context to send to the listener when a notification is emitted.

Throws:

Exception - if the subject is not authorized.

checkAddNotificationListener

void checkAddNotificationListener(ObjectName name,
 ObjectName listener,
 NotificationFilter filter,
 Object handback)
                           throws Exception

Check that the subject can invoke the MBeanServerConnection.addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object) method on the mbean server.

Parameters:

name - the name of the MBean on which the listener should be added.

listener - the object name of the listener object which will handle the notifications emitted by the registered MBean.

filter - the filter object.

handback - the context to send to the listener when a notification is emitted.

Throws:

Exception - if the subject is not authorized.

checkRemoveNotificationListener

void checkRemoveNotificationListener(ObjectName name,
 ObjectName listener)
                              throws Exception

Check that the subject can invoke the MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName) method on the mbean server.

Parameters:

name - the name of the MBean on which the listener should be added.

listener - the object name of the listener object which will handle the notifications emitted by the registered MBean.

Throws:

Exception - if the subject is not authorized.

checkRemoveNotificationListener

void checkRemoveNotificationListener(ObjectName name,
 ObjectName listener,
 NotificationFilter filter,
 Object handback)
                              throws Exception

Check that the subject can invoke the MBeanServerConnection.removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object) method on the mbean server.

Parameters:

name - the name of the MBean on which the listener should be removed.

listener - the object name of the listener to remove.

filter - the filter that was specified when the listener was added.

handback - the handback that was specified when the listener was added.

Throws:

Exception - if the subject is not authorized.

checkRemoveNotificationListener

void checkRemoveNotificationListener(ObjectName name,
 NotificationListener listener)
                              throws Exception

Check that the subject can invoke the MBeanServerConnection.removeNotificationListener(ObjectName, NotificationListener) method on the mbean server.

Parameters:

name - the name of the MBean on which the listener should be removed.

listener - the listener object to remove.

Throws:

Exception - if the subject is not authorized.

checkRemoveNotificationListener

void checkRemoveNotificationListener(ObjectName name,
 NotificationListener listener,
 NotificationFilter filter,
 Object handback)
                              throws Exception

Check that the subject can invoke the MBeanServerConnection.removeNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object) method on the mbean server.

Parameters:

name - the name of the MBean on which the listener should be removed.

listener - the listener object to remove.

filter - the filter that was specified when the listener was added.

handback - the handback that was specified when the listener was added.

Throws:

Exception - if the subject is not authorized.

checkGetMBeanInfo

void checkGetMBeanInfo(ObjectName name)
                throws Exception

Check that the subject can invoke the MBeanServerConnection.getMBeanInfo(ObjectName) method on the mbean server.

Parameters:

name - the name of the MBean to analyze

Throws:

Exception - if the subject is not authorized.

checkIsInstanceOf

void checkIsInstanceOf(ObjectName name,
 String className)
                throws Exception

Check that the subject can invoke the MBeanServerConnection.isInstanceOf(ObjectName, String) method on the mbean server.

Parameters:

name - the object name of the MBean.

className - the name of the class.

Throws:

Exception - if the subject is not authorized.