Top Description Inners Fields Constructors Methods
org.jboss.modules.xml

public final Class ModuleXmlParser

extends Object
Class Inheritance
Imports
java.io.BufferedInputStream, .Closeable, .File, .FileInputStream, .FileNotFoundException, .FileOutputStream, .IOException, .InputStream, .OutputStream, java.util.ArrayList, .Arrays, .Collections, .Enumeration, .HashSet, .Iterator, .List, .Locale, .Set, java.util.jar.JarFile, java.util.zip.ZipEntry, .ZipFile, org.jboss.modules.AssertionSetting, .DependencySpec, .LocalDependencySpecBuilder, .ModuleDependencySpec, .ModuleDependencySpecBuilder, .Version, .VersionDetection, .ModuleIdentifier, .ModuleLoadException, .ModuleLoader, .ModuleSpec, .NativeLibraryResourceLoader, .PathUtils, .ResourceLoader, .ResourceLoaderSpec, .ResourceLoaders, org.jboss.modules.maven.ArtifactCoordinates, .MavenResolver, org.jboss.modules.filter.MultiplePathFilterBuilder, .PathFilter, .PathFilters, org.jboss.modules.security.FactoryPermissionCollection, .ModularPermissionFactory, .PermissionFactory
A fast, validating module.xml parser.
Authors
David M. Lloyd, [email protected]

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
ModuleXmlParser.DefaultResourceRootFactory

private static interface
ModuleXmlParser.PropertiesCallback

XML parsing callback for property elements.

public static interface
ModuleXmlParser.ResourceRootFactory

A factory for resource roots, based on a root path, loader path, and loader name.

Field Summary

Modifier and TypeField and 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 String
A_VERSION

private static final String
D_EXPORT

private static final String
D_IMPORT

private static final String
D_NONE

pack-priv static final ModuleDependencySpec
DEP_JAVA_SE

private static final String
E_ARTIFACT

private static final String
E_CONDITIONS

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_PROPERTY_EQUAL

private static final String
E_PROPERTY_NOT_EQUAL

private static final String
E_PROVIDES

private static final String
E_RESOURCE_ROOT

private static final String
E_RESOURCES

private static final String
E_SERVICE

private static final String
E_SYSTEM

private static final String
E_WITH_CLASS

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

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

private static final String
MODULE_1_6

private static final String
MODULE_1_7

private static final String
MODULE_1_8

private static final String
MODULE_1_9

private static ModuleXmlParser.PropertiesCallback
NOOP_PROPS_CALLBACK

Constructor Summary

AccessConstructor and Description
private
ModuleXmlParser()

Method Summary

Modifier and TypeMethod and Description
private static void
assertNoAttributes(final XmlPullParser reader)

private static boolean
atLeast1_6(final XmlPullParser reader)

private static boolean
atLeast1_7(final XmlPullParser reader)

private static boolean
atLeast1_8(final XmlPullParser reader)

private static boolean
atLeast1_9(final XmlPullParser reader)

private static void
copy(InputStream in, OutputStream out)

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

public static XmlPullParserException
endOfDocument(final XmlPullParser reader)

private static void
expandName(final ModuleLoader moduleLoader, final String moduleName, final ArrayList<PermissionFactory> list, String permission, String name, String actions)

private static ModuleXmlParser.PropertiesCallback

Returns:

a no-op implementation of properties callback
getNoopPropsCallback()

Returns a no-op implementation of properties callback currently used for parsing properties attached to module dependencies that aren't used at runtime in jboss-modules but are important in other projects where module dependencies are analyzed.

private static XmlPullParserException
invalidModuleName(final XmlPullParser reader, final String expected)

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

private static Version
parseArtifact(final ModuleXmlParser.ResourceRootFactory factory, final MavenResolver mavenResolver, final XmlPullParser reader, final ModuleSpec.Builder specBuilder)

private static String
parseClassNameType(final XmlPullParser reader)

private static void
parseConditionalProperty(XmlPullParser reader, boolean equal, SystemPropertyConditionBuilder builder)

private static void
parseConditions(XmlPullParser reader, SystemPropertyConditionBuilder conditionBuilder)

private static void
parseDependencies(final XmlPullParser reader, final ArrayList<DependencySpec> dependencies)

private static ModuleSpec
parseDocument(final MavenResolver mavenResolver, final ModuleXmlParser.ResourceRootFactory factory, final String rootPath, XmlPullParser reader, final ModuleLoader moduleLoader, final String moduleName)

private static void
parseEndDocument(final XmlPullParser reader)

private static void
parseFilterList(final XmlPullParser reader, final MultiplePathFilterBuilder builder)

private static void
parseGrant(final XmlPullParser reader, final ModuleLoader moduleLoader, final String moduleName, final ArrayList<PermissionFactory> list)

private static void
parseMainClass(final XmlPullParser reader, final ModuleSpec.Builder specBuilder)

private static void
parseModuleAbsentContents(final XmlPullParser reader, final String moduleName)

private static ModuleSpec
parseModuleAliasContents(final XmlPullParser reader, final String moduleName)

private static ModuleSpec.Builder
parseModuleContents(final MavenResolver mavenResolver, final XmlPullParser reader, final ModuleXmlParser.ResourceRootFactory factory, final ModuleLoader moduleLoader, final String moduleName, final String rootPath)

private static void
parseModuleDependency(final XmlPullParser reader, final ArrayList<DependencySpec> dependencies)

public static ModuleSpec

Returns:

a module specification
parseModuleXml(final ModuleLoader
the module loader to use for dependency specifications
moduleLoader, final ModuleIdentifier
the module identifier of the module to load
moduleIdentifier, final File
the module path root
root, final File
the File of the module.xml content
moduleInfoFile)

Deprecated Use parseModuleXml(ModuleLoader, String, File, File) instead.
Parse a module.xml file.
public static ModuleSpec

Returns:

a module specification
parseModuleXml(final ModuleLoader
the module loader to use for dependency specifications
moduleLoader, final String
the name of the module to load
moduleName, final File
the module path root
root, final File
the File of the module.xml content
moduleInfoFile)

Parse a module.xml file.

public static ModuleSpec

Returns:

a module specification
parseModuleXml(final ModuleXmlParser.ResourceRootFactory
the resource root factory to use (must not be null)
factory, final ModuleLoader
the module loader to use for dependency specifications
moduleLoader, final String
the name of the module to load
moduleName, final File
the module path root
root, final File
the File of the module.xml content
moduleInfoFile)

Parse a module.xml file.

public static ModuleSpec

Returns:

a module specification
parseModuleXml(final ModuleXmlParser.ResourceRootFactory
the resource root factory to use (must not be null)
factory, final String
the root path to send in to the resource root factory (must not be null)
rootPath, InputStream
a stream of the module.xml content (must not be null)
source, final String
the File of the module.xml content (must not be null)
moduleInfoFile, final ModuleLoader
the module loader to use for dependency specifications (must not be null)
moduleLoader, final ModuleIdentifier
the module identifier of the module to load
moduleIdentifier)

Deprecated Use parseModuleXml(ResourceRootFactory, String, InputStream, String, ModuleLoader, String) instead.
Parse a module.xml file.
public static ModuleSpec

Returns:

a module specification
parseModuleXml(final ModuleXmlParser.ResourceRootFactory
the resource root factory to use (must not be null)
factory, final String
the root path to send in to the resource root factory (must not be null)
rootPath, InputStream
a stream of the module.xml content (must not be null)
source, final String
the File of the module.xml content (must not be null)
moduleInfoFile, final ModuleLoader
the module loader to use for dependency specifications (must not be null)
moduleLoader, final String
the module name of the module to load
moduleName)

Parse a module.xml file.

public static ModuleSpec

Returns:

a module specification
parseModuleXml(final ModuleXmlParser.ResourceRootFactory
the resource root factory to use (must not be null)
factory, final MavenResolver
the Maven artifact resolver to use (must not be null)
mavenResolver, final String
the root path to send in to the resource root factory (must not be null)
rootPath, InputStream
a stream of the module.xml content (must not be null)
source, final String
the File of the module.xml content (must not be null)
moduleInfoFile, final ModuleLoader
the module loader to use for dependency specifications (must not be null)
moduleLoader, final ModuleIdentifier
the module identifier of the module to load
moduleIdentifier)

Deprecated Use parseModuleXml(ResourceRootFactory, MavenResolver, String, InputStream, String, ModuleLoader, String) instead.
Parse a module.xml file.
public static ModuleSpec

Returns:

a module specification
parseModuleXml(final ModuleXmlParser.ResourceRootFactory
the resource root factory to use (must not be null)
factory, final MavenResolver
the Maven artifact resolver to use (must not be null)
mavenResolver, final String
the root path to send in to the resource root factory (must not be null)
rootPath, InputStream
a stream of the module.xml content (must not be null)
source, final String
the File of the module.xml content (must not be null)
moduleInfoFile, final ModuleLoader
the module loader to use for dependency specifications (must not be null)
moduleLoader, final String
the module name of the module to load
moduleName)

Parse a module.xml file.

private static void
parseNativeArtifact(final MavenResolver mavenResolver, final XmlPullParser reader, final ModuleSpec.Builder specBuilder)

private static void
parseNoContent(final XmlPullParser reader)

private static void
parsePath(final XmlPullParser reader, final boolean include, final MultiplePathFilterBuilder builder)

private static void
parsePathName(final XmlPullParser reader, final Set<String> set)

private static void
parsePermissions(final XmlPullParser reader, final ModuleLoader moduleLoader, final String moduleName, final ModuleSpec.Builder specBuilder)

private static void
parseProperties(final XmlPullParser reader, final ModuleXmlParser.PropertiesCallback propsCallback)

private static void
parseProperty(final XmlPullParser reader, final ModuleXmlParser.PropertiesCallback propsCallback)

private static void
parseProvidedServiceType(final XmlPullParser reader, final ModuleSpec.Builder specBuilder)

private static void
parseProvidesType(final XmlPullParser reader, final ModuleSpec.Builder specBuilder)

private static Version
parseResourceRoot(final ModuleXmlParser.ResourceRootFactory factory, final String rootPath, final XmlPullParser reader, final ModuleSpec.Builder specBuilder)

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

private static ModuleSpec
parseRootElement(final MavenResolver mavenResolver, final ModuleXmlParser.ResourceRootFactory factory, final String rootPath, final XmlPullParser reader, final ModuleLoader moduleLoader, final String moduleName)

private static Set<String>
parseSet(final XmlPullParser reader)

private static void
parseSet(final XmlPullParser reader, final boolean include, final MultiplePathFilterBuilder builder)

private static void
parseSystemDependency(final XmlPullParser reader, final ArrayList<DependencySpec> dependencies)

private static void
safeClose(Closeable closeable)

public static XmlPullParserException
unexpectedContent(final XmlPullParser reader)

pack-priv static XmlPullParserException
unknownAttribute(final XmlPullParser parser, final int index)

private static XmlPullParserException
unknownAttributeValue(final XmlPullParser parser, final int index)

private static void
unzip(File src, File destDir)

private static void
validateAttributeNamespace(final XmlPullParser reader, final int index)

private static void
validateNamespace(final XmlPullParser reader)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait