Skip navigation links

com.bea.wlevs.management.configuration
Interface CartridgeMBean

public interface CartridgeMBean

extends WebLogicMBean

MBean interface that must be extended by Cartridge implementations to be able to query about the extensibility mechanisms of the Cartridge.

The CartridgeMBean name will be Domain=<domain name>,Name=<cartridge name>,Type=Cartridge The CartridgeMBean may be looked up directly from the MBeanServer using its name as given above.

Inner Class Summary

static class

CartridgeMBean.FunctionDescKeys Returns information of the specified function.

Field Summary
static java.lang.String	MBEAN_TYPE

Method Summary
java.util.List	getApplicationContexts(java.lang.String appName) Returns all the context names associated with the given application available for this cartridge.
java.util.List	getFunctionBatch(java.lang.String appName, java.lang.String contextID, int startIndex, int batchSize) Returns the specified batch of functions for the given context id.
int	getFunctionCount(java.lang.String appName, java.lang.String contextID) Returns the number of functions available for the given context.
java.util.List	getFunctions(java.lang.String appName, java.lang.String contextID) Returns information about all the functions supported by this cartrige.
java.lang.String	getName() Returns the name of the cartridge.
java.util.List	getServerContexts() Returns all the server level context names available for this cartridge.

Methods inherited from interface com.bea.wlevs.management.WebLogicMBean

getObjectName, getType

Field Detail

MBEAN_TYPE

public static final java.lang.String MBEAN_TYPE

Method Detail

getName

public java.lang.String getName()

Returns the name of the cartridge.

Specified by:

getName in interface WebLogicMBean

Returns:

name of the cartridge

getServerContexts

public java.util.List getServerContexts()
                                 throws javax.management.JMException

Returns all the server level context names available for this cartridge.

Returns:

List of names of all the server level contexts for this cartridge

Throws:

javax.management.JMException - if an unexpected error occurs

getApplicationContexts

public java.util.List getApplicationContexts(java.lang.String appName)
                                      throws javax.management.JMException

Returns all the context names associated with the given application available for this cartridge.

Parameters:

appName - the name of the application for which cartridge contexts should be returned

Returns:

List of names of all application level contexts for this cartridge

Throws:

javax.management.JMException - if an unexpected error occurs

getFunctionCount

public int getFunctionCount(java.lang.String appName,
                            java.lang.String contextID)
                     throws javax.management.JMException

Returns the number of functions available for the given context. This method could also be used to make a decision as to whether the functions should be fetched in batches or all at once.

Parameters:

appName - the name of the application to which this context is associated. This may be null if this is a server context.

contextID - the context id for which functions count is to be found

Returns:

number of functions available for the given context

Throws:

javax.management.JMException - if the context ID does not exist or if an unexpected error occurs

getFunctionBatch

public java.util.List getFunctionBatch(java.lang.String appName,
                                       java.lang.String contextID,
                                       int startIndex,
                                       int batchSize)
                                throws javax.management.JMException

Returns the specified batch of functions for the given context id.

Parameters:

appName - the name of the application to which this context is associated. This may be null if this is a server context.

contextID - the ID of the context for which functions are to be fetched

startIndex - the starting index for the batch of functions

batchSize - the number of functions that must be retrieved by this call.

Returns:

a List containing Maps with information about the individual functions. The Maps contain the function name, input parameter type class names and return type name. The strings used for the Map keys are defined in the enum FunctionDescKeys. The returned List will have batchSize elements, unless there were not enough to return, in which case it will have fewer entries.

Throws:

javax.management.JMException - if the context ID does not exist or if an unexpected error occurs

getFunctions

public java.util.List getFunctions(java.lang.String appName,
                                   java.lang.String contextID)
                            throws javax.management.JMException

Returns information about all the functions supported by this cartrige.

Parameters:

appName - the name of the application to which this context is associated. This may be null if this is a server context.

contextID - the context id for which functions are to be fetched

Returns:

a List containing Maps with information about the individual functions. The Maps contain the function name, input parameter type class names and return type name. The strings used for the Map keys are defined in the enum FunctionDescKeys.

Throws:

javax.management.JMException - if the context ID does not exist or if an unexpected error occurs