org.jboss.as.protocol.mgmt

Class ManagementChannelHandler

java.lang.Object

org.jboss.as.protocol.mgmt.AbstractMessageHandler

org.jboss.as.protocol.mgmt.ManagementChannelHandler

All Implemented Interfaces:

EventListener, ManagementChannelAssociation, ManagementMessageHandler, ManagementChannelInitialization.ManagementChannelShutdownHandle, org.jboss.remoting3.CloseHandler<org.jboss.remoting3.Channel>

public final class ManagementChannelHandler
extends AbstractMessageHandler
implements ManagementChannelAssociation

Generic management channel handler allowing to assemble multiple ManagementRequestHandlerFactory per channel.

Author:

Emanuel Muckenhuber

Field Summary

Fields

Modifier and Type	Field and Description
static org.jboss.remoting3.Attachments.Key<File>	TEMP_DIR Optional attachment for a temp file directory.

Constructor Summary

Constructors

Constructor and Description
ManagementChannelHandler(org.jboss.remoting3.Channel channel, ExecutorService executorService)
ManagementChannelHandler(org.jboss.remoting3.Channel channel, ExecutorService executorService, ManagementRequestHandlerFactory... initial)
ManagementChannelHandler(ManagementClientChannelStrategy strategy, ExecutorService executorService)
ManagementChannelHandler(ManagementClientChannelStrategy strategy, ExecutorService executorService, ManagementRequestHandlerFactory... initial)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHandlerFactory(ManagementRequestHandlerFactory factory) Add a management request handler factory to this context.
protected List<Integer>	cancelAllActiveOperations() Cancel all currently active operations.
<T,A> org.jboss.threads.AsyncFuture<T>	executeRequest(ActiveOperation<T,A> support, ManagementRequest<T,A> request) Execute a request based on an existing active operation.
<T,A> org.jboss.threads.AsyncFuture<T>	executeRequest(Integer operationId, ManagementRequest<T,A> request) Execute a request based on an existing active operation.
<T,A> ActiveOperation<T,A>	executeRequest(ManagementRequest<T,A> request, A attachment) Execute a management request.
<T,A> ActiveOperation<T,A>	executeRequest(ManagementRequest<T,A> request, A attachment, ActiveOperation.CompletedCallback<T> callback) Execute a management request.
protected <T,A> ActiveOperation<T,A>	getActiveOperation(Integer id) Get the active operation.
protected <T,A> ActiveOperation<T,A>	getActiveOperation(ManagementRequestHeader header) Get an active operation.
org.jboss.remoting3.Attachments	getAttachments() Get the attachments.
org.jboss.remoting3.Channel	getChannel() Get the underlying remoting channel associated with this context.
long	getLastMessageReceivedTime()
org.jboss.remoting3.Channel.Receiver	getReceiver() Get a receiver instance for this context.
InetAddress	getRemoteAddress() Get the remote address.
protected ManagementRequestHandler<?,?>	getRequestHandler(ManagementRequestHeader header) Get the request handler.
void	handleChannelClosed(org.jboss.remoting3.Channel closed, IOException e) Receive a notification that the channel was closed.
<T,A> ActiveOperation<T,A>	initializeOperation(A attachment, ActiveOperation.CompletedCallback<T> callback)
protected boolean	isShutdown() Is shutdown.
protected <T,A> ActiveOperation<T,A>	registerActiveOperation(A attachment) Register an active operation.
protected <T,A> ActiveOperation<T,A>	registerActiveOperation(A attachment, ActiveOperation.CompletedCallback<T> callback) Register an active operation.
protected <T,A> ActiveOperation<T,A>	registerActiveOperation(Integer id, A attachment) Register an active operation with a specific operation id.
protected <T,A> ActiveOperation<T,A>	registerActiveOperation(Integer id, A attachment, ActiveOperation.CompletedCallback<T> callback) Register an active operation with a specific operation id.
boolean	removeHandlerFactory(ManagementRequestHandlerFactory instance) Remove a management request handler factory from this context.

Methods inherited from class org.jboss.as.protocol.mgmt.AbstractMessageHandler

awaitCompletion, executeRequest, getExecutor, getFallbackHandler, handleClose, handleMessage, handleMessage, handleMessage, handleRequest, removeActiveOperation, safeWriteErrorResponse, shutdown, shutdownNow, validateRequest, writeErrorResponse, writeHeader

Methods inherited from class java.lang.Object

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

Field Detail

TEMP_DIR

public static final org.jboss.remoting3.Attachments.Key<File> TEMP_DIR

Optional attachment for a temp file directory.

Constructor Detail

ManagementChannelHandler

public ManagementChannelHandler(org.jboss.remoting3.Channel channel,
                        ExecutorService executorService)

ManagementChannelHandler

public ManagementChannelHandler(org.jboss.remoting3.Channel channel,
                        ExecutorService executorService,
                        ManagementRequestHandlerFactory... initial)

ManagementChannelHandler

public ManagementChannelHandler(ManagementClientChannelStrategy strategy,
                        ExecutorService executorService)

ManagementChannelHandler

public ManagementChannelHandler(ManagementClientChannelStrategy strategy,
                        ExecutorService executorService,
                        ManagementRequestHandlerFactory... initial)

Method Detail

getLastMessageReceivedTime

public long getLastMessageReceivedTime()

getChannel

public org.jboss.remoting3.Channel getChannel()
                                       throws IOException

Get the underlying remoting channel associated with this context.

Specified by:

getChannel in interface ManagementChannelAssociation

Returns:

the channel

Throws:

IOException

getRemoteAddress

public InetAddress getRemoteAddress()

Get the remote address.

Returns:

the remote address, null if not available

initializeOperation

public <T,A> ActiveOperation<T,A> initializeOperation(A attachment,
                                             ActiveOperation.CompletedCallback<T> callback)
                                         throws IOException

Specified by:

initializeOperation in interface ManagementChannelAssociation

Throws:

IOException

executeRequest

public <T,A> ActiveOperation<T,A> executeRequest(ManagementRequest<T,A> request,
                                        A attachment,
                                        ActiveOperation.CompletedCallback<T> callback)
                                    throws IOException

Execute a management request.

Specified by:

executeRequest in interface ManagementChannelAssociation

Type Parameters:

T - the result type

A - the attachment type

Parameters:

request - the request

attachment - the attachment

callback - the completion listener

Returns:

the created active operation

Throws:

IOException

executeRequest

public <T,A> ActiveOperation<T,A> executeRequest(ManagementRequest<T,A> request,
                                        A attachment)
                                    throws IOException

Execute a management request.

Specified by:

executeRequest in interface ManagementChannelAssociation

Type Parameters:

T - the result type

A - the attachment type

Parameters:

request - the request

attachment - the attachment

Returns:

the created active operation

Throws:

IOException

executeRequest

public <T,A> org.jboss.threads.AsyncFuture<T> executeRequest(Integer operationId,
                                                    ManagementRequest<T,A> request)
                                                throws IOException

Execute a request based on an existing active operation.

Specified by:

executeRequest in interface ManagementChannelAssociation

Type Parameters:

T - the request type

A - the attachment type

Parameters:

operationId - the operation-id of the existing active operation

request - the request

Returns:

the future result

Throws:

IOException

executeRequest

public <T,A> org.jboss.threads.AsyncFuture<T> executeRequest(ActiveOperation<T,A> support,
                                                    ManagementRequest<T,A> request)
                                                throws IOException

Execute a request based on an existing active operation.

Specified by:

executeRequest in interface ManagementChannelAssociation

Type Parameters:

T - the result type

A - the attachment type

Parameters:

support - the active operation

request - the request

Returns:

the future result

Throws:

IOException

getRequestHandler

protected ManagementRequestHandler<?,?> getRequestHandler(ManagementRequestHeader header)

Get the request handler.

Overrides:

getRequestHandler in class AbstractMessageHandler

Parameters:

header - the request header

Returns:

the request handler

getReceiver

public org.jboss.remoting3.Channel.Receiver getReceiver()

Get a receiver instance for this context.

Returns:

the receiver

getAttachments

public org.jboss.remoting3.Attachments getAttachments()

Description copied from interface: ManagementChannelAssociation

Get the attachments.

Specified by:

getAttachments in interface ManagementChannelAssociation

Returns:

the attachments

addHandlerFactory

public void addHandlerFactory(ManagementRequestHandlerFactory factory)

Add a management request handler factory to this context.

Parameters:

factory - the request handler to add

removeHandlerFactory

public boolean removeHandlerFactory(ManagementRequestHandlerFactory instance)

Remove a management request handler factory from this context.

Parameters:

instance - the request handler factory

Returns:

true if the instance was removed, false otherwise

registerActiveOperation

protected <T,A> ActiveOperation<T,A> registerActiveOperation(A attachment)

Register an active operation. The operation-id will be generated.

Parameters:

attachment - the shared attachment

Returns:

the active operation

registerActiveOperation

protected <T,A> ActiveOperation<T,A> registerActiveOperation(A attachment,
                                                 ActiveOperation.CompletedCallback<T> callback)

Register an active operation. The operation-id will be generated.

Parameters:

attachment - the shared attachment

callback - the completed callback

Returns:

the active operation

registerActiveOperation

protected <T,A> ActiveOperation<T,A> registerActiveOperation(Integer id,
                                                 A attachment)

Register an active operation with a specific operation id.

Parameters:

id - the operation id

attachment - the shared attachment

Returns:

the created active operation

Throws:

IllegalStateException - if an operation with the same id is already registered

registerActiveOperation

protected <T,A> ActiveOperation<T,A> registerActiveOperation(Integer id,
                                                 A attachment,
                                                 ActiveOperation.CompletedCallback<T> callback)

Register an active operation with a specific operation id.

Parameters:

id - the operation id

attachment - the shared attachment

callback - the completed callback

Returns:

the created active operation

Throws:

IllegalStateException - if an operation with the same id is already registered

getActiveOperation

protected <T,A> ActiveOperation<T,A> getActiveOperation(ManagementRequestHeader header)

Get an active operation.

Parameters:

header - the request header

Returns:

the active operation, null if if there is no registered operation

getActiveOperation

protected <T,A> ActiveOperation<T,A> getActiveOperation(Integer id)

Get the active operation.

Parameters:

id - the active operation id

Returns:

the active operation, null if if there is no registered operation

handleChannelClosed

public void handleChannelClosed(org.jboss.remoting3.Channel closed,
                       IOException e)

Receive a notification that the channel was closed. This is used for the ManagementClientChannelStrategy.Establishing since it might use multiple channels.

Parameters:

closed - the closed resource

e - the exception which occurred during close, if any

cancelAllActiveOperations

protected List<Integer> cancelAllActiveOperations()

Cancel all currently active operations.

Returns:

a list of cancelled operations

isShutdown

protected boolean isShutdown()

Is shutdown.

Returns:

true if the shutdown method was called, false otherwise