Package 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 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 Description static Permission
ACCESS_PERMISSION
AControllerPermission
needed to access aModelController
viaValue.getValue()
or to invoke its methods.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description ModelControllerClient
createClient(Executor executor)
Deprecated.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.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.NotificationHandlerRegistration
getNotificationRegistry()
Deprecated.
-
-
-
Field Detail
-
ACCESS_PERMISSION
static final Permission ACCESS_PERMISSION
AControllerPermission
needed to access aModelController
viaValue.getValue()
or to invoke its methods. The name of the permission 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 executehandler
- the message handlercontrol
- the transaction control for this operationattachments
- the operation attachments- Returns:
- the operation result
- Throws:
SecurityException
- if the caller does not haveACCESS_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 executehandler
- the message handlercontrol
- the transaction control for this operation- Returns:
- the operation response
- Throws:
SecurityException
- if the caller does not haveACCESS_PERMISSION
-
createClient
@Deprecated ModelControllerClient createClient(Executor executor)
Deprecated.UseModelControllerClientFactory
. Will be removed in the next major or minor release.Create an in-VM client whose operations are executed as if they were invoked by a user in the RBACSuperUser
role, regardless of any security identity that is or isn't associated with the calling thread when the client is invoked. This client generally should not be used to handle requests from external callers, and if it is used great care should be taken to ensure such use is not suborning the intended access control scheme.In a VM with a
SecurityManager
installed, invocations against the returned client can only occur from a calling context with thePERFORM_IN_VM_CALL
permission. Without this permission aSecurityException
will be thrown.- Parameters:
executor
- the executor to use for asynchronous operation execution. Cannot benull
- Returns:
- the client. Will not return
null
- Throws:
SecurityException
- if the caller does not have theCAN_ACCESS_MODEL_CONTROLLER
permission
-
getNotificationRegistry
@Deprecated NotificationHandlerRegistration getNotificationRegistry()
Deprecated.UseNotificationHandlerRegistry
. Will be removed in the next major or minor release.Returns theNotificationHandlerRegistration
that registers notification handlers for this model controller.- Returns:
- the notification handler registration
-
-