org.jboss.as.controller.registry

Class PlaceholderResource

java.lang.Object

org.jboss.as.controller.registry.PlaceholderResource

All Implemented Interfaces:

Cloneable, Resource

Direct Known Subclasses:

PlaceholderResource.PlaceholderResourceEntry

public class PlaceholderResource
extends Object
implements Resource

Resource that solely holds a place in the resource tree and has no model or children. A typically usage would be for a resource that represents some runtime-only service, where all attributes of the resource are read by reading that service.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlaceholderResource.PlaceholderResourceEntry

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

Resource.Factory, Resource.NoSuchResourceException, Resource.ResourceEntry, Resource.Tools

Field Summary

Fields

Modifier and Type	Field and Description
static PlaceholderResource	INSTANCE

Method Summary

Modifier and Type	Method and Description
Resource	clone() Creates and returns a copy of this resource.
Resource	getChild(PathElement element) Get a single child of this resource with the given address.
Set<Resource.ResourceEntry>	getChildren(String childType) Get the children for a given type.
Set<String>	getChildrenNames(String childType) Get the children names for a given type.
Set<String>	getChildTypes() Get a list of registered child types for this resource.
org.jboss.dmr.ModelNode	getModel() Get the local model.
Set<String>	getOrderedChildTypes() Return the child types for which the order matters.
boolean	hasChild(PathElement element) Determine whether this resource has a child with the given address.
boolean	hasChildren(String childType) Determine whether this resource has any child of a given type.
boolean	isModelDefined() Determine whether the model of this resource is defined.
boolean	isProxy() Gets whether operations against this resource will be proxied to a remote process.
boolean	isRuntime() Gets whether this resource only exists in the runtime and has no representation in the persistent configuration model.
Resource	navigate(PathAddress address) Navigate the resource tree.
void	registerChild(PathElement address, int index, Resource resource) Register a child resource
void	registerChild(PathElement address, Resource resource) Register a child resource.
Resource	removeChild(PathElement address) Remove a child resource.
Resource	requireChild(PathElement element) Get a single child of this resource with the given address.
void	writeModel(org.jboss.dmr.ModelNode newModel) Write the model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.as.controller.registry.Resource

shallowCopy

Field Detail

INSTANCE

public static final PlaceholderResource INSTANCE

Method Detail

getModel

public org.jboss.dmr.ModelNode getModel()

Description copied from interface: Resource

Get the local model.

Specified by:

getModel in interface Resource

Returns:

the model

writeModel

public void writeModel(org.jboss.dmr.ModelNode newModel)

Description copied from interface: Resource

Write the model.

Specified by:

writeModel in interface Resource

Parameters:

newModel - the new model

isModelDefined

public boolean isModelDefined()

Description copied from interface: Resource

Determine whether the model of this resource is defined.

Specified by:

isModelDefined in interface Resource

Returns:

true if the local model is defined

hasChild

public boolean hasChild(PathElement element)

Description copied from interface: Resource

Determine whether this resource has a child with the given address. In case the PathElement has a wildcard as value, it will determine whether this resource has any resources of a given type.

Specified by:

hasChild in interface Resource

Parameters:

element - the path element

Returns:

true if there is child with the given address

getChild

public Resource getChild(PathElement element)

Description copied from interface: Resource

Get a single child of this resource with the given address. If no such child exists this will return null.

Specified by:

getChild in interface Resource

Parameters:

element - the path element

Returns:

the resource, null if there is no such child resource

requireChild

public Resource requireChild(PathElement element)

Description copied from interface: Resource

Get a single child of this resource with the given address. If no such child exists a, an exception is thrown.

Specified by:

requireChild in interface Resource

Parameters:

element - the path element

Returns:

the resource

hasChildren

public boolean hasChildren(String childType)

Description copied from interface: Resource

Determine whether this resource has any child of a given type.

Specified by:

hasChildren in interface Resource

Parameters:

childType - the child type

Returns:

true if there is any child of the given type

navigate

public Resource navigate(PathAddress address)

Description copied from interface: Resource

Navigate the resource tree.

Specified by:

navigate in interface Resource

Parameters:

address - the address

Returns:

the resource

getChildTypes

public Set<String> getChildTypes()

Description copied from interface: Resource

Get a list of registered child types for this resource.

Specified by:

getChildTypes in interface Resource

Returns:

the registered child types

getChildrenNames

public Set<String> getChildrenNames(String childType)

Description copied from interface: Resource

Get the children names for a given type.

Specified by:

getChildrenNames in interface Resource

Parameters:

childType - the child type

Returns:

the names of registered child resources

getChildren

public Set<Resource.ResourceEntry> getChildren(String childType)

Description copied from interface: Resource

Get the children for a given type.

Specified by:

getChildren in interface Resource

Parameters:

childType - the child type

Returns:

the registered children

registerChild

public void registerChild(PathElement address,
                          Resource resource)

Description copied from interface: Resource

Register a child resource.

Specified by:

registerChild in interface Resource

Parameters:

address - the address

resource - the resource

registerChild

public void registerChild(PathElement address,
                          int index,
                          Resource resource)

Description copied from interface: Resource

Register a child resource

Specified by:

registerChild in interface Resource

Parameters:

address - the address

index - the index at which to add the resource. Existing children with this index and higher will be shifted one uo

resource - the resource

removeChild

public Resource removeChild(PathElement address)

Description copied from interface: Resource

Remove a child resource.

Specified by:

removeChild in interface Resource

Parameters:

address - the address

Returns:

the resource

isRuntime

public boolean isRuntime()

Description copied from interface: Resource

Gets whether this resource only exists in the runtime and has no representation in the persistent configuration model.

Specified by:

isRuntime in interface Resource

Returns:

true if the resource has no representation in the persistent configuration model; false otherwise

isProxy

public boolean isProxy()

Description copied from interface: Resource

Gets whether operations against this resource will be proxied to a remote process.

Specified by:

isProxy in interface Resource

Returns:

true if this resource represents a remote resource; false otherwise

getOrderedChildTypes

public Set<String> getOrderedChildTypes()

Description copied from interface: Resource

Return the child types for which the order matters.

Specified by:

getOrderedChildTypes in interface Resource

Returns:

true if the order of the children matters. If there are no ordered children and empty set is returned. This method should never return null

clone

public Resource clone()

Description copied from interface: Resource

Creates and returns a copy of this resource.

Specified by:

clone in interface Resource

Overrides:

clone in class Object

Returns:

the clone. Will not return null