org.jboss.as.controller

Interface ModelController

public interface ModelController

Controls reads of and modifications to a management model.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ModelController.OperationTransaction An operation transaction.
static interface	ModelController.OperationTransactionControl A callback interface for the operation's completion status.

Field Summary

Fields

Modifier and Type	Field and Description
static RuntimePermission	ACCESS_PERMISSION A RuntimePermission needed to access a ModelController via Value.getValue() or to invoke its methods.

Method Summary

Methods

Modifier and Type	Method and Description
ModelControllerClient	createClient(Executor executor) Create an in-VM client.
org.jboss.dmr.ModelNode	execute(org.jboss.dmr.ModelNode operation, OperationMessageHandler handler, ModelController.OperationTransactionControl control, OperationAttachments attachments) Execute an operation, sending updates to the given handler.
OperationResponse	execute(Operation operation, OperationMessageHandler handler, ModelController.OperationTransactionControl control) Execute an operation, sending updates to the given handler, and making available in the return value any streams that may have been associated with the response.
NotificationHandlerRegistration	getNotificationRegistry() Returns the NotificationHandlerRegistration that registers notification handlers for this model controller.

Field Detail

ACCESS_PERMISSION

static final RuntimePermission ACCESS_PERMISSION

A RuntimePermission needed to access a ModelController via Value.getValue() or to invoke its methods. The name of the necessary RuntimePermission is "canAccessModelController."

Method Detail

execute

org.jboss.dmr.ModelNode execute(org.jboss.dmr.ModelNode operation,
                              OperationMessageHandler handler,
                              ModelController.OperationTransactionControl control,
                              OperationAttachments attachments)

Execute an operation, sending updates to the given handler. This method is not intended to be invoked directly by clients.

Parameters:

operation - the operation to execute

handler - the message handler

control - the transaction control for this operation

attachments - the operation attachments

Returns:

the operation result

Throws:

SecurityException - if the caller does not have ACCESS_PERMISSION

execute

OperationResponse execute(Operation operation,
                        OperationMessageHandler handler,
                        ModelController.OperationTransactionControl control)

Execute an operation, sending updates to the given handler, and making available in the return value any streams that may have been associated with the response. This method is not intended to be invoked directly by clients.

Parameters:

operation - the operation to execute

handler - the message handler

control - the transaction control for this operation

Returns:

the operation response

Throws:

SecurityException - if the caller does not have ACCESS_PERMISSION

createClient

ModelControllerClient createClient(Executor executor)

Create an in-VM client.

Parameters:

executor - the executor to use for asynchronous operation execution

Returns:

the client

Throws:

SecurityException - if the caller does not have ACCESS_PERMISSION

getNotificationRegistry

NotificationHandlerRegistration getNotificationRegistry()

Returns the NotificationHandlerRegistration that registers notification handlers for this model controller.

Returns:

the notification handler registration