org.jboss.as.controller

Class SimpleResourceDefinition

java.lang.Object

org.jboss.as.controller.SimpleResourceDefinition

All Implemented Interfaces:

ResourceDefinition

Direct Known Subclasses:

AbstractAliasedResourceDefinition, AbstractEJBComponentResourceDefinition, AbstractSocketBindingResourceDefinition, ACLResourceDefinition, AuditResourceDefinition, AuthorizationResourceDefinition, BoundedQueueThreadPoolResourceDefinition, CacheFactoryResourceDefinition, ClassicAuthenticationResourceDefinition, CollectionResourceDefinition, ConnectorResource, DeploymentScannerDefinition, DeploymentScannerSubsystemDefinition, EeSubsystemRootResource, EJB3AsyncResourceDefinition, EJB3IIOPResourceDefinition, EJB3RemoteResourceDefinition, EJB3SubsystemRootResourceDefinition, EntityResourceDefinition, ExtensionResourceDefinition, ExtensionSubsystemResourceDefinition, HornetQServerResourceDefinition, HostControllerResourceDescription, HttpManagementResourceDefinition, HttpManagementResourceDefinition, IdentityTrustResourceDefinition, IgnoredDomainTypeResourceDefinition, JaasAuthenticationResourceDefinition, JacORBSubsystemResource, JASPIAuthenticationResourceDefinition, JMXSubsystemRootResource, JSR77ManagementRootResource, JSSEResourceDefinition, LdapAuthenticationResourceDefinition, LdapConnectionResourceDefinition, LoginModuleStackResourceDefinition, MailServerDefinition, MailSessionDefinition, MailSubsystemResource, ManagedDMRContentResourceDefinition, ManagedDMRContentTypeResourceDefinition, MappingResourceDefinition, MessagingSubsystemRootResourceDefinition, ModClusterSSLResourceDefinition, NamingBindingResourceDefinition, NamingSubsystemRootResourceDefinition, NativeManagementResourceDefinition, NativeManagementResourceDefinition, NativeRemotingManagementResourceDefinition, OutboundSocketBindingResourceDefinition, PassivationStoreResourceDefinition, PojoResource, PropertiesFileResourceDefinition, PropertyResource, QueryResourceDefinition, QueuelessThreadPoolResourceDefinition, RemotingConnectorResource, RemotingSubsystemRootResource, SaslPolicyResource, SaslResource, ScheduledThreadPoolResourceDefinition, SecondLevelCacheResourceDefinition, SecretServerIdentityResourceDefinition, SecurityDomainResourceDefinition, SecurityRealmResourceDefinition, SecuritySubsystemRootResourceDefinition, ServerEnvironmentResourceDescription, SocketBindingGroupResourceDefinition, SSLServerIdentityResourceDefinition, StrictMaxPoolResourceDefinition, ThreadFactoryResourceDefinition, TimerServiceResourceDefinition, TransactionSubsystemRootResourceDefinition, TruststoreAuthenticationResourceDefinition, UnboundedQueueThreadPoolResourceDefinition, UserResourceDefinition, VaultResourceDefinition, WebConnectorDefinition, WebContainerDefinition, WebDefinition, WebDeploymentDefinition, WebDeploymentServletDefinition, WebJSPDefinition, WebReWriteConditionDefinition, WebReWriteDefinition, WebStaticResources, WebVirtualHostDefinition, XmlAuthenticationResourceDefinition

public class SimpleResourceDefinition
extends Object
implements ResourceDefinition

Basic implementation of ResourceDefinition.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
SimpleResourceDefinition(PathElement pathElement, DescriptionProvider descriptionProvider) ResourceDefinition that uses the given {code descriptionProvider} to describe the resource.
SimpleResourceDefinition(PathElement pathElement, ResourceDescriptionResolver descriptionResolver) ResourceDefinition that uses the given {code descriptionResolver} to configure a DefaultResourceDescriptionProvider to describe the resource.
SimpleResourceDefinition(PathElement pathElement, ResourceDescriptionResolver descriptionResolver, OperationStepHandler addHandler, OperationStepHandler removeHandler) ResourceDefinition that uses the given {code descriptionResolver} to configure a DefaultResourceDescriptionProvider to describe the resource.
SimpleResourceDefinition(PathElement pathElement, ResourceDescriptionResolver descriptionResolver, OperationStepHandler addHandler, OperationStepHandler removeHandler, OperationEntry.Flag addRestartLevel, OperationEntry.Flag removeRestartLevel) ResourceDefinition that uses the given {code descriptionResolver} to configure a DefaultResourceDescriptionProvider to describe the resource.

Method Summary

Methods

Modifier and Type	Method and Description
DescriptionProvider	getDescriptionProvider(ImmutableManagementResourceRegistration resourceRegistration) Gets a DescriptionProvider for the given resource.
protected static EnumSet<OperationEntry.Flag>	getFlagsSet(OperationEntry.Flag... vararg)
PathElement	getPathElement() Gets the path element that describes how to navigate to this resource from its parent resource, or null if this is a definition of a root resource.
ResourceDescriptionResolver	getResourceDescriptionResolver() Gets the ResourceDescriptionResolver used by this resource definition, or null if a ResourceDescriptionResolver is not used.
protected void	registerAddOperation(ManagementResourceRegistration registration, OperationStepHandler handler, OperationEntry.Flag... flags)
void	registerAttributes(ManagementResourceRegistration resourceRegistration) Register operations associated with this resource.
void	registerChildren(ManagementResourceRegistration resourceRegistration) Register child resources associated with this resource.
void	registerOperations(ManagementResourceRegistration resourceRegistration) Register operations associated with this resource.
protected void	registerRemoveOperation(ManagementResourceRegistration registration, OperationStepHandler handler, OperationEntry.Flag... flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleResourceDefinition

public SimpleResourceDefinition(PathElement pathElement,
                        DescriptionProvider descriptionProvider)

ResourceDefinition that uses the given {code descriptionProvider} to describe the resource.

Parameters:

pathElement - the path. Cannot be null.

descriptionProvider - the description provider. Cannot be null

Throws:

IllegalArgumentException - if any parameter is null.

SimpleResourceDefinition

public SimpleResourceDefinition(PathElement pathElement,
                        ResourceDescriptionResolver descriptionResolver)

ResourceDefinition that uses the given {code descriptionResolver} to configure a DefaultResourceDescriptionProvider to describe the resource.

Parameters:

pathElement - the path. Cannot be null.

descriptionResolver - the description resolver to use in the description provider. Cannot be null

Throws:

IllegalArgumentException - if any parameter is null.

SimpleResourceDefinition

public SimpleResourceDefinition(PathElement pathElement,
                        ResourceDescriptionResolver descriptionResolver,
                        OperationStepHandler addHandler,
                        OperationStepHandler removeHandler)

ResourceDefinition that uses the given {code descriptionResolver} to configure a DefaultResourceDescriptionProvider to describe the resource.

Parameters:

pathElement - the path. Cannot be null.

descriptionResolver - the description resolver to use in the description provider. Cannot be null *

addHandler - a handler to register for the resource "add" operation. Can be

removeHandler - a handler to register for the resource "remove" operation. Can be

Throws:

IllegalArgumentException - if any parameter is null.

SimpleResourceDefinition

public SimpleResourceDefinition(PathElement pathElement,
                        ResourceDescriptionResolver descriptionResolver,
                        OperationStepHandler addHandler,
                        OperationStepHandler removeHandler,
                        OperationEntry.Flag addRestartLevel,
                        OperationEntry.Flag removeRestartLevel)

ResourceDefinition that uses the given {code descriptionResolver} to configure a DefaultResourceDescriptionProvider to describe the resource.

Parameters:

pathElement - the path. Cannot be null.

descriptionResolver - the description resolver to use in the description provider. Cannot be null *

addHandler - a handler to register for the resource "add" operation. Can be

removeHandler - a handler to register for the resource "remove" operation. Can be

Throws:

IllegalArgumentException - if any parameter is null.

Method Detail

getPathElement

public PathElement getPathElement()

Description copied from interface: ResourceDefinition

Gets the path element that describes how to navigate to this resource from its parent resource, or null if this is a definition of a root resource.

Specified by:

getPathElement in interface ResourceDefinition

Returns:

the path element, or null if this is a definition of a root resource.

getDescriptionProvider

public DescriptionProvider getDescriptionProvider(ImmutableManagementResourceRegistration resourceRegistration)

Description copied from interface: ResourceDefinition

Gets a DescriptionProvider for the given resource.

Specified by:

getDescriptionProvider in interface ResourceDefinition

Parameters:

resourceRegistration - the resource. Cannot be null

Returns:

the description provider. Will not be null

registerOperations

public void registerOperations(ManagementResourceRegistration resourceRegistration)

Register operations associated with this resource. Registers an add operation handler or a remove operation handler if one was provided to the constructor.

Specified by:

registerOperations in interface ResourceDefinition

Parameters:

resourceRegistration - a ManagementResourceRegistration created from this definition

registerAttributes

public void registerAttributes(ManagementResourceRegistration resourceRegistration)

Description copied from interface: ResourceDefinition

Register operations associated with this resource.

Specified by:

registerAttributes in interface ResourceDefinition

Parameters:

resourceRegistration - a ManagementResourceRegistration created from this definition

registerChildren

public void registerChildren(ManagementResourceRegistration resourceRegistration)

Description copied from interface: ResourceDefinition

Register child resources associated with this resource.

Specified by:

registerChildren in interface ResourceDefinition

Parameters:

resourceRegistration - a ManagementResourceRegistration created from this definition

getResourceDescriptionResolver

public ResourceDescriptionResolver getResourceDescriptionResolver()

Gets the ResourceDescriptionResolver used by this resource definition, or null if a ResourceDescriptionResolver is not used.

Returns:

the resource description resolver, or null

registerAddOperation

protected void registerAddOperation(ManagementResourceRegistration registration,
                        OperationStepHandler handler,
                        OperationEntry.Flag... flags)

registerRemoveOperation

protected void registerRemoveOperation(ManagementResourceRegistration registration,
                           OperationStepHandler handler,
                           OperationEntry.Flag... flags)

getFlagsSet

protected static EnumSet<OperationEntry.Flag> getFlagsSet(OperationEntry.Flag... vararg)