Package 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, 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	Description
static final org.jboss.remoting3.Attachments.Key<File>	TEMP_DIR	Optional attachment for a temp file directory.

Constructor Summary

Constructors

Constructor	Description
ManagementChannelHandler(ManagementClientChannelStrategy strategy, ExecutorService executorService)
ManagementChannelHandler(ManagementClientChannelStrategy strategy, ExecutorService executorService, ManagementRequestHandlerFactory... initial)

Method Summary

Modifier and Type	Method	Description
void	addHandlerFactory(ManagementRequestHandlerFactory factory)	Add a management request handler factory to this context.
<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> 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> 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.
org.jboss.remoting3.Attachments	getAttachments()	Get the attachments object that can be used to share state between users of this object.
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.
<T, A> ActiveOperation<T,A>	initializeOperation(A attachment, ActiveOperation.CompletedCallback<T> callback)	Initialize a new ActiveOperation, for subsequent use with ManagementChannelAssociation.executeRequest(ActiveOperation, ManagementRequest).
boolean	removeHandlerFactory(ManagementRequestHandlerFactory instance)	Remove a management request handler factory from this context.

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

awaitCompletion, cancelAllActiveOperations, executeRequest, getActiveOperation, getActiveOperation, getExecutor, getFallbackHandler, handleChannelClosed, handleClose, handleMessage, handleMessage, handleMessage, isShutdown, registerActiveOperation, registerActiveOperation, registerActiveOperation, registerActiveOperation, 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 Details

TEMP_DIR

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

Optional attachment for a temp file directory.

Constructor Details

ManagementChannelHandler

public ManagementChannelHandler(ManagementClientChannelStrategy strategy,
 ExecutorService executorService)

ManagementChannelHandler

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

Method Details

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 - if a problem occurs obtaining the channel

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)

Description copied from interface: ManagementChannelAssociation

Initialize a new ActiveOperation, for subsequent use with ManagementChannelAssociation.executeRequest(ActiveOperation, ManagementRequest).

Specified by:

initializeOperation in interface ManagementChannelAssociation

Type Parameters:

T - the result type

A - the attachment type

Parameters:

attachment - the attachment

callback - the completion listener

Returns:

the created active operation

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 - if a problem occurs executing the request

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 - if a problem occurs executing the request

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 - if a problem occurs executing the request

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 - if a problem occurs executing the request

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 object that can be used to share state between users of this object.

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