Package org.jboss.as.controller.services.path

Class PathResourceDefinition

java.lang.Object

org.jboss.as.controller.ResourceDefinition.MinimalResourceDefinition

org.jboss.as.controller.SimpleResourceDefinition

org.jboss.as.controller.services.path.PathResourceDefinition

All Implemented Interfaces:

Feature, ResourceDefinition, ResourceRegistration

public abstract class PathResourceDefinition
extends SimpleResourceDefinition

Definition of a resource type that represents a logical filesystem path.

Author:

Kabir Khan

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.as.controller.SimpleResourceDefinition

SimpleResourceDefinition.Parameters

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

ResourceDefinition.AbstractConfigurator<C extends ResourceDefinition.Configurator<C>>, ResourceDefinition.Builder, ResourceDefinition.Configurator<C extends ResourceDefinition.Configurator<C>>, ResourceDefinition.MinimalBuilder, ResourceDefinition.MinimalResourceDefinition

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

ResourceRegistration.DefaultResourceRegistration

Field Summary

Fields

Modifier and Type	Field	Description
static SimpleAttributeDefinition	PATH	A path attribute definition
static PathElement	PATH_ADDRESS
static RuntimeCapability<Void>	PATH_CAPABILITY
static SimpleAttributeDefinition	RELATIVE_TO	A relative-to attribute definition

Method Summary

Modifier and Type	Method	Description
static PathResourceDefinition	createNamed()	Creates a resource definition for a path resource that does not require that the path details be specified.
static PathResourceDefinition	createResolvableSpecified(PathManagerService pathManager)	Creates a resource definition for a path resource that must have the path specified, but for which the read-resource management operation should support the resolve-expresssions parameter.
static PathResourceDefinition	createSpecified(PathManagerService pathManager)	Creates a resource definition for a path resource that must have the path specified, but for which the read-resource management operation should not support the resolve-expresssions parameter.
static PathResourceDefinition	createSpecifiedNoServices()	Creates a resource definition for a path resource that must have the path specified, but for which interaction with the path manager should not be part of the execution of management operations.
void	registerAttributes(ManagementResourceRegistration resourceRegistration)	Register operations associated with this resource.
void	registerOperations(ManagementResourceRegistration interfaces)	Register operations associated with this resource.

Methods inherited from class org.jboss.as.controller.SimpleResourceDefinition

getAddOperationParameters, getDeprecationData, getFlagsSet, getResourceDescriptionResolver, registerAdditionalRuntimePackages, registerAddOperation, registerAddOperation, registerCapabilities, registerChildren, registerNotifications, registerRemoveOperation, registerRemoveOperation, setDeprecated

Methods inherited from class org.jboss.as.controller.ResourceDefinition.MinimalResourceDefinition

getAccessConstraints, getDescriptionProvider, getMaxOccurs, getMinOccurs, getPathElement, getStability, isFeature, isOrderedChild, isRuntime

Methods inherited from class java.lang.Object

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

Field Detail

PATH_CAPABILITY

public static final RuntimeCapability<Void> PATH_CAPABILITY

PATH_ADDRESS

public static final PathElement PATH_ADDRESS

PATH

public static final SimpleAttributeDefinition PATH

A path attribute definition

RELATIVE_TO

public static final SimpleAttributeDefinition RELATIVE_TO

A relative-to attribute definition

Method Detail

createResolvableSpecified

public static PathResourceDefinition createResolvableSpecified(PathManagerService pathManager)

Creates a resource definition for a path resource that must have the path specified, but for which the read-resource management operation should support the resolve-expresssions parameter.

Parameters:

pathManager - the path manager. Cannot be null

Returns:

the resource definition

createSpecified

public static PathResourceDefinition createSpecified(PathManagerService pathManager)

Creates a resource definition for a path resource that must have the path specified, but for which the read-resource management operation should not support the resolve-expresssions parameter.

Parameters:

pathManager - the path manager. Cannot be null

Returns:

the resource definition

createNamed

public static PathResourceDefinition createNamed()

Creates a resource definition for a path resource that does not require that the path details be specified. Interaction with the path manager will not be part of the execution of management operations. Only for use by the kernel.

Returns:

the resource definition

createSpecifiedNoServices

public static PathResourceDefinition createSpecifiedNoServices()

Creates a resource definition for a path resource that must have the path specified, but for which interaction with the path manager should not be part of the execution of management operations. Only for use by the kernel.

Returns:

the resource definition

registerOperations

public void registerOperations(ManagementResourceRegistration interfaces)

Description copied from class: SimpleResourceDefinition

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

Overrides:

registerOperations in class SimpleResourceDefinition

Parameters:

interfaces - 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

Overrides:

registerAttributes in class SimpleResourceDefinition

Parameters:

resourceRegistration - a ManagementResourceRegistration created from this definition