org.jboss.as.protocol.mgmt

Interface ManagementRequestContext<A>

public interface ManagementRequestContext<A>

The context for handling request.

Author:

Emanuel Muckenhuber

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ManagementRequestContext.AsyncTask<A>

Method Summary

Methods

Modifier and Type	Method and Description
void	executeAsync(ManagementRequestContext.AsyncTask<A> task) Execute an async task.
void	executeAsync(ManagementRequestContext.AsyncTask<A> task, boolean cancellable) Execute an async task.
void	executeAsync(ManagementRequestContext.AsyncTask<A> task, boolean cancellable, Executor executor) Execute an async task.
void	executeAsync(ManagementRequestContext.AsyncTask<A> task, Executor executor) Execute an async task.
A	getAttachment() Get the attachment.
org.jboss.remoting3.Channel	getChannel() Get the underlying channel.
Integer	getOperationId() Get the current batch id for this operation.
ManagementProtocolHeader	getRequestHeader() Get the protocol header.
FlushableDataOutput	writeMessage(ManagementProtocolHeader header) Write a new message.

Method Detail

getOperationId

Integer getOperationId()

Get the current batch id for this operation.

Returns:

the batch id

getAttachment

A getAttachment()

Get the attachment. ActiveOperation.getAttachment()

Returns:

the attachment, can be null

getChannel

org.jboss.remoting3.Channel getChannel()

Get the underlying channel.

Returns:

the channel

getRequestHeader

ManagementProtocolHeader getRequestHeader()

Get the protocol header.

Returns:

the protocol header

executeAsync

void executeAsync(ManagementRequestContext.AsyncTask<A> task)

Execute an async task. Equivalent to executeAsync(task, true).

Parameters:

task - the task

executeAsync

void executeAsync(ManagementRequestContext.AsyncTask<A> task,
                boolean cancellable)

Execute an async task. Basically everything waiting for a response cannot block a remoting thread and has to be executed asynchronous.

Parameters:

task - the task

cancellable - true if the task can be cancelled as part of overall request cancellation

executeAsync

void executeAsync(ManagementRequestContext.AsyncTask<A> task,
                Executor executor)

Execute an async task. Equivalent to executeAsync(task, true, executor).

Parameters:

task - the task

executor - the executor

executeAsync

void executeAsync(ManagementRequestContext.AsyncTask<A> task,
                boolean cancellable,
                Executor executor)

Execute an async task. Basically everything waiting for a response cannot block a remoting thread and has to be executed asynchronous.

Parameters:

task - the task

cancellable - true if the task can be cancelled as part of overall request cancellation

executor - the executor

writeMessage

FlushableDataOutput writeMessage(ManagementProtocolHeader header)
                                 throws IOException

Write a new message.

Parameters:

header - the protocol header

Returns:

the message output stream

Throws:

IOException