Package org.jboss.as.controller.client

Interface ModelControllerClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

DomainClient

All Known Implementing Classes:

AbstractModelControllerClient, ContextualModelControllerClient, DelegatingModelControllerClient, DomainClientImpl, ExistingChannelModelControllerClient, RemotingModelControllerClient

public interface ModelControllerClient
extends Closeable

A client for an application server management model controller.

Author:

David M. Lloyd, Kabir Khan, Brian Stansberry (c) 2011 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ModelControllerClient.Factory	Factory methods for creating a ModelControllerClient.

Method Summary

Modifier and Type	Method	Description
default ModelNode	execute(Operation operation)	Execute an operation synchronously.
default ModelNode	execute(Operation operation, OperationMessageHandler messageHandler)	Execute an operation synchronously, optionally receiving progress reports.
default ModelNode	execute(ModelNode operation)	Execute an operation synchronously.
default ModelNode	execute(ModelNode operation, OperationMessageHandler messageHandler)	Execute an operation synchronously, optionally receiving progress reports.
default org.jboss.threads.AsyncFuture<ModelNode>	executeAsync(Operation operation)	Execute an operation in another thread.
org.jboss.threads.AsyncFuture<ModelNode>	executeAsync(Operation operation, OperationMessageHandler messageHandler)	Execute an operation in another thread, optionally receiving progress reports.
default org.jboss.threads.AsyncFuture<ModelNode>	executeAsync(ModelNode operation)	Execute an operation in another thread.
default org.jboss.threads.AsyncFuture<ModelNode>	executeAsync(ModelNode 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 interface java.io.Closeable

close

Method Detail

execute

default ModelNode execute(ModelNode operation)
                   throws IOException

Execute an operation synchronously.

Parameters:

operation - the operation to execute

Returns:

the result of the operation

Throws:

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

execute

default ModelNode execute(Operation operation)
                   throws IOException

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

Parameters:

operation - the operation to execute

Returns:

the result of the operation

Throws:

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

execute

default ModelNode execute(ModelNode operation,
                          OperationMessageHandler messageHandler)
                   throws IOException

Execute an operation synchronously, optionally receiving progress reports.

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

execute

default ModelNode execute(Operation operation,
                          OperationMessageHandler messageHandler)
                   throws IOException

Execute an operation synchronously, optionally receiving progress reports.

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

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

executeOperation

OperationResponse executeOperation(Operation operation,
                                   OperationMessageHandler messageHandler)
                            throws IOException

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().

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

default org.jboss.threads.AsyncFuture<ModelNode> executeAsync(ModelNode operation)

Execute an operation in another thread.

Parameters:

operation - the operation to execute

Returns:

the future result of the operation

executeAsync

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

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

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

executeAsync

default org.jboss.threads.AsyncFuture<ModelNode> executeAsync(Operation operation)

Execute an operation in another thread.

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

Parameters:

operation - the operation to execute

Returns:

the future result of the operation

executeAsync

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

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().

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

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.

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

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