Package org.jboss.modules.xml

Class ModuleXmlParser

java.lang.Object

org.jboss.modules.xml.ModuleXmlParser

public final class ModuleXmlParser
extends Object

A fast, validating module.xml parser.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModuleXmlParser.ResourceRootFactory	A factory for resource roots, based on a root path, loader path, and loader name.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	A_ACTIONS
private static final String	A_EXPORT
private static final String	A_NAME
private static final String	A_OPTIONAL
private static final String	A_PATH
private static final String	A_PERMISSION
private static final String	A_SERVICES
private static final String	A_SLOT
private static final String	A_TARGET_NAME
private static final String	A_TARGET_SLOT
private static final String	A_VALUE
private static final AllPermission	ALL_PERMISSION
private static final String	D_EXPORT
private static final String	D_IMPORT
private static final String	D_NONE
(package private) static final Permissions	DEFAULT_PERMISSION_COLLECTION
private static final String	E_ARTIFACT
private static final String	E_DEPENDENCIES
private static final String	E_EXCLUDE
private static final String	E_EXCLUDE_SET
private static final String	E_EXPORTS
private static final String	E_FILTER
private static final String	E_GRANT
private static final String	E_IMPORTS
private static final String	E_INCLUDE
private static final String	E_INCLUDE_SET
private static final String	E_MAIN_CLASS
private static final String	E_MODULE
private static final String	E_MODULE_ABSENT
private static final String	E_MODULE_ALIAS
private static final String	E_NATIVE_ARTIFACT
private static final String	E_PATH
private static final String	E_PATHS
private static final String	E_PERMISSIONS
private static final String	E_PROPERTIES
private static final String	E_PROPERTY
private static final String	E_RESOURCE_ROOT
private static final String	E_RESOURCES
private static final String	E_SYSTEM
private static final List<String>	LIST_A_NAME
private static final List<String>	LIST_A_NAME_A_SLOT
private static final List<String>	LIST_A_NAME_A_TARGET_NAME
private static final List<String>	LIST_A_PATH
private static final List<String>	LIST_A_PERMISSION_A_NAME
private static final String	MODULE_1_0
private static final String	MODULE_1_1
private static final String	MODULE_1_2
private static final String	MODULE_1_3
private static final String	MODULE_1_5

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ModuleXmlParser()

Method Summary

Modifier and Type	Method	Description
private static void	assertNoAttributes(XmlPullParser reader)
private static void	copy(InputStream in, OutputStream out)
private static void	createMavenNativeArtifactLoader(MavenResolver mavenResolver, String name, XmlPullParser reader, ModuleSpec.Builder specBuilder)
static XmlPullParserException	endOfDocument(XmlPullParser reader)
private static Permissions	getAllPermission()
private static XmlPullParserException	invalidModuleName(XmlPullParser reader, ModuleIdentifier expected)
private static XmlPullParserException	missingAttributes(XmlPullParser reader, Set<String> required)
private static void	parseArtifact(MavenResolver mavenResolver, XmlPullParser reader, ModuleSpec.Builder specBuilder)
private static void	parseDependencies(XmlPullParser reader, ArrayList<DependencySpec> dependencies)
private static ModuleSpec	parseDocument(MavenResolver mavenResolver, ModuleXmlParser.ResourceRootFactory factory, String rootPath, XmlPullParser reader, ModuleLoader moduleLoader, ModuleIdentifier moduleIdentifier)
private static void	parseEndDocument(XmlPullParser reader)
private static void	parseFilterList(XmlPullParser reader, MultiplePathFilterBuilder builder)
private static void	parseGrant(XmlPullParser reader, ModuleLoader moduleLoader, ModuleIdentifier moduleIdentifier, ArrayList<PermissionFactory> list)
private static void	parseMainClass(XmlPullParser reader, ModuleSpec.Builder specBuilder)
private static void	parseModuleAbsentContents(XmlPullParser reader, ModuleIdentifier moduleIdentifier)
private static ModuleSpec	parseModuleAliasContents(XmlPullParser reader, ModuleIdentifier moduleIdentifier)
private static void	parseModuleContents(MavenResolver mavenResolver, XmlPullParser reader, ModuleXmlParser.ResourceRootFactory factory, ModuleLoader moduleLoader, ModuleIdentifier moduleIdentifier, ModuleSpec.Builder specBuilder, String rootPath)
private static void	parseModuleDependency(XmlPullParser reader, ArrayList<DependencySpec> dependencies)
static ModuleSpec	parseModuleXml(ModuleLoader moduleLoader, ModuleIdentifier moduleIdentifier, File root, File moduleInfoFile)	Parse a module.xml file.
static ModuleSpec	parseModuleXml(ModuleXmlParser.ResourceRootFactory factory, String rootPath, InputStream source, String moduleInfoFile, ModuleLoader moduleLoader, ModuleIdentifier moduleIdentifier)	Parse a module.xml file.
static ModuleSpec	parseModuleXml(ModuleXmlParser.ResourceRootFactory factory, MavenResolver mavenResolver, String rootPath, InputStream source, String moduleInfoFile, ModuleLoader moduleLoader, ModuleIdentifier moduleIdentifier)	Parse a module.xml file.
private static void	parseNativeArtifact(MavenResolver mavenResolver, XmlPullParser reader, ModuleSpec.Builder specBuilder)
private static void	parseNoContent(XmlPullParser reader)
private static void	parsePath(XmlPullParser reader, boolean include, MultiplePathFilterBuilder builder)
private static void	parsePathName(XmlPullParser reader, Set<String> set)
private static void	parsePermissions(XmlPullParser reader, ModuleLoader moduleLoader, ModuleIdentifier moduleIdentifier, ModuleSpec.Builder specBuilder)
private static void	parseProperties(XmlPullParser reader, ModuleSpec.Builder specBuilder)
private static void	parseProperty(XmlPullParser reader, ModuleSpec.Builder specBuilder)
private static void	parseResourceRoot(ModuleXmlParser.ResourceRootFactory factory, String rootPath, XmlPullParser reader, ModuleSpec.Builder specBuilder)
private static void	parseResources(MavenResolver mavenResolver, ModuleXmlParser.ResourceRootFactory factory, String rootPath, XmlPullParser reader, ModuleSpec.Builder specBuilder)
private static ModuleSpec	parseRootElement(MavenResolver mavenResolver, ModuleXmlParser.ResourceRootFactory factory, String rootPath, XmlPullParser reader, ModuleLoader moduleLoader, ModuleIdentifier moduleIdentifier)
private static Set<String>	parseSet(XmlPullParser reader)
private static void	parseSet(XmlPullParser reader, boolean include, MultiplePathFilterBuilder builder)
private static void	parseSystemDependency(XmlPullParser reader, ArrayList<DependencySpec> dependencies)
private static void	safeClose(Closeable closeable)
static XmlPullParserException	unexpectedContent(XmlPullParser reader)
private static XmlPullParserException	unknownAttribute(XmlPullParser parser, int index)
private static XmlPullParserException	unknownAttributeValue(XmlPullParser parser, int index)
private static void	unzip(File src, File destDir)
private static void	validateAttributeNamespace(XmlPullParser reader, int index)
private static void	validateNamespace(XmlPullParser reader)

Methods inherited from class java.lang.Object

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

Field Details

MODULE_1_0

private static final String MODULE_1_0

See Also:

• Constant Field Values

MODULE_1_1

private static final String MODULE_1_1

See Also:

• Constant Field Values

MODULE_1_2

private static final String MODULE_1_2

See Also:

• Constant Field Values

MODULE_1_3

private static final String MODULE_1_3

See Also:

• Constant Field Values

MODULE_1_5

private static final String MODULE_1_5

See Also:

• Constant Field Values

E_MODULE

private static final String E_MODULE

See Also:

• Constant Field Values

E_ARTIFACT

private static final String E_ARTIFACT

See Also:

• Constant Field Values

E_NATIVE_ARTIFACT

private static final String E_NATIVE_ARTIFACT

See Also:

• Constant Field Values

E_DEPENDENCIES

private static final String E_DEPENDENCIES

See Also:

• Constant Field Values

E_RESOURCES

private static final String E_RESOURCES

See Also:

• Constant Field Values

E_MAIN_CLASS

private static final String E_MAIN_CLASS

See Also:

• Constant Field Values

E_RESOURCE_ROOT

private static final String E_RESOURCE_ROOT

See Also:

• Constant Field Values

E_PATH

private static final String E_PATH

See Also:

• Constant Field Values

E_EXPORTS

private static final String E_EXPORTS

See Also:

• Constant Field Values

E_IMPORTS

private static final String E_IMPORTS

See Also:

• Constant Field Values

E_INCLUDE

private static final String E_INCLUDE

See Also:

• Constant Field Values

E_EXCLUDE

private static final String E_EXCLUDE

See Also:

• Constant Field Values

E_INCLUDE_SET

private static final String E_INCLUDE_SET

See Also:

• Constant Field Values

E_EXCLUDE_SET

private static final String E_EXCLUDE_SET

See Also:

• Constant Field Values

E_FILTER

private static final String E_FILTER

See Also:

• Constant Field Values

E_SYSTEM

private static final String E_SYSTEM

See Also:

• Constant Field Values

E_PATHS

private static final String E_PATHS

See Also:

• Constant Field Values

E_MODULE_ALIAS

private static final String E_MODULE_ALIAS

See Also:

• Constant Field Values

E_MODULE_ABSENT

private static final String E_MODULE_ABSENT

See Also:

• Constant Field Values

E_PROPERTIES

private static final String E_PROPERTIES

See Also:

• Constant Field Values

E_PROPERTY

private static final String E_PROPERTY

See Also:

• Constant Field Values

E_PERMISSIONS

private static final String E_PERMISSIONS

See Also:

• Constant Field Values

E_GRANT

private static final String E_GRANT

See Also:

• Constant Field Values

A_NAME

private static final String A_NAME

See Also:

• Constant Field Values

A_SLOT

private static final String A_SLOT

See Also:

• Constant Field Values

A_EXPORT

private static final String A_EXPORT

See Also:

• Constant Field Values

A_SERVICES

private static final String A_SERVICES

See Also:

• Constant Field Values

A_PATH

private static final String A_PATH

See Also:

• Constant Field Values

A_OPTIONAL

private static final String A_OPTIONAL

See Also:

• Constant Field Values

A_TARGET_NAME

private static final String A_TARGET_NAME

See Also:

• Constant Field Values

A_TARGET_SLOT

private static final String A_TARGET_SLOT

See Also:

• Constant Field Values

A_VALUE

private static final String A_VALUE

See Also:

• Constant Field Values

A_PERMISSION

private static final String A_PERMISSION

See Also:

• Constant Field Values

A_ACTIONS

private static final String A_ACTIONS

See Also:

• Constant Field Values

D_NONE

private static final String D_NONE

See Also:

• Constant Field Values

D_IMPORT

private static final String D_IMPORT

See Also:

• Constant Field Values

D_EXPORT

private static final String D_EXPORT

See Also:

• Constant Field Values

LIST_A_NAME

private static final List<String> LIST_A_NAME

LIST_A_PATH

private static final List<String> LIST_A_PATH

LIST_A_NAME_A_SLOT

private static final List<String> LIST_A_NAME_A_SLOT

LIST_A_NAME_A_TARGET_NAME

private static final List<String> LIST_A_NAME_A_TARGET_NAME

LIST_A_PERMISSION_A_NAME

private static final List<String> LIST_A_PERMISSION_A_NAME

ALL_PERMISSION

private static final AllPermission ALL_PERMISSION

DEFAULT_PERMISSION_COLLECTION

static final Permissions DEFAULT_PERMISSION_COLLECTION

Constructor Details

ModuleXmlParser

private ModuleXmlParser()

Method Details

parseModuleXml

public static ModuleSpec parseModuleXml(ModuleLoader moduleLoader,
 ModuleIdentifier moduleIdentifier,
 File root,
 File moduleInfoFile)
                                 throws ModuleLoadException,
IOException

Parse a module.xml file.

Parameters:

moduleLoader - the module loader to use for dependency specifications

moduleIdentifier - the module identifier of the module to load

root - the module path root

moduleInfoFile - the File of the module.xml content

Returns:

a module specification

Throws:

ModuleLoadException - if a dependency could not be established or another error occurs

IOException - if I/O fails

parseModuleXml

public static ModuleSpec parseModuleXml(ModuleXmlParser.ResourceRootFactory factory,
 String rootPath,
 InputStream source,
 String moduleInfoFile,
 ModuleLoader moduleLoader,
 ModuleIdentifier moduleIdentifier)
                                 throws ModuleLoadException,
IOException

Parse a module.xml file.

Parameters:

factory - the resource root factory to use (must not be null)

rootPath - the root path to send in to the resource root factory (must not be null)

source - a stream of the module.xml content (must not be null)

moduleInfoFile - the File of the module.xml content (must not be null)

moduleLoader - the module loader to use for dependency specifications (must not be null)

moduleIdentifier - the module identifier of the module to load

Returns:

a module specification

Throws:

ModuleLoadException - if a dependency could not be established or another error occurs

IOException - if I/O fails

parseModuleXml

public static ModuleSpec parseModuleXml(ModuleXmlParser.ResourceRootFactory factory,
 MavenResolver mavenResolver,
 String rootPath,
 InputStream source,
 String moduleInfoFile,
 ModuleLoader moduleLoader,
 ModuleIdentifier moduleIdentifier)
                                 throws ModuleLoadException,
IOException

Parse a module.xml file.

Parameters:

factory - the resource root factory to use (must not be null)

mavenResolver - the Maven artifact resolver to use (must not be null)

rootPath - the root path to send in to the resource root factory (must not be null)

source - a stream of the module.xml content (must not be null)

moduleInfoFile - the File of the module.xml content (must not be null)

moduleLoader - the module loader to use for dependency specifications (must not be null)

moduleIdentifier - the module identifier of the module to load

Returns:

a module specification

Throws:

ModuleLoadException - if a dependency could not be established or another error occurs

IOException - if I/O fails

unexpectedContent

public static XmlPullParserException unexpectedContent(XmlPullParser reader)

endOfDocument

public static XmlPullParserException endOfDocument(XmlPullParser reader)

invalidModuleName

private static XmlPullParserException invalidModuleName(XmlPullParser reader,
 ModuleIdentifier expected)

missingAttributes

private static XmlPullParserException missingAttributes(XmlPullParser reader,
 Set<String> required)

unknownAttribute

private static XmlPullParserException unknownAttribute(XmlPullParser parser,
 int index)

unknownAttributeValue

private static XmlPullParserException unknownAttributeValue(XmlPullParser parser,
 int index)

validateNamespace

private static void validateNamespace(XmlPullParser reader)
                               throws XmlPullParserException

Throws:

XmlPullParserException

assertNoAttributes

private static void assertNoAttributes(XmlPullParser reader)
                                throws XmlPullParserException

Throws:

XmlPullParserException

validateAttributeNamespace

private static void validateAttributeNamespace(XmlPullParser reader,
 int index)
                                        throws XmlPullParserException

Throws:

XmlPullParserException

parseDocument

private static ModuleSpec parseDocument(MavenResolver mavenResolver,
 ModuleXmlParser.ResourceRootFactory factory,
 String rootPath,
 XmlPullParser reader,
 ModuleLoader moduleLoader,
 ModuleIdentifier moduleIdentifier)
                                 throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseRootElement

private static ModuleSpec parseRootElement(MavenResolver mavenResolver,
 ModuleXmlParser.ResourceRootFactory factory,
 String rootPath,
 XmlPullParser reader,
 ModuleLoader moduleLoader,
 ModuleIdentifier moduleIdentifier)
                                    throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseModuleAliasContents

private static ModuleSpec parseModuleAliasContents(XmlPullParser reader,
 ModuleIdentifier moduleIdentifier)
                                            throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseModuleAbsentContents

private static void parseModuleAbsentContents(XmlPullParser reader,
 ModuleIdentifier moduleIdentifier)
                                       throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

getAllPermission

private static Permissions getAllPermission()

parseModuleContents

private static void parseModuleContents(MavenResolver mavenResolver,
 XmlPullParser reader,
 ModuleXmlParser.ResourceRootFactory factory,
 ModuleLoader moduleLoader,
 ModuleIdentifier moduleIdentifier,
 ModuleSpec.Builder specBuilder,
 String rootPath)
                                 throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseDependencies

private static void parseDependencies(XmlPullParser reader,
 ArrayList<DependencySpec> dependencies)
                               throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseModuleDependency

private static void parseModuleDependency(XmlPullParser reader,
 ArrayList<DependencySpec> dependencies)
                                   throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseSystemDependency

private static void parseSystemDependency(XmlPullParser reader,
 ArrayList<DependencySpec> dependencies)
                                   throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseMainClass

private static void parseMainClass(XmlPullParser reader,
 ModuleSpec.Builder specBuilder)
                            throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseResources

private static void parseResources(MavenResolver mavenResolver,
 ModuleXmlParser.ResourceRootFactory factory,
 String rootPath,
 XmlPullParser reader,
 ModuleSpec.Builder specBuilder)
                            throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

createMavenNativeArtifactLoader

private static void createMavenNativeArtifactLoader(MavenResolver mavenResolver,
 String name,
 XmlPullParser reader,
 ModuleSpec.Builder specBuilder)
                                             throws IOException,
XmlPullParserException

Throws:

IOException

XmlPullParserException

parseNativeArtifact

private static void parseNativeArtifact(MavenResolver mavenResolver,
 XmlPullParser reader,
 ModuleSpec.Builder specBuilder)
                                 throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseArtifact

private static void parseArtifact(MavenResolver mavenResolver,
 XmlPullParser reader,
 ModuleSpec.Builder specBuilder)
                           throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseResourceRoot

private static void parseResourceRoot(ModuleXmlParser.ResourceRootFactory factory,
 String rootPath,
 XmlPullParser reader,
 ModuleSpec.Builder specBuilder)
                               throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseFilterList

private static void parseFilterList(XmlPullParser reader,
 MultiplePathFilterBuilder builder)
                             throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parsePath

private static void parsePath(XmlPullParser reader,
 boolean include,
 MultiplePathFilterBuilder builder)
                       throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseSet

private static Set<String> parseSet(XmlPullParser reader)
                             throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseSet

private static void parseSet(XmlPullParser reader,
 boolean include,
 MultiplePathFilterBuilder builder)
                      throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parsePathName

private static void parsePathName(XmlPullParser reader,
 Set<String> set)
                           throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseProperties

private static void parseProperties(XmlPullParser reader,
 ModuleSpec.Builder specBuilder)
                             throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseProperty

private static void parseProperty(XmlPullParser reader,
 ModuleSpec.Builder specBuilder)
                           throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parsePermissions

private static void parsePermissions(XmlPullParser reader,
 ModuleLoader moduleLoader,
 ModuleIdentifier moduleIdentifier,
 ModuleSpec.Builder specBuilder)
                              throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseGrant

private static void parseGrant(XmlPullParser reader,
 ModuleLoader moduleLoader,
 ModuleIdentifier moduleIdentifier,
 ArrayList<PermissionFactory> list)
                        throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseNoContent

private static void parseNoContent(XmlPullParser reader)
                            throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

parseEndDocument

private static void parseEndDocument(XmlPullParser reader)
                              throws XmlPullParserException,
IOException

Throws:

XmlPullParserException

IOException

unzip

private static void unzip(File src,
 File destDir)
                   throws IOException

Throws:

IOException

copy

private static void copy(InputStream in,
 OutputStream out)
                  throws IOException

Throws:

IOException

safeClose

private static void safeClose(Closeable closeable)