org.jboss.as.controller

Class PersistentResourceDefinition.Parameters

java.lang.Object

org.jboss.as.controller.SimpleResourceDefinition.Parameters

org.jboss.as.controller.PersistentResourceDefinition.Parameters

Enclosing class:

PersistentResourceDefinition

public static class PersistentResourceDefinition.Parameters
extends SimpleResourceDefinition.Parameters

Constructor Summary

Constructors

Constructor and Description
Parameters(PathElement pathElement, ResourceDescriptionResolver descriptionResolver) Creates a Parameters object

Method Summary

Modifier and Type	Method and Description
PersistentResourceDefinition.Parameters	setAddHandler(OperationStepHandler addHandler) Sets the add handler.
PersistentResourceDefinition.Parameters	setAddRestartLevel(OperationEntry.Flag addRestartLevel) Sets the add restart level.
PersistentResourceDefinition.Parameters	setCapabilities(RuntimeCapability... capabilities) set possible capabilities that this resource exposes
SimpleResourceDefinition.Parameters	setDeprecatedSince(ModelVersion deprecatedSince) Call to deprecate the resource
PersistentResourceDefinition.Parameters	setDeprecationData(DeprecationData deprecationData) Call to deprecate the resource
PersistentResourceDefinition.Parameters	setDescriptionResolver(ResourceDescriptionResolver descriptionResolver) Sets the description resolver to use
PersistentResourceDefinition.Parameters	setOrderedChild() Call to indicate that a resource is of a type where ordering matters amongst the siblings of the same type.
PersistentResourceDefinition.Parameters	setRemoveHandler(OperationStepHandler removeHandler) Sets the remove handler.
PersistentResourceDefinition.Parameters	setRemoveRestartLevel(OperationEntry.Flag removeRestartLevel) Sets the remove restart level.
PersistentResourceDefinition.Parameters	setRuntime() Call to indicate that a resource is runtime-only.
PersistentResourceDefinition.Parameters	setRuntime(boolean isRuntime) Call to indicate that a resource is runtime-only.

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

addAccessConstraints, addCapabilities, addIncorporatingCapabilities, setAccessConstraints, setIncorporatingCapabilities, setMaxOccurs, setMinOccurs

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters(PathElement pathElement,
                  ResourceDescriptionResolver descriptionResolver)

Creates a Parameters object

Parameters:

pathElement - the path element of the created ResourceDefinition. Cannot be null

descriptionResolver - the description provider. Cannot be null

Method Detail

setDescriptionResolver

public PersistentResourceDefinition.Parameters setDescriptionResolver(ResourceDescriptionResolver descriptionResolver)

Description copied from class: SimpleResourceDefinition.Parameters

Sets the description resolver to use

Overrides:

setDescriptionResolver in class SimpleResourceDefinition.Parameters

Returns:

this Parameters object

setAddHandler

public PersistentResourceDefinition.Parameters setAddHandler(OperationStepHandler addHandler)

Description copied from class: SimpleResourceDefinition.Parameters

Sets the add handler. This can also be added by overriding SimpleResourceDefinition.registerOperations(ManagementResourceRegistration)

Overrides:

setAddHandler in class SimpleResourceDefinition.Parameters

Parameters:

addHandler - the add handler to use.

Returns:

this Parameters object

setRemoveHandler

public PersistentResourceDefinition.Parameters setRemoveHandler(OperationStepHandler removeHandler)

Description copied from class: SimpleResourceDefinition.Parameters

Sets the remove handler. This can also be added by overriding SimpleResourceDefinition.registerOperations(ManagementResourceRegistration)

Overrides:

setRemoveHandler in class SimpleResourceDefinition.Parameters

Parameters:

removeHandler - the add handler to use.

Returns:

this Parameters object

setAddRestartLevel

public PersistentResourceDefinition.Parameters setAddRestartLevel(OperationEntry.Flag addRestartLevel)

Description copied from class: SimpleResourceDefinition.Parameters

Sets the add restart level. The default is OperationEntry.Flag#RESTART_NONE

Overrides:

setAddRestartLevel in class SimpleResourceDefinition.Parameters

Parameters:

addRestartLevel - the restart level

Returns:

this Parameters object

setRemoveRestartLevel

public PersistentResourceDefinition.Parameters setRemoveRestartLevel(OperationEntry.Flag removeRestartLevel)

Description copied from class: SimpleResourceDefinition.Parameters

Sets the remove restart level. The default is OperationEntry.Flag#RESTART_ALL_SERVICES

Overrides:

setRemoveRestartLevel in class SimpleResourceDefinition.Parameters

Parameters:

removeRestartLevel - the restart level

Returns:

this Parameters object

setRuntime

public PersistentResourceDefinition.Parameters setRuntime()

Description copied from class: SimpleResourceDefinition.Parameters

Call to indicate that a resource is runtime-only. If not called, the default is false

Overrides:

setRuntime in class SimpleResourceDefinition.Parameters

Returns:

this Parameters object

setRuntime

public PersistentResourceDefinition.Parameters setRuntime(boolean isRuntime)

Description copied from class: SimpleResourceDefinition.Parameters

Call to indicate that a resource is runtime-only. If not called, the default is false

Overrides:

setRuntime in class SimpleResourceDefinition.Parameters

Returns:

this Parameters object

setDeprecationData

public PersistentResourceDefinition.Parameters setDeprecationData(DeprecationData deprecationData)

Description copied from class: SimpleResourceDefinition.Parameters

Call to deprecate the resource

Overrides:

setDeprecationData in class SimpleResourceDefinition.Parameters

Parameters:

deprecationData - Information describing deprecation of this resource.

Returns:

this Parameters object

setDeprecatedSince

public SimpleResourceDefinition.Parameters setDeprecatedSince(ModelVersion deprecatedSince)

Description copied from class: SimpleResourceDefinition.Parameters

Call to deprecate the resource

Overrides:

setDeprecatedSince in class SimpleResourceDefinition.Parameters

Parameters:

deprecatedSince - version in which model was deprecated

Returns:

this Parameters object

setOrderedChild

public PersistentResourceDefinition.Parameters setOrderedChild()

Description copied from class: SimpleResourceDefinition.Parameters

Call to indicate that a resource is of a type where ordering matters amongst the siblings of the same type. If not called, the default is false.

Overrides:

setOrderedChild in class SimpleResourceDefinition.Parameters

Returns:

this Parameters object

setCapabilities

public PersistentResourceDefinition.Parameters setCapabilities(RuntimeCapability... capabilities)

Description copied from class: SimpleResourceDefinition.Parameters

set possible capabilities that this resource exposes

Overrides:

setCapabilities in class SimpleResourceDefinition.Parameters

Parameters:

capabilities - capabilities to register

Returns:

Parameters object