org.jboss.as.protocol.mgmt

Class ManagementChannelReceiver

java.lang.Object

org.jboss.as.protocol.mgmt.ManagementChannelReceiver

All Implemented Interfaces:

ManagementMessageHandler, ManagementChannelInitialization.ManagementChannelShutdownHandle, org.jboss.remoting3.Channel.Receiver

public abstract class ManagementChannelReceiver
extends Object
implements ManagementMessageHandler, org.jboss.remoting3.Channel.Receiver

Base receiver class for the management protocol support.

Author:

Emanuel Muckenhuber

Constructor Summary

Constructors

Constructor and Description
ManagementChannelReceiver()

Method Summary

Modifier and Type	Method and Description
boolean	awaitCompletion(long timeout, TimeUnit unit) Await the completion of all currently active operations.
static ManagementChannelReceiver	createDelegating(ManagementMessageHandler handler) Create a ManagementChannelReceiver which is delegating protocol messages to a ManagementMessageHandler.
long	getLastMessageTime()
protected void	handleChannelReset(org.jboss.remoting3.Channel channel) Handle the legacy bye-bye notification.
void	handleEnd(org.jboss.remoting3.Channel channel)
void	handleError(org.jboss.remoting3.Channel channel, IOException error)
void	handleMessage(org.jboss.remoting3.Channel channel, org.jboss.remoting3.MessageInputStream message)
protected static void	handlePing(org.jboss.remoting3.Channel channel, ManagementProtocolHeader header) Handle a simple ping request.
protected org.jboss.remoting3.Channel.Receiver	next() Get the next receiver.
void	shutdown() Don't allow new operations, but still allow requests for existing ones.
void	shutdownNow() This will attempt to cancel all active operations, without waiting for their completion.
protected static void	writeHeader(ManagementProtocolHeader header, OutputStream os) Write the management protocol header.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.as.protocol.mgmt.ManagementMessageHandler

handleMessage

Constructor Detail

ManagementChannelReceiver

public ManagementChannelReceiver()

Method Detail

createDelegating

public static ManagementChannelReceiver createDelegating(ManagementMessageHandler handler)

Create a ManagementChannelReceiver which is delegating protocol messages to a ManagementMessageHandler.

Parameters:

handler - the handler

Returns:

the receiver

handleMessage

public void handleMessage(org.jboss.remoting3.Channel channel,
                          org.jboss.remoting3.MessageInputStream message)

Specified by:

handleMessage in interface org.jboss.remoting3.Channel.Receiver

getLastMessageTime

public long getLastMessageTime()

next

protected org.jboss.remoting3.Channel.Receiver next()

Get the next receiver.

Returns:

the receiver

handleError

public void handleError(org.jboss.remoting3.Channel channel,
                        IOException error)

Specified by:

handleError in interface org.jboss.remoting3.Channel.Receiver

handleEnd

public void handleEnd(org.jboss.remoting3.Channel channel)

Specified by:

handleEnd in interface org.jboss.remoting3.Channel.Receiver

handleChannelReset

protected void handleChannelReset(org.jboss.remoting3.Channel channel)

Handle the legacy bye-bye notification.

Parameters:

channel - the channel the bye-bye message was received

shutdown

public void shutdown()

Description copied from interface: ManagementChannelInitialization.ManagementChannelShutdownHandle

Don't allow new operations, but still allow requests for existing ones.

This method does not wait for previously submitted operations to be completed. Use awaitCompletion to do that.

Specified by:

shutdown in interface ManagementChannelInitialization.ManagementChannelShutdownHandle

shutdownNow

public void shutdownNow()

Description copied from interface: ManagementChannelInitialization.ManagementChannelShutdownHandle

This will attempt to cancel all active operations, without waiting for their completion.

Specified by:

shutdownNow in interface ManagementChannelInitialization.ManagementChannelShutdownHandle

awaitCompletion

public boolean awaitCompletion(long timeout,
                               TimeUnit unit)
                        throws InterruptedException

Description copied from interface: ManagementChannelInitialization.ManagementChannelShutdownHandle

Await the completion of all currently active operations.

Specified by:

awaitCompletion in interface ManagementChannelInitialization.ManagementChannelShutdownHandle

Parameters:

timeout - the timeout

unit - the time unit

Returns:

false if the timeout was reached and there were still active operations

Throws:

InterruptedException

handlePing

protected static void handlePing(org.jboss.remoting3.Channel channel,
                                 ManagementProtocolHeader header)
                          throws IOException

Handle a simple ping request.

Parameters:

channel - the channel

header - the protocol header

Throws:

IOException - for any error

writeHeader

protected static void writeHeader(ManagementProtocolHeader header,
                                  OutputStream os)
                           throws IOException

Write the management protocol header.

Parameters:

header - the mgmt protocol header

os - the output stream

Throws:

IOException