org.jboss.as.messaging

Class QueueControlHandler

java.lang.Object

org.jboss.as.controller.AbstractRuntimeOnlyHandler

org.jboss.as.messaging.AbstractQueueControlHandler<org.hornetq.api.core.management.QueueControl>

org.jboss.as.messaging.QueueControlHandler

All Implemented Interfaces:

OperationStepHandler

public class QueueControlHandler
extends AbstractQueueControlHandler<org.hornetq.api.core.management.QueueControl>

Handler for runtime operations that invoke on a HornetQ QueueControl.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.as.messaging.AbstractQueueControlHandler

AbstractQueueControlHandler.DelegatingQueueControl<T>

Field Summary

Fields

Modifier and Type	Field and Description
static QueueControlHandler	INSTANCE
static String	LIST_SCHEDULED_MESSAGES
static String	LIST_SCHEDULED_MESSAGES_AS_JSON

Fields inherited from class org.jboss.as.messaging.AbstractQueueControlHandler

CHANGE_MESSAGE_PRIORITY, CHANGE_MESSAGES_PRIORITY, COUNT_MESSAGES, EXPIRE_MESSAGE, EXPIRE_MESSAGES, LIST_CONSUMERS, LIST_CONSUMERS_AS_JSON, LIST_MESSAGE_COUNTER, LIST_MESSAGE_COUNTER_AS_HTML, LIST_MESSAGE_COUNTER_AS_JSON, LIST_MESSAGE_COUNTER_HISTORY, LIST_MESSAGE_COUNTER_HISTORY_AS_HTML, LIST_MESSAGE_COUNTER_HISTORY_AS_JSON, LIST_MESSAGES, LIST_MESSAGES_AS_JSON, MESSAGE_ID, MOVE_MESSAGE, MOVE_MESSAGES, NEW_PRIORITY, OTHER_QUEUE_NAME, PAUSE, REJECT_DUPLICATES, REMOVE_MESSAGE, REMOVE_MESSAGES, RESET_MESSAGE_COUNTER, RESUME, SEND_MESSAGE_TO_DEAD_LETTER_ADDRESS, SEND_MESSAGES_TO_DEAD_LETTER_ADDRESS

Method Summary

Modifier and Type	Method and Description
protected void	executeRuntimeStep(OperationContext context, org.jboss.dmr.ModelNode operation) Execute this step in OperationContext.Stage.RUNTIME.
protected AbstractQueueControlHandler.DelegatingQueueControl<org.hornetq.api.core.management.QueueControl>	getQueueControl(org.hornetq.core.server.HornetQServer hqServer, String queueName)
protected Object	handleAdditionalOperation(String operationName, org.jboss.dmr.ModelNode operation, OperationContext context, org.hornetq.api.core.management.QueueControl queueControl)
boolean	isJMS()
void	registerOperations(ManagementResourceRegistration registry)
protected boolean	resourceMustExist(OperationContext context, org.jboss.dmr.ModelNode operation) By default the handler will check whether the resource exist before calling @{link #executeRuntimeStep(OperationContext, ModelNode)}.
protected void	revertAdditionalOperation(String operationName, org.jboss.dmr.ModelNode operation, OperationContext context, org.hornetq.api.core.management.QueueControl queueControl, Object handback)

Methods inherited from class org.jboss.as.messaging.AbstractQueueControlHandler

throwUnimplementedOperationException

Methods inherited from class org.jboss.as.controller.AbstractRuntimeOnlyHandler

execute, waitFor

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final QueueControlHandler INSTANCE

LIST_SCHEDULED_MESSAGES

public static final String LIST_SCHEDULED_MESSAGES

See Also:

Constant Field Values

LIST_SCHEDULED_MESSAGES_AS_JSON

public static final String LIST_SCHEDULED_MESSAGES_AS_JSON

See Also:

Constant Field Values

Method Detail

registerOperations

public void registerOperations(ManagementResourceRegistration registry)

Overrides:

registerOperations in class AbstractQueueControlHandler<org.hornetq.api.core.management.QueueControl>

resourceMustExist

protected boolean resourceMustExist(OperationContext context,
                                    org.jboss.dmr.ModelNode operation)

Description copied from class: AbstractRuntimeOnlyHandler

By default the handler will check whether the resource exist before calling @{link #executeRuntimeStep(OperationContext, ModelNode)}. This method can be overridden in the special case where a runtime operation must be executed without a corresponding resource.

Overrides:

resourceMustExist in class AbstractRuntimeOnlyHandler

Parameters:

context - the operation context

operation - the operation being executed

Returns:

true if the resource must exist for this runtime handler to be executed.

executeRuntimeStep

protected void executeRuntimeStep(OperationContext context,
                                  org.jboss.dmr.ModelNode operation)
                           throws OperationFailedException

Description copied from class: AbstractRuntimeOnlyHandler

Execute this step in OperationContext.Stage.RUNTIME. If the operation fails, context.getFailureDescroption() must be called, or OperationFailedException must be thrown, before calling one of the context.completeStep variants. If the operation succeeded, context.getResult() should be called and the result populated with the outcome, after which one of the context.completeStep variants must be called.

Overrides:

executeRuntimeStep in class AbstractQueueControlHandler<org.hornetq.api.core.management.QueueControl>

Parameters:

context - the operation context

operation - the operation being executed

Throws:

OperationFailedException - if the operation failed before calling context.completeStep()

handleAdditionalOperation

protected Object handleAdditionalOperation(String operationName,
                                           org.jboss.dmr.ModelNode operation,
                                           OperationContext context,
                                           org.hornetq.api.core.management.QueueControl queueControl)
                                    throws OperationFailedException

Specified by:

handleAdditionalOperation in class AbstractQueueControlHandler<org.hornetq.api.core.management.QueueControl>

Throws:

OperationFailedException

revertAdditionalOperation

protected void revertAdditionalOperation(String operationName,
                                         org.jboss.dmr.ModelNode operation,
                                         OperationContext context,
                                         org.hornetq.api.core.management.QueueControl queueControl,
                                         Object handback)

Specified by:

revertAdditionalOperation in class AbstractQueueControlHandler<org.hornetq.api.core.management.QueueControl>

isJMS

public boolean isJMS()

Specified by:

isJMS in class AbstractQueueControlHandler<org.hornetq.api.core.management.QueueControl>

getQueueControl

protected AbstractQueueControlHandler.DelegatingQueueControl<org.hornetq.api.core.management.QueueControl> getQueueControl(org.hornetq.core.server.HornetQServer hqServer,
                                                                                                                           String queueName)

Specified by:

getQueueControl in class AbstractQueueControlHandler<org.hornetq.api.core.management.QueueControl>