Package org.jboss.as.controller

Class PersistentResourceXMLDescription

java.lang.Object

org.jboss.as.controller.PersistentResourceXMLDescription

All Implemented Interfaces:

ResourceMarshaller, ResourceParser

public final class PersistentResourceXMLDescription
extends Object
implements ResourceParser, ResourceMarshaller

A representation of a resource as needed by the XML parser.

Author:

Tomaz Cerar, Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PersistentResourceXMLDescription.AdditionalOperationsGenerator	Some resources require more operations that just a simple add.
static interface	PersistentResourceXMLDescription.Builder	Builds a PersistentResourceXMLDescription.
static interface	PersistentResourceXMLDescription.Factory	Factory for creating a PersistentResourceXMLDescription builder.
static class	PersistentResourceXMLDescription.PersistentResourceXMLBuilder

Method Summary

Modifier and Type	Method	Description
static PersistentResourceXMLDescription.PersistentResourceXMLBuilder	builder(PathElement pathElement)	Creates builder for passed path element
static PersistentResourceXMLDescription.PersistentResourceXMLBuilder	builder(PathElement pathElement, String namespaceURI)	Creates builder for passed path element
static PersistentResourceXMLDescription.PersistentResourceXMLBuilder	builder(PathElement path, org.jboss.staxmapper.Namespace namespace)	Creates builder for the given subsystem path and namespace.
static PersistentResourceXMLDescription.PersistentResourceXMLBuilder	decorator(String elementName)	Creates builder for passed path element
static <S extends PersistentSubsystemSchema<S>> PersistentResourceXMLDescription.Factory	factory(PersistentSubsystemSchema<S> schema)	Creates a factory for creating a PersistentResourceXMLDescription builders for the specified subsystem schema.
PathElement	getPathElement()
void	parse(org.jboss.staxmapper.XMLExtendedStreamReader reader, PathAddress parentAddress, List<org.jboss.dmr.ModelNode> list)	Parse xml from provided reader and add resulting operations to passed list
void	persist(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode model)
void	persist(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode model, String namespaceURI)
void	persistChildren(org.jboss.staxmapper.XMLExtendedStreamWriter writer, org.jboss.dmr.ModelNode model)

Methods inherited from class java.lang.Object

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

Method Detail

getPathElement

public PathElement getPathElement()

parse

public void parse(org.jboss.staxmapper.XMLExtendedStreamReader reader,
                  PathAddress parentAddress,
                  List<org.jboss.dmr.ModelNode> list)
           throws XMLStreamException

Parse xml from provided reader and add resulting operations to passed list

Specified by:

parse in interface ResourceParser

Parameters:

reader - xml reader to parse from

parentAddress - address of the parent, used as base for all child elements

list - list of operations where result will be put to.

Throws:

XMLStreamException - if any error occurs while parsing

persist

public void persist(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                    org.jboss.dmr.ModelNode model)
             throws XMLStreamException

Specified by:

persist in interface ResourceMarshaller

Throws:

XMLStreamException

persist

public void persist(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                    org.jboss.dmr.ModelNode model,
                    String namespaceURI)
             throws XMLStreamException

Throws:

XMLStreamException

persistChildren

public void persistChildren(org.jboss.staxmapper.XMLExtendedStreamWriter writer,
                            org.jboss.dmr.ModelNode model)
                     throws XMLStreamException

Throws:

XMLStreamException

builder

public static PersistentResourceXMLDescription.PersistentResourceXMLBuilder builder(PathElement pathElement)

Creates builder for passed path element

Parameters:

pathElement - for which we are creating builder

Returns:

PersistentResourceXMLBuilder

builder

public static PersistentResourceXMLDescription.PersistentResourceXMLBuilder builder(PathElement pathElement,
                                                                                    String namespaceURI)

Creates builder for passed path element

Parameters:

pathElement - for which we are creating builder

namespaceURI - xml namespace to use for this resource, usually used for top level elements such as subsystems

Returns:

PersistentResourceXMLBuilder

builder

public static PersistentResourceXMLDescription.PersistentResourceXMLBuilder builder(PathElement path,
                                                                                    org.jboss.staxmapper.Namespace namespace)

Creates builder for the given subsystem path and namespace.

Parameters:

path - a subsystem path element

namespace - the subsystem namespace

Returns:

a builder for creating a PersistentResourceXMLDescription.

decorator

public static PersistentResourceXMLDescription.PersistentResourceXMLBuilder decorator(String elementName)

Creates builder for passed path element

Parameters:

elementName - name of xml element that is used as decorator

Returns:

PersistentResourceXMLBuilder

Since:

4.0

factory

public static <S extends PersistentSubsystemSchema<S>> PersistentResourceXMLDescription.Factory factory(PersistentSubsystemSchema<S> schema)

Creates a factory for creating a PersistentResourceXMLDescription builders for the specified subsystem schema.

Type Parameters:

S - the schema type

Parameters:

schema - a subsystem schema

Returns:

a factory for creating a PersistentResourceXMLDescription builders