org.jboss.as.protocol.mgmt

Interface ActiveOperation<T,A>

Type Parameters:

T - the result type

A - the attachment type

public interface ActiveOperation<T,A>

Encapsulates information about a currently active operation, which can require multiple messages exchanged between the client and the server. An attachment is optional, but can be used to maintain a shared state between multiple requests. It can be accessed using the ManagementRequestContext.getAttachment() from the request handler. An operation is seen as active until one of the methods on the ActiveOperation.ResultHandler are called.

Author:

Emanuel Muckenhuber

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ActiveOperation.CompletedCallback<T> A callback indicating when an operation is complete.
static interface	ActiveOperation.ResultHandler<T> Handler for the operation result or to mark the operation as cancelled or failed.

Method Summary

Modifier and Type	Method and Description
void	addCancellable(org.xnio.Cancellable cancellable) Add a cancellation handler.
A	getAttachment() Get the attachment.
Integer	getOperationId() Get the batch id.
org.jboss.threads.AsyncFuture<T>	getResult() Get the result.
ActiveOperation.ResultHandler<T>	getResultHandler() Get the result handler for this request.

Method Detail

getOperationId

Integer getOperationId()

Get the batch id.

Returns:

the batch id

getResultHandler

ActiveOperation.ResultHandler<T> getResultHandler()

Get the result handler for this request.

Returns:

the result handler

getAttachment

A getAttachment()

Get the attachment.

Returns:

the attachment

getResult

org.jboss.threads.AsyncFuture<T> getResult()

Get the result.

Returns:

the future result

addCancellable

void addCancellable(org.xnio.Cancellable cancellable)

Add a cancellation handler.

Parameters:

cancellable - the cancel handler