org.apache.karaf.management.internal

Class JMXSecurityMBeanImpl

java.lang.Object

javax.management.StandardMBean

org.apache.karaf.management.internal.JMXSecurityMBeanImpl

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, JMXSecurityMBean

public class JMXSecurityMBeanImpl
extends StandardMBean
implements JMXSecurityMBean

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.karaf.management.JMXSecurityMBean

JMXSecurityMBean.SecurityMBeanOpenTypeInitializer

Field Summary

Fields inherited from interface org.apache.karaf.management.JMXSecurityMBean

CAN_INVOKE_RESULT_COLUMNS, CAN_INVOKE_RESULT_ROW_TYPE, CAN_INVOKE_TABULAR_TYPE

Constructor Summary

Constructors

Constructor and Description
JMXSecurityMBeanImpl()

Method Summary

Methods

Modifier and Type	Method and Description
TabularData	canInvoke(Map<String,List<String>> bulkQuery) Bulk operation to check whether the current user can access the requested MBeans or invoke the requested methods.
boolean	canInvoke(String objectName) Checks whether the current user can invoke any methods on a JMX MBean.
boolean	canInvoke(String objectName, String methodName) Checks whether the current user can invoke overload of the given method.
boolean	canInvoke(String objectName, String methodName, String[] argumentTypes) Checks whether the current user can invoke the given method.
KarafMBeanServerGuard	getGuard()
MBeanServer	getMBeanServer()
void	setGuard(KarafMBeanServerGuard guard)
void	setMBeanServer(MBeanServer mbeanServer)

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, getMBeanInterface, getParameterName, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMXSecurityMBeanImpl

public JMXSecurityMBeanImpl()
                     throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Detail

canInvoke

public boolean canInvoke(String objectName)
                  throws Exception

Description copied from interface: JMXSecurityMBean

Checks whether the current user can invoke any methods on a JMX MBean.

Specified by:

canInvoke in interface JMXSecurityMBean

Parameters:

objectName - the Object Name of the JMX MBean.

Returns:

true if there is at least one method on the MBean that the user can invoke, false else.

Throws:

Exception

canInvoke

public boolean canInvoke(String objectName,
                String methodName)
                  throws Exception

Description copied from interface: JMXSecurityMBean

Checks whether the current user can invoke overload of the given method.

Specified by:

canInvoke in interface JMXSecurityMBean

Parameters:

objectName - the Object Name of the JMX MBean.

methodName - the name of the method to check.

Returns:

true if there is an overload of the specified method that the user can invoke, false else.

Throws:

Exception

canInvoke

public boolean canInvoke(String objectName,
                String methodName,
                String[] argumentTypes)
                  throws Exception

Description copied from interface: JMXSecurityMBean

Checks whether the current user can invoke the given method.

Specified by:

canInvoke in interface JMXSecurityMBean

Parameters:

objectName - the Object Name of the JMX MBean.

methodName - the name of the method to check.

argumentTypes - the argument types of the method.

Returns:

true if the user is allowed to invoke the method, or any of the methods with the given name if null is used for the arguments. There may still be certain values that the user does not have permissions to pass to the method.

Throws:

Exception

canInvoke

public TabularData canInvoke(Map<String,List<String>> bulkQuery)
                      throws Exception

Description copied from interface: JMXSecurityMBean

Bulk operation to check whether the current user can access the requested MBeans or invoke the requested methods.

Specified by:

canInvoke in interface JMXSecurityMBean

Parameters:

bulkQuery - a map of Object Name to requested operations. Operations can be specified with or without argument types. An operation without arguments matches any overloaded method with this name. If an empty list is provided for the operation names, a check is done whether the current user can invoke any operation on the MBean.

Example:

Map<String, List<String>> query = new HashMap<>();
                  String objectName = "org.acme:type=SomeMBean";
                  query.put(objectName, Arrays.asList(
                      "testMethod(long,java.lang.String)", // check this testMethod
                      "otherMethod"));                     // check any overload of otherMethod
                  query.put("org.acme:type=SomeOtherMBean",
                      Collections.<String>emptyList());    // check any method of SomeOtherMBean
                  TabularData result = mb.canInvoke(query);
                  

Returns:

A Tabular Data object with the result. This object conforms the structure as defined in JMXSecurityMBean.CAN_INVOKE_TABULAR_TYPE

Throws:

Exception

getMBeanServer

public MBeanServer getMBeanServer()

setMBeanServer

public void setMBeanServer(MBeanServer mbeanServer)

getGuard

public KarafMBeanServerGuard getGuard()

setGuard

public void setGuard(KarafMBeanServerGuard guard)