public interface AdminInterface
It allows users to perform administration on the end system using the Message Broker command and CMP.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
copyright |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
adminKey() |
void |
changeAdminObject(java.lang.String adminFunction,
java.util.Properties adminParamters,
java.lang.String adminObjectType,
java.lang.String adminObjectName)
This is called by broker to execute an administration operation against the message provider.
|
java.util.Properties |
listAdminObjectProperties(java.lang.String adminObjectType,
java.lang.String adminObjectName)
This is called by broker to get a list of properties for a given object name.
|
java.lang.String[] |
listAdminObjectsForType(java.lang.String adminObjectType)
This is called by broker to get a list of all objects that exist for the given object type.
|
java.lang.String[] |
listAdminObjectTypes()
This is called by broker to get a name to use this administered object.
|
static final java.lang.String copyright
java.lang.String adminKey() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
java.lang.String[] listAdminObjectTypes() throws com.ibm.broker.plugin.MbException
com.ibm.broker.plugin.MbException
- Throwing an exception will cause the reporting of the resource to fail.java.lang.String[] listAdminObjectsForType(java.lang.String adminObjectType) throws com.ibm.broker.plugin.MbException
adminObjectType
- The name of the object type to retrieve data on.com.ibm.broker.plugin.MbException
- Throwing an exception will cause the reporting of the resource to fail.java.util.Properties listAdminObjectProperties(java.lang.String adminObjectType, java.lang.String adminObjectName) throws com.ibm.broker.plugin.MbException
adminObjectType
- The name of the object type to retrieve data on.adminObjectName
- The name of the object to retrieve data on.com.ibm.broker.plugin.MbException
- Throwing an exception will cause the reporting of the resource to fail.void changeAdminObject(java.lang.String adminFunction, java.util.Properties adminParamters, java.lang.String adminObjectType, java.lang.String adminObjectName) throws com.ibm.broker.plugin.MbException
adminFunction
- The administration function to execute.adminParamters
- The administration parameters for the execute function.adminObjectType
- The name of the object type to retrieve data on.adminObjectName
- The name of the object to retrieve data on.com.ibm.broker.plugin.MbException
- Throwing an exception will cause the changing of the resource to fail.