Package org.jboss.as.controller

Class PersistentResourceXMLDescription

java.lang.Object

org.jboss.as.controller.PersistentResourceXMLDescription

All Implemented Interfaces:

ResourceMarshaller, ResourceParser

@Deprecated(forRemoval=true,
            since="28.0")
public final class PersistentResourceXMLDescription
extends Object
implements ResourceParser, ResourceMarshaller

Deprecated, for removal: This API element is subject to removal in a future version.

Superseded by ResourceXMLParticleFactory

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	Deprecated, for removal: This API element is subject to removal in a future version. Some resources require more operations that just a simple add.
static interface	PersistentResourceXMLDescription.Builder	Deprecated, for removal: This API element is subject to removal in a future version. Builds a PersistentResourceXMLDescription.
static interface	PersistentResourceXMLDescription.Factory	Deprecated, for removal: This API element is subject to removal in a future version. Factory for creating a PersistentResourceXMLDescription builder.
static final class	PersistentResourceXMLDescription.PersistentResourceXMLBuilder	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

getPathElement

public PathElement getPathElement()

Deprecated, for removal: This API element is subject to removal in a future version.

parse

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

Deprecated, for removal: This API element is subject to removal in a future version.

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

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

XMLStreamException

persistChildren

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

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

XMLStreamException

builder

@Deprecated
public static PersistentResourceXMLDescription.PersistentResourceXMLBuilder builder(PathElement pathElement)

Deprecated.

Use PersistentResourceXMLDescription.Factory.builder(PathElement) from factory(PersistentSubsystemSchema) instead.

Creates builder for passed path element

Parameters:

pathElement - for which we are creating builder

Returns:

PersistentResourceXMLBuilder

builder

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

Deprecated.

Use PersistentResourceXMLDescription.Factory.builder(PathElement) from factory(PersistentSubsystemSchema) instead.

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

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

Deprecated.

Use PersistentResourceXMLDescription.Factory.builder(PathElement) from factory(PersistentSubsystemSchema) instead.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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