Class ManagementHelper
- java.lang.Object
-
- org.apache.activemq.artemis.api.core.management.ManagementHelper
-
public final class ManagementHelper extends Object
Helper class to use ActiveMQ Artemis Core messages to manage server resources.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ManagementHelper.MessageAcceptor
-
Field Summary
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
doManagement(String uri, String user, String password, ManagementHelper.MessageAcceptor setup, ManagementHelper.MessageAcceptor ok, ManagementHelper.MessageAcceptor failed)
static void
doManagement(ClientSession session, ManagementHelper.MessageAcceptor setup, ManagementHelper.MessageAcceptor ok, ManagementHelper.MessageAcceptor failed)
Utility function to reuse a ClientSessionConnection and perform a single management operation via core.static void
doManagement(ServerLocator locator, String user, String password, ManagementHelper.MessageAcceptor setup, ManagementHelper.MessageAcceptor ok, ManagementHelper.MessageAcceptor failed)
static Object
getResult(ICoreMessage message)
Returns the result of an operation invocation or an attribute value.static Object
getResult(ICoreMessage message, Class desiredType)
Returns the result of an operation invocation or an attribute value.static Object[]
getResults(ICoreMessage message)
Returns the result of an operation invocation or an attribute value.static boolean
hasOperationSucceeded(Message message)
Returns whether the invocation of the management operation on the server resource succeeded.static boolean
isAttributesResult(Message message)
Returns whether the JMS message corresponds to the result of a management attribute value.static boolean
isOperationResult(Message message)
Returns whether the JMS message corresponds to the result of a management operation invocation.static void
putAttribute(ICoreMessage message, String resourceName, String attribute)
Stores a resource attribute in a message to retrieve the value from the server resource.static void
putOperationInvocation(ICoreMessage message, String resourceName, String operationName)
Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.static void
putOperationInvocation(ICoreMessage message, String resourceName, String operationName, Object... parameters)
Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.static Object[]
retrieveOperationParameters(Message message)
Used by ActiveMQ Artemis management service.static void
storeResult(org.apache.activemq.artemis.core.message.impl.CoreMessage message, Object result)
Used by ActiveMQ Artemis management service.
-
-
-
Field Detail
-
HDR_RESOURCE_NAME
public static final SimpleString HDR_RESOURCE_NAME
-
HDR_ATTRIBUTE
public static final SimpleString HDR_ATTRIBUTE
-
HDR_OPERATION_NAME
public static final SimpleString HDR_OPERATION_NAME
-
HDR_OPERATION_SUCCEEDED
public static final SimpleString HDR_OPERATION_SUCCEEDED
-
HDR_NOTIFICATION_TYPE
public static final SimpleString HDR_NOTIFICATION_TYPE
-
HDR_NOTIFICATION_TIMESTAMP
public static final SimpleString HDR_NOTIFICATION_TIMESTAMP
-
HDR_ROUTING_NAME
public static final SimpleString HDR_ROUTING_NAME
-
HDR_CLUSTER_NAME
public static final SimpleString HDR_CLUSTER_NAME
-
HDR_ADDRESS
public static final SimpleString HDR_ADDRESS
-
HDR_ROUTING_TYPE
public static final SimpleString HDR_ROUTING_TYPE
-
HDR_BINDING_ID
public static final SimpleString HDR_BINDING_ID
-
HDR_BINDING_TYPE
public static final SimpleString HDR_BINDING_TYPE
-
HDR_FILTERSTRING
public static final SimpleString HDR_FILTERSTRING
-
HDR_DISTANCE
public static final SimpleString HDR_DISTANCE
-
HDR_CONSUMER_COUNT
public static final SimpleString HDR_CONSUMER_COUNT
-
HDR_USER
public static final SimpleString HDR_USER
-
HDR_VALIDATED_USER
public static final SimpleString HDR_VALIDATED_USER
-
HDR_CERT_SUBJECT_DN
public static final SimpleString HDR_CERT_SUBJECT_DN
-
HDR_CHECK_TYPE
public static final SimpleString HDR_CHECK_TYPE
-
HDR_SESSION_NAME
public static final SimpleString HDR_SESSION_NAME
-
HDR_REMOTE_ADDRESS
public static final SimpleString HDR_REMOTE_ADDRESS
-
HDR_PROPOSAL_GROUP_ID
public static final SimpleString HDR_PROPOSAL_GROUP_ID
-
HDR_PROPOSAL_VALUE
public static final SimpleString HDR_PROPOSAL_VALUE
-
HDR_PROPOSAL_ALT_VALUE
public static final SimpleString HDR_PROPOSAL_ALT_VALUE
-
HDR_CONSUMER_NAME
public static final SimpleString HDR_CONSUMER_NAME
-
HDR_CONNECTION_NAME
public static final SimpleString HDR_CONNECTION_NAME
-
HDR_MESSAGE_ID
public static final SimpleString HDR_MESSAGE_ID
-
HDR_PROTOCOL_NAME
public static final SimpleString HDR_PROTOCOL_NAME
-
HDR_CLIENT_ID
public static final SimpleString HDR_CLIENT_ID
-
-
Method Detail
-
doManagement
public static void doManagement(String uri, String user, String password, ManagementHelper.MessageAcceptor setup, ManagementHelper.MessageAcceptor ok, ManagementHelper.MessageAcceptor failed) throws Exception
- Throws:
Exception
-
doManagement
public static void doManagement(ServerLocator locator, String user, String password, ManagementHelper.MessageAcceptor setup, ManagementHelper.MessageAcceptor ok, ManagementHelper.MessageAcceptor failed) throws Exception
- Throws:
Exception
-
doManagement
public static void doManagement(ClientSession session, ManagementHelper.MessageAcceptor setup, ManagementHelper.MessageAcceptor ok, ManagementHelper.MessageAcceptor failed) throws Exception
Utility function to reuse a ClientSessionConnection and perform a single management operation via core.- Throws:
Exception
-
putAttribute
public static void putAttribute(ICoreMessage message, String resourceName, String attribute)
Stores a resource attribute in a message to retrieve the value from the server resource.- Parameters:
message
- messageresourceName
- the name of the resourceattribute
- the name of the attribute- See Also:
ResourceNames
-
putOperationInvocation
public static void putOperationInvocation(ICoreMessage message, String resourceName, String operationName) throws Exception
Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.- Parameters:
message
- messageresourceName
- the name of the resourceoperationName
- the name of the operation to invoke on the resource- Throws:
Exception
- See Also:
ResourceNames
-
putOperationInvocation
public static void putOperationInvocation(ICoreMessage message, String resourceName, String operationName, Object... parameters) throws Exception
Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.- Parameters:
message
- messageresourceName
- the name of the server resourceoperationName
- the name of the operation to invoke on the server resourceparameters
- the parameters to use to invoke the server resource- Throws:
Exception
- See Also:
ResourceNames
-
retrieveOperationParameters
public static Object[] retrieveOperationParameters(Message message) throws Exception
Used by ActiveMQ Artemis management service.- Throws:
Exception
-
isOperationResult
public static boolean isOperationResult(Message message)
Returns whether the JMS message corresponds to the result of a management operation invocation.
-
isAttributesResult
public static boolean isAttributesResult(Message message)
Returns whether the JMS message corresponds to the result of a management attribute value.
-
storeResult
public static void storeResult(org.apache.activemq.artemis.core.message.impl.CoreMessage message, Object result) throws Exception
Used by ActiveMQ Artemis management service.- Throws:
Exception
-
getResults
public static Object[] getResults(ICoreMessage message) throws Exception
Returns the result of an operation invocation or an attribute value.
If an error occurred on the server,hasOperationSucceeded(Message)
will returnfalse
. and the result will be a String corresponding to the server exception.- Throws:
Exception
-
getResult
public static Object getResult(ICoreMessage message) throws Exception
Returns the result of an operation invocation or an attribute value.
If an error occurred on the server,hasOperationSucceeded(Message)
will returnfalse
. and the result will be a String corresponding to the server exception.- Throws:
Exception
-
getResult
public static Object getResult(ICoreMessage message, Class desiredType) throws Exception
Returns the result of an operation invocation or an attribute value.
If an error occurred on the server,hasOperationSucceeded(Message)
will returnfalse
. and the result will be a String corresponding to the server exception.- Throws:
Exception
-
hasOperationSucceeded
public static boolean hasOperationSucceeded(Message message)
Returns whether the invocation of the management operation on the server resource succeeded.
-
-