Package org.jboss.as.controller

Class SimpleOperationDefinitionBuilder

java.lang.Object

org.jboss.as.controller.SimpleOperationDefinitionBuilder

public class SimpleOperationDefinitionBuilder
extends Object

Builder for helping construct SimpleOperationDefinition

Author:

Tomaz Cerar

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessConstraintDefinition[]	accessConstraints
protected DeprecationData	deprecationData
protected OperationEntry.EntryType	entryType
protected Set<OperationEntry.Flag>	flags
protected String	name
protected AttributeDefinition[]	parameters
protected boolean	replyAllowNull
protected AttributeDefinition[]	replyParameters
protected org.jboss.dmr.ModelType	replyType
protected org.jboss.dmr.ModelType	replyValueType

Constructor Summary

Constructors

Constructor	Description
SimpleOperationDefinitionBuilder(String name, ResourceDescriptionResolver resolver)

Method Summary

Modifier and Type	Method	Description
SimpleOperationDefinitionBuilder	addAccessConstraint(AccessConstraintDefinition accessConstraint)
SimpleOperationDefinitionBuilder	addParameter(AttributeDefinition parameter)
SimpleOperationDefinitionBuilder	allowReturnNull()
SimpleOperationDefinition	build()
protected static EnumSet<OperationEntry.Flag>	getFlagsSet(OperationEntry.Flag... vararg)
protected SimpleOperationDefinition	internalBuild(ResourceDescriptionResolver resolver, ResourceDescriptionResolver attributeResolver)
static SimpleOperationDefinitionBuilder	of(String name, ResourceDescriptionResolver resolver)
static SimpleOperationDefinitionBuilder	of(String name, OperationDefinition basis)	Convenience method that delegates to of(String, SimpleOperationDefinition).
static SimpleOperationDefinitionBuilder	of(String name, SimpleOperationDefinition basis)	Creates an operation definition builder with the specified name, based on the configuration of the specified operation definition.
SimpleOperationDefinitionBuilder	setAccessConstraints(AccessConstraintDefinition... accessConstraints)
SimpleOperationDefinitionBuilder	setAttributeResolver(ResourceDescriptionResolver resolver)
SimpleOperationDefinitionBuilder	setDeprecated(ModelVersion since)	Marks the operation as deprecated since the given API version.
SimpleOperationDefinitionBuilder	setDeprecated(ModelVersion since, boolean notificationUseful)	Marks the attribute as deprecated since the given API version, with the ability to configure that notifications to the user (e.g. via a log message) about deprecation of the operation should not be emitted.
SimpleOperationDefinitionBuilder	setDescriptionProvider(DescriptionProvider provider)
SimpleOperationDefinitionBuilder	setEntryType(OperationEntry.EntryType entryType)
SimpleOperationDefinitionBuilder	setParameters(AttributeDefinition... parameters)
SimpleOperationDefinitionBuilder	setPrivateEntry()
SimpleOperationDefinitionBuilder	setReadOnly()
SimpleOperationDefinitionBuilder	setReplyParameters(AttributeDefinition... replyParameters)
SimpleOperationDefinitionBuilder	setReplyType(org.jboss.dmr.ModelType replyType)
SimpleOperationDefinitionBuilder	setReplyValueType(org.jboss.dmr.ModelType replyValueType)
SimpleOperationDefinitionBuilder	setRuntimeOnly()
SimpleOperationDefinitionBuilder	setStability(Stability stability)
SimpleOperationDefinitionBuilder	withFlag(OperationEntry.Flag flag)
SimpleOperationDefinitionBuilder	withFlags(Set<OperationEntry.Flag> flags)
SimpleOperationDefinitionBuilder	withFlags(OperationEntry.Flag... flags)

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

entryType

protected OperationEntry.EntryType entryType

flags

protected Set<OperationEntry.Flag> flags

parameters

protected AttributeDefinition[] parameters

replyType

protected org.jboss.dmr.ModelType replyType

replyValueType

protected org.jboss.dmr.ModelType replyValueType

replyAllowNull

protected boolean replyAllowNull

deprecationData

protected DeprecationData deprecationData

replyParameters

protected AttributeDefinition[] replyParameters

accessConstraints

protected AccessConstraintDefinition[] accessConstraints

Constructor Details

SimpleOperationDefinitionBuilder

public SimpleOperationDefinitionBuilder(String name,
 ResourceDescriptionResolver resolver)

Method Details

of

public static SimpleOperationDefinitionBuilder of(String name,
 ResourceDescriptionResolver resolver)

of

public static SimpleOperationDefinitionBuilder of(String name,
 OperationDefinition basis)

Convenience method that delegates to of(String, SimpleOperationDefinition).

Parameters:

name - the operation name

basis - an operation used to configure a new operation

Returns:

a new operation definition builder

Throws:

IllegalArgumentException - if the specified basis is not a SimpleOperationDefinition.

of

public static SimpleOperationDefinitionBuilder of(String name,
 SimpleOperationDefinition basis)

Creates an operation definition builder with the specified name, based on the configuration of the specified operation definition.

Parameters:

name - the operation name

basis - an operation used to configure a new operation

Returns:

a new operation definition builder

build

public SimpleOperationDefinition build()

internalBuild

protected SimpleOperationDefinition internalBuild(ResourceDescriptionResolver resolver,
 ResourceDescriptionResolver attributeResolver)

getFlagsSet

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

setEntryType

public SimpleOperationDefinitionBuilder setEntryType(OperationEntry.EntryType entryType)

setPrivateEntry

public SimpleOperationDefinitionBuilder setPrivateEntry()

withFlags

public SimpleOperationDefinitionBuilder withFlags(Set<OperationEntry.Flag> flags)

withFlags

public SimpleOperationDefinitionBuilder withFlags(OperationEntry.Flag... flags)

withFlag

public SimpleOperationDefinitionBuilder withFlag(OperationEntry.Flag flag)

setRuntimeOnly

public SimpleOperationDefinitionBuilder setRuntimeOnly()

setReadOnly

public SimpleOperationDefinitionBuilder setReadOnly()

setParameters

public SimpleOperationDefinitionBuilder setParameters(AttributeDefinition... parameters)

addParameter

public SimpleOperationDefinitionBuilder addParameter(AttributeDefinition parameter)

setReplyType

public SimpleOperationDefinitionBuilder setReplyType(org.jboss.dmr.ModelType replyType)

setReplyValueType

public SimpleOperationDefinitionBuilder setReplyValueType(org.jboss.dmr.ModelType replyValueType)

allowReturnNull

public SimpleOperationDefinitionBuilder allowReturnNull()

setDeprecated

public SimpleOperationDefinitionBuilder setDeprecated(ModelVersion since)

Marks the operation as deprecated since the given API version. This is equivalent to calling setDeprecated(ModelVersion, boolean) with the notificationUseful parameter set to true.

Parameters:

since - the API version, with the API being the one (core or a subsystem) in which the attribute is used

Returns:

a builder that can be used to continue building the attribute definition

setDeprecated

public SimpleOperationDefinitionBuilder setDeprecated(ModelVersion since,
 boolean notificationUseful)

Marks the attribute as deprecated since the given API version, with the ability to configure that notifications to the user (e.g. via a log message) about deprecation of the operation should not be emitted. Notifying the user should only be done if the user can take some action in response. Advising that something will be removed in a later release is not useful if there is no alternative in the current release. If the notificationUseful param is true the text description of the operation deprecation available from the read-operation-description management operation should provide useful information about how the user can avoid using the operation.

Parameters:

since - the API version, with the API being the one (core or a subsystem) in which the attribute is used

notificationUseful - whether actively advising the user about the deprecation is useful

Returns:

a builder that can be used to continue building the attribute definition

setReplyParameters

public SimpleOperationDefinitionBuilder setReplyParameters(AttributeDefinition... replyParameters)

setAttributeResolver

public SimpleOperationDefinitionBuilder setAttributeResolver(ResourceDescriptionResolver resolver)

setAccessConstraints

public SimpleOperationDefinitionBuilder setAccessConstraints(AccessConstraintDefinition... accessConstraints)

addAccessConstraint

public SimpleOperationDefinitionBuilder addAccessConstraint(AccessConstraintDefinition accessConstraint)

setDescriptionProvider

public SimpleOperationDefinitionBuilder setDescriptionProvider(DescriptionProvider provider)

setStability

public SimpleOperationDefinitionBuilder setStability(Stability stability)