Package org.jboss.as.controller.client.helpers

Class ContextualModelControllerClient

java.lang.Object

org.jboss.as.controller.client.helpers.ContextualModelControllerClient

All Implemented Interfaces:

Closeable, AutoCloseable, ModelControllerClient

public final class ContextualModelControllerClient
extends Object
implements ModelControllerClient

A client which wraps invocations of the delegate client in the provided context.

Author:

James R. Perkins

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.as.controller.client.ModelControllerClient

ModelControllerClient.Factory

Constructor Summary

Constructors

Constructor	Description
ContextualModelControllerClient(ModelControllerClient delegate, org.wildfly.common.context.Contextual<?> context)	Creates a client which uses the supplied context.

Method Summary

Modifier and Type	Method	Description
void	close()
org.jboss.threads.AsyncFuture<ModelNode>	executeAsync(Operation operation, OperationMessageHandler messageHandler)	Execute an operation in another thread, optionally receiving progress reports.
OperationResponse	executeOperation(Operation operation, OperationMessageHandler messageHandler)	Execute an operation synchronously, optionally receiving progress reports, with the response to the operation making available any input streams that the server may associate with the response.
org.jboss.threads.AsyncFuture<OperationResponse>	executeOperationAsync(Operation operation, OperationMessageHandler messageHandler)	Execute an operation in another thread, optionally receiving progress reports, with the response to the operation making available any input streams that the server may associate with the response.

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.controller.client.ModelControllerClient

execute, execute, execute, execute, executeAsync, executeAsync, executeAsync

Constructor Detail

ContextualModelControllerClient

public ContextualModelControllerClient(ModelControllerClient delegate,
                                       org.wildfly.common.context.Contextual<?> context)

Creates a client which uses the supplied context.

Parameters:

delegate - the delegate client

context - the context used to execute operations

Method Detail

executeOperation

public OperationResponse executeOperation(Operation operation,
                                          OperationMessageHandler messageHandler)
                                   throws IOException

Description copied from interface: ModelControllerClient

Execute an operation synchronously, optionally receiving progress reports, with the response to the operation making available any input streams that the server may associate with the response.

Note that associated input-streams have to be closed by the caller, after the operation completed OperationAttachments.isAutoCloseStreams().

Specified by:

executeOperation in interface ModelControllerClient

Parameters:

operation - the operation to execute

messageHandler - the message handler to use for operation progress reporting, or null for none

Returns:

the result of the operation

Throws:

IOException - if an I/O error occurs while executing the operation

executeAsync

public org.jboss.threads.AsyncFuture<ModelNode> executeAsync(Operation operation,
                                                             OperationMessageHandler messageHandler)

Description copied from interface: ModelControllerClient

Execute an operation in another thread, optionally receiving progress reports.

Note that associated input-streams have to be closed by the caller, after the operation completed OperationAttachments.isAutoCloseStreams().

Specified by:

executeAsync in interface ModelControllerClient

Parameters:

operation - the operation to execute

messageHandler - the message handler to use for operation progress reporting, or null for none

Returns:

the future result of the operation

executeOperationAsync

public org.jboss.threads.AsyncFuture<OperationResponse> executeOperationAsync(Operation operation,
                                                                              OperationMessageHandler messageHandler)

Description copied from interface: ModelControllerClient

Execute an operation in another thread, optionally receiving progress reports, with the response to the operation making available any input streams that the server may associate with the response.

Note that associated input-streams have to be closed by the caller, after the operation completed OperationAttachments.isAutoCloseStreams().

Specified by:

executeOperationAsync in interface ModelControllerClient

Parameters:

operation - the operation to execute

messageHandler - the message handler to use for operation progress reporting, or null for none

Returns:

the future result of the operation

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException