org.apache.karaf.management

Interface JMXSecurityMBean

All Known Implementing Classes:

JMXSecurityMBeanImpl

public interface JMXSecurityMBean

Security MBean. This MBean can be used to find out whether the currently logged user can access certain MBeans or invoke operations on these MBeans. It can be used when building client-facing consoles to ensure that only operations appropriate for the current user are presented.

This MBean does not actually invoke any operations on the given objects, it only checks permissions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JMXSecurityMBean.SecurityMBeanOpenTypeInitializer

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	CAN_INVOKE_RESULT_COLUMNS The columns contained in a CAN_INVOKE_RESULT_ROW_TYPE.
static CompositeType	CAN_INVOKE_RESULT_ROW_TYPE A row as returned by the CAN_INVOKE_TABULAR_TYPE.
static TabularType	CAN_INVOKE_TABULAR_TYPE The Tabular Type returned by the canInvoke(Map) operation.

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.

Field Detail

CAN_INVOKE_TABULAR_TYPE

static final TabularType CAN_INVOKE_TABULAR_TYPE

The Tabular Type returned by the canInvoke(Map) operation. The rows consist of CAN_INVOKE_RESULT_ROW_TYPE entries. It has a composite key composed by the "ObjectName" and "Method" columns.

CAN_INVOKE_RESULT_ROW_TYPE

static final CompositeType CAN_INVOKE_RESULT_ROW_TYPE

A row as returned by the CAN_INVOKE_TABULAR_TYPE. The columns of the row are defined by CAN_INVOKE_RESULT_COLUMNS

CAN_INVOKE_RESULT_COLUMNS

static final String[] CAN_INVOKE_RESULT_COLUMNS

The columns contained in a CAN_INVOKE_RESULT_ROW_TYPE. The data types for these columns are as follows:

• "ObjectName": SimpleType.STRING
• "Method": SimpleType.STRING
• "CanInvoke": SimpleType.BOOLEAN

Method Detail

canInvoke

boolean canInvoke(String objectName)
                  throws Exception

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

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

boolean canInvoke(String objectName,
                String methodName)
                  throws Exception

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

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

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

Checks whether the current user can invoke the given method.

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

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

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

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 CAN_INVOKE_TABULAR_TYPE

Throws:

Exception