org.apache.ws.commons.schema

Class SchemaBuilder

java.lang.Object

org.apache.ws.commons.schema.SchemaBuilder

public class SchemaBuilder
extends java.lang.Object

Object used to build a schema from a schema document. This object includes a cache of previously resolved schema documents. This cache might be useful when an application has multiple webservices that each have WSDL documents that import the same schema, for example. On app startup, we may wish to cache XmlSchema objects so we don't build up the schema graph multiple times. key - use a combination of thread id and all three parameters passed to resolveXmlSchema to give minimal thread safety value - XmlSchema object wrapped in a SoftReference to encourage GC in low memory situations. CAUTION: XmlSchema objects are not likely to be thread-safe. This cache should only be used, then cleared, by callers aware of its existence. It is VERY important that users of this cache call clearCache() after they are done. Usage of the cache is controlled by calling initCache() which will initialize resolvedSchemas to non-null. Clearing of cache is done by calling clearCache() which will clear and nullify resolvedSchemas

Field Summary

Fields

Modifier and Type	Field and Description
(package private) XmlSchemaCollection	collection
(package private) org.w3c.dom.Document	currentDocument
(package private) XmlSchema	currentSchema
private TargetNamespaceValidator	currentValidator
(package private) javax.xml.parsers.DocumentBuilderFactory	docFac
private ExtensionRegistry	extReg The extension registry to be used while building the schema model
private static java.util.Set<java.lang.String>	RESERVED_ATTRIBUTES
private static java.lang.String[]	RESERVED_ATTRIBUTES_LIST
(package private) static java.lang.ThreadLocal<java.util.Map<java.lang.String,java.lang.ref.SoftReference<XmlSchema>>>	resolvedSchemas

Constructor Summary

Constructors

Constructor and Description
SchemaBuilder(XmlSchemaCollection collection, TargetNamespaceValidator validator) Schema builder constructor

Method Summary

Modifier and Type	Method and Description
(package private) XmlSchema	build(org.w3c.dom.Document doc, java.lang.String uri) build method taking in a document and a validation handler
static void	clearCache() Remove any entries from the cache for the current thread.
private java.lang.String	getAttribute(org.w3c.dom.Element content, java.lang.String attrName)
private XmlSchema	getCachedSchema(java.lang.String targetNamespace, java.lang.String schemaLocation, java.lang.String baseUri) Return a cached schema if one exists for this thread.
private java.util.List<org.w3c.dom.Node>	getChildren(org.w3c.dom.Element content)
(package private) XmlSchemaDerivationMethod	getDerivation(org.w3c.dom.Element el, java.lang.String attrName)
(package private) java.lang.String	getEnumString(org.w3c.dom.Element el, java.lang.String attrName)
ExtensionRegistry	getExtReg()
(package private) XmlSchemaForm	getFormDefault(org.w3c.dom.Element el, java.lang.String attrName)
(package private) long	getMaxOccurs(org.w3c.dom.Element el)
(package private) long	getMinOccurs(org.w3c.dom.Element el)
private javax.xml.namespace.QName	getRefQName(java.lang.String pName, javax.xml.namespace.NamespaceContext pContext)
private javax.xml.namespace.QName	getRefQName(java.lang.String pName, org.w3c.dom.Node pNode)
private XmlSchemaAll	handleAll(XmlSchema schema, org.w3c.dom.Element allEl, org.w3c.dom.Element schemaEl)
(package private) XmlSchemaAnnotation	handleAnnotation(org.w3c.dom.Element annotEl) Handles the annotation Traversing if encounter appinfo or documentation add it to annotation collection
private XmlSchemaAny	handleAny(XmlSchema schema, org.w3c.dom.Element anyEl, org.w3c.dom.Element schemaEl)
private XmlSchemaAnyAttribute	handleAnyAttribute(XmlSchema schema, org.w3c.dom.Element anyAttrEl, org.w3c.dom.Element schemaEl)
(package private) XmlSchemaAppInfo	handleAppInfo(org.w3c.dom.Element content) create new XmlSchemaAppinfo and add value gotten from element to this obj
private XmlSchemaAttribute	handleAttribute(XmlSchema schema, org.w3c.dom.Element attrEl, org.w3c.dom.Element schemaEl) Process non-toplevel attributes
private XmlSchemaAttribute	handleAttribute(XmlSchema schema, org.w3c.dom.Element attrEl, org.w3c.dom.Element schemaEl, boolean topLevel) Process attributes
private XmlSchemaAttributeGroup	handleAttributeGroup(XmlSchema schema, org.w3c.dom.Element groupEl, org.w3c.dom.Element schemaEl)
private XmlSchemaAttributeGroupRef	handleAttributeGroupRef(XmlSchema schema, org.w3c.dom.Element attrGroupEl)
private XmlSchemaChoice	handleChoice(XmlSchema schema, org.w3c.dom.Element choiceEl, org.w3c.dom.Element schemaEl)
private XmlSchemaComplexContent	handleComplexContent(XmlSchema schema, org.w3c.dom.Element complexEl, org.w3c.dom.Element schemaEl)
private XmlSchemaComplexContentExtension	handleComplexContentExtension(XmlSchema schema, org.w3c.dom.Element extEl, org.w3c.dom.Element schemaEl)
private XmlSchemaComplexContentRestriction	handleComplexContentRestriction(XmlSchema schema, org.w3c.dom.Element restrictionEl, org.w3c.dom.Element schemaEl)
(package private) XmlSchemaComplexType	handleComplexType(XmlSchema schema, org.w3c.dom.Element complexEl, org.w3c.dom.Element schemaEl, boolean topLevel) Handle complex types
private XmlSchemaIdentityConstraint	handleConstraint(org.w3c.dom.Element constraintEl, java.lang.Class<? extends XmlSchemaIdentityConstraint> typeClass)
(package private) XmlSchemaDocumentation	handleDocumentation(org.w3c.dom.Element content)
(package private) XmlSchemaElement	handleElement(XmlSchema schema, org.w3c.dom.Element el, org.w3c.dom.Element schemaEl, boolean isGlobal) handle elements
private void	handleElementAnnotation(org.w3c.dom.Element el, XmlSchemaElement element)
private boolean	handleElementForm(org.w3c.dom.Element el, XmlSchemaElement element, boolean isQualified)
private void	handleElementGlobalType(org.w3c.dom.Element el, XmlSchemaElement element)
private void	handleElementName(boolean isGlobal, XmlSchemaElement element, boolean isQualified)
private XmlSchemaGroup	handleGroup(XmlSchema schema, org.w3c.dom.Element groupEl, org.w3c.dom.Element schemaEl)
private XmlSchemaGroupRef	handleGroupRef(XmlSchema schema, org.w3c.dom.Element groupEl, org.w3c.dom.Element schemaEl)
(package private) XmlSchemaImport	handleImport(XmlSchema schema, org.w3c.dom.Element importEl, org.w3c.dom.Element schemaEl) Handle the import
(package private) XmlSchemaInclude	handleInclude(XmlSchema schema, org.w3c.dom.Element includeEl, org.w3c.dom.Element schemaEl) Handles the include
private XmlSchemaNotation	handleNotation(XmlSchema schema, org.w3c.dom.Element notationEl)
private XmlSchemaRedefine	handleRedefine(XmlSchema schema, org.w3c.dom.Element redefineEl, org.w3c.dom.Element schemaEl) Handle redefine
private void	handleSchemaElementBasics(org.w3c.dom.Element schemaEl, java.lang.String systemId, XmlSchemaCollection.SchemaKey schemaKey)
private void	handleSchemaElementChild(org.w3c.dom.Element schemaEl, org.w3c.dom.Element el)
private XmlSchemaSequence	handleSequence(XmlSchema schema, org.w3c.dom.Element sequenceEl, org.w3c.dom.Element schemaEl)
private XmlSchemaSimpleContent	handleSimpleContent(XmlSchema schema, org.w3c.dom.Element simpleEl, org.w3c.dom.Element schemaEl)
private XmlSchemaSimpleContentExtension	handleSimpleContentExtension(XmlSchema schema, org.w3c.dom.Element extEl, org.w3c.dom.Element schemaEl)
private XmlSchemaSimpleContentRestriction	handleSimpleContentRestriction(XmlSchema schema, org.w3c.dom.Element restrictionEl, org.w3c.dom.Element schemaEl)
(package private) XmlSchemaSimpleType	handleSimpleType(XmlSchema schema, org.w3c.dom.Element simpleEl, org.w3c.dom.Element schemaEl, boolean topLevel) Handles simple types
private void	handleSimpleTypeFinal(org.w3c.dom.Element simpleEl, XmlSchemaSimpleType simpleType)
private void	handleSimpleTypeList(XmlSchema schema, org.w3c.dom.Element schemaEl, XmlSchemaSimpleType simpleType, org.w3c.dom.Element listEl)
private void	handleSimpleTypeRestriction(XmlSchema schema, org.w3c.dom.Element schemaEl, XmlSchemaSimpleType simpleType, org.w3c.dom.Element restrictionEl)
private void	handleSimpleTypeUnion(XmlSchema schema, org.w3c.dom.Element schemaEl, XmlSchemaSimpleType simpleType, org.w3c.dom.Element unionEl)
(package private) XmlSchema	handleXmlSchemaElement(org.w3c.dom.Element schemaEl, java.lang.String systemId) handles the schema element
static void	initCache() Setup the cache to be used by the current thread of execution.
private TargetNamespaceValidator	newIncludeValidator(XmlSchema schema)
private void	processExtensibilityComponents(XmlSchemaObject schemaObject, org.w3c.dom.Element parentElement, boolean namespaces) A generic method to process the extra attributes and the the extra elements present within the schema.
private void	putCachedSchema(java.lang.String targetNamespace, java.lang.String schemaLocation, java.lang.String baseUri, XmlSchema readSchema) Add an XmlSchema to the cache if the current thread has the cache enabled.
(package private) XmlSchema	resolveXmlSchema(java.lang.String targetNamespace, java.lang.String schemaLocation, java.lang.String baseUri, TargetNamespaceValidator validator) Resolve the schemas
(package private) XmlSchema	resolveXmlSchema(java.lang.String targetNamespace, java.lang.String schemaLocation, TargetNamespaceValidator validator) Resolve the schemas
void	setExtReg(ExtensionRegistry extReg)
(package private) void	setNamespaceAttributes(XmlSchema schema, org.w3c.dom.Element schemaEl)

Methods inherited from class java.lang.Object

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

Field Detail

resolvedSchemas

static java.lang.ThreadLocal<java.util.Map<java.lang.String,java.lang.ref.SoftReference<XmlSchema>>> resolvedSchemas

RESERVED_ATTRIBUTES

private static final java.util.Set<java.lang.String> RESERVED_ATTRIBUTES

RESERVED_ATTRIBUTES_LIST

private static final java.lang.String[] RESERVED_ATTRIBUTES_LIST

collection

XmlSchemaCollection collection

currentDocument

org.w3c.dom.Document currentDocument

currentSchema

XmlSchema currentSchema

docFac

javax.xml.parsers.DocumentBuilderFactory docFac

currentValidator

private final TargetNamespaceValidator currentValidator

extReg

private ExtensionRegistry extReg

The extension registry to be used while building the schema model

Constructor Detail

SchemaBuilder

SchemaBuilder(XmlSchemaCollection collection,
              TargetNamespaceValidator validator)

Schema builder constructor

Parameters:

collection -

validator -

Method Detail

clearCache

public static void clearCache()

Remove any entries from the cache for the current thread. Entries for other threads are not altered.

initCache

public static void initCache()

Setup the cache to be used by the current thread of execution. Multiple threads can use the cache, and each one must call this method at some point prior to attempting to resolve the first schema, or the cache will not be used on that thread. IMPORTANT: The thread MUST call clearCache() when it is done with the schemas or a large amount of memory may remain in-use.

getExtReg

public ExtensionRegistry getExtReg()

setExtReg

public void setExtReg(ExtensionRegistry extReg)

build

XmlSchema build(org.w3c.dom.Document doc,
                java.lang.String uri)

build method taking in a document and a validation handler

Parameters:

doc -

uri -

veh -

getDerivation

XmlSchemaDerivationMethod getDerivation(org.w3c.dom.Element el,
                                        java.lang.String attrName)

getEnumString

java.lang.String getEnumString(org.w3c.dom.Element el,
                               java.lang.String attrName)

getFormDefault

XmlSchemaForm getFormDefault(org.w3c.dom.Element el,
                             java.lang.String attrName)

getMaxOccurs

long getMaxOccurs(org.w3c.dom.Element el)

getMinOccurs

long getMinOccurs(org.w3c.dom.Element el)

handleAnnotation

XmlSchemaAnnotation handleAnnotation(org.w3c.dom.Element annotEl)

Handles the annotation Traversing if encounter appinfo or documentation add it to annotation collection

handleAppInfo

XmlSchemaAppInfo handleAppInfo(org.w3c.dom.Element content)

create new XmlSchemaAppinfo and add value gotten from element to this obj

Parameters:

content -

handleComplexType

XmlSchemaComplexType handleComplexType(XmlSchema schema,
                                       org.w3c.dom.Element complexEl,
                                       org.w3c.dom.Element schemaEl,
                                       boolean topLevel)

Handle complex types

Parameters:

schema -

complexEl -

schemaEl -

b -

handleDocumentation

XmlSchemaDocumentation handleDocumentation(org.w3c.dom.Element content)

handleElement

XmlSchemaElement handleElement(XmlSchema schema,
                               org.w3c.dom.Element el,
                               org.w3c.dom.Element schemaEl,
                               boolean isGlobal)

handle elements

Parameters:

schema -

el -

schemaEl -

isGlobal -

handleImport

XmlSchemaImport handleImport(XmlSchema schema,
                             org.w3c.dom.Element importEl,
                             org.w3c.dom.Element schemaEl)

Handle the import

Parameters:

schema -

importEl -

schemaEl -

Returns:

XmlSchemaObject

handleInclude

XmlSchemaInclude handleInclude(XmlSchema schema,
                               org.w3c.dom.Element includeEl,
                               org.w3c.dom.Element schemaEl)

Handles the include

Parameters:

schema -

includeEl -

schemaEl -

handleSimpleType

XmlSchemaSimpleType handleSimpleType(XmlSchema schema,
                                     org.w3c.dom.Element simpleEl,
                                     org.w3c.dom.Element schemaEl,
                                     boolean topLevel)

Handles simple types

Parameters:

schema -

simpleEl -

schemaEl -

handleXmlSchemaElement

XmlSchema handleXmlSchemaElement(org.w3c.dom.Element schemaEl,
                                 java.lang.String systemId)

handles the schema element

Parameters:

schemaEl -

systemId -

resolveXmlSchema

XmlSchema resolveXmlSchema(java.lang.String targetNamespace,
                           java.lang.String schemaLocation,
                           java.lang.String baseUri,
                           TargetNamespaceValidator validator)

Resolve the schemas

Parameters:

targetNamespace -

schemaLocation -

resolveXmlSchema

XmlSchema resolveXmlSchema(java.lang.String targetNamespace,
                           java.lang.String schemaLocation,
                           TargetNamespaceValidator validator)

Resolve the schemas

Parameters:

targetNamespace -

schemaLocation -

setNamespaceAttributes

void setNamespaceAttributes(XmlSchema schema,
                            org.w3c.dom.Element schemaEl)

getAttribute

private java.lang.String getAttribute(org.w3c.dom.Element content,
                                      java.lang.String attrName)

getCachedSchema

private XmlSchema getCachedSchema(java.lang.String targetNamespace,
                                  java.lang.String schemaLocation,
                                  java.lang.String baseUri)

Return a cached schema if one exists for this thread. In order for schemas to be cached the thread must have done an initCache() previously. The parameters are used to construct a key used to lookup the schema

Parameters:

targetNamespace -

schemaLocation -

baseUri -

Returns:

The cached schema if one exists for this thread or null.

getChildren

private java.util.List<org.w3c.dom.Node> getChildren(org.w3c.dom.Element content)

getRefQName

private javax.xml.namespace.QName getRefQName(java.lang.String pName,
                                              javax.xml.namespace.NamespaceContext pContext)

getRefQName

private javax.xml.namespace.QName getRefQName(java.lang.String pName,
                                              org.w3c.dom.Node pNode)

handleAll

private XmlSchemaAll handleAll(XmlSchema schema,
                               org.w3c.dom.Element allEl,
                               org.w3c.dom.Element schemaEl)

handleAny

private XmlSchemaAny handleAny(XmlSchema schema,
                               org.w3c.dom.Element anyEl,
                               org.w3c.dom.Element schemaEl)

handleAnyAttribute

private XmlSchemaAnyAttribute handleAnyAttribute(XmlSchema schema,
                                                 org.w3c.dom.Element anyAttrEl,
                                                 org.w3c.dom.Element schemaEl)

handleAttribute

private XmlSchemaAttribute handleAttribute(XmlSchema schema,
                                           org.w3c.dom.Element attrEl,
                                           org.w3c.dom.Element schemaEl)

Process non-toplevel attributes

Parameters:

schema -

attrEl -

schemaEl -

Returns:

handleAttribute

private XmlSchemaAttribute handleAttribute(XmlSchema schema,
                                           org.w3c.dom.Element attrEl,
                                           org.w3c.dom.Element schemaEl,
                                           boolean topLevel)

Process attributes

Parameters:

schema -

attrEl -

schemaEl -

topLevel -

Returns:

handleAttributeGroup

private XmlSchemaAttributeGroup handleAttributeGroup(XmlSchema schema,
                                                     org.w3c.dom.Element groupEl,
                                                     org.w3c.dom.Element schemaEl)

handleAttributeGroupRef

private XmlSchemaAttributeGroupRef handleAttributeGroupRef(XmlSchema schema,
                                                           org.w3c.dom.Element attrGroupEl)

handleChoice

private XmlSchemaChoice handleChoice(XmlSchema schema,
                                     org.w3c.dom.Element choiceEl,
                                     org.w3c.dom.Element schemaEl)

handleComplexContent

private XmlSchemaComplexContent handleComplexContent(XmlSchema schema,
                                                     org.w3c.dom.Element complexEl,
                                                     org.w3c.dom.Element schemaEl)

handleComplexContentExtension

private XmlSchemaComplexContentExtension handleComplexContentExtension(XmlSchema schema,
                                                                       org.w3c.dom.Element extEl,
                                                                       org.w3c.dom.Element schemaEl)

handleComplexContentRestriction

private XmlSchemaComplexContentRestriction handleComplexContentRestriction(XmlSchema schema,
                                                                           org.w3c.dom.Element restrictionEl,
                                                                           org.w3c.dom.Element schemaEl)

handleConstraint

private XmlSchemaIdentityConstraint handleConstraint(org.w3c.dom.Element constraintEl,
                                                     java.lang.Class<? extends XmlSchemaIdentityConstraint> typeClass)

handleElementAnnotation

private void handleElementAnnotation(org.w3c.dom.Element el,
                                     XmlSchemaElement element)

handleElementForm

private boolean handleElementForm(org.w3c.dom.Element el,
                                  XmlSchemaElement element,
                                  boolean isQualified)

handleElementGlobalType

private void handleElementGlobalType(org.w3c.dom.Element el,
                                     XmlSchemaElement element)

handleElementName

private void handleElementName(boolean isGlobal,
                               XmlSchemaElement element,
                               boolean isQualified)

handleGroup

private XmlSchemaGroup handleGroup(XmlSchema schema,
                                   org.w3c.dom.Element groupEl,
                                   org.w3c.dom.Element schemaEl)

handleGroupRef

private XmlSchemaGroupRef handleGroupRef(XmlSchema schema,
                                         org.w3c.dom.Element groupEl,
                                         org.w3c.dom.Element schemaEl)

handleNotation

private XmlSchemaNotation handleNotation(XmlSchema schema,
                                         org.w3c.dom.Element notationEl)

handleRedefine

private XmlSchemaRedefine handleRedefine(XmlSchema schema,
                                         org.w3c.dom.Element redefineEl,
                                         org.w3c.dom.Element schemaEl)

Handle redefine

Parameters:

schema -

redefineEl -

schemaEl -

Returns:

handleSchemaElementBasics

private void handleSchemaElementBasics(org.w3c.dom.Element schemaEl,
                                       java.lang.String systemId,
                                       XmlSchemaCollection.SchemaKey schemaKey)

handleSchemaElementChild

private void handleSchemaElementChild(org.w3c.dom.Element schemaEl,
                                      org.w3c.dom.Element el)

handleSequence

private XmlSchemaSequence handleSequence(XmlSchema schema,
                                         org.w3c.dom.Element sequenceEl,
                                         org.w3c.dom.Element schemaEl)

handleSimpleContent

private XmlSchemaSimpleContent handleSimpleContent(XmlSchema schema,
                                                   org.w3c.dom.Element simpleEl,
                                                   org.w3c.dom.Element schemaEl)

handleSimpleContentExtension

private XmlSchemaSimpleContentExtension handleSimpleContentExtension(XmlSchema schema,
                                                                     org.w3c.dom.Element extEl,
                                                                     org.w3c.dom.Element schemaEl)

handleSimpleContentRestriction

private XmlSchemaSimpleContentRestriction handleSimpleContentRestriction(XmlSchema schema,
                                                                         org.w3c.dom.Element restrictionEl,
                                                                         org.w3c.dom.Element schemaEl)

handleSimpleTypeFinal

private void handleSimpleTypeFinal(org.w3c.dom.Element simpleEl,
                                   XmlSchemaSimpleType simpleType)

handleSimpleTypeList

private void handleSimpleTypeList(XmlSchema schema,
                                  org.w3c.dom.Element schemaEl,
                                  XmlSchemaSimpleType simpleType,
                                  org.w3c.dom.Element listEl)

handleSimpleTypeRestriction

private void handleSimpleTypeRestriction(XmlSchema schema,
                                         org.w3c.dom.Element schemaEl,
                                         XmlSchemaSimpleType simpleType,
                                         org.w3c.dom.Element restrictionEl)

handleSimpleTypeUnion

private void handleSimpleTypeUnion(XmlSchema schema,
                                   org.w3c.dom.Element schemaEl,
                                   XmlSchemaSimpleType simpleType,
                                   org.w3c.dom.Element unionEl)

newIncludeValidator

private TargetNamespaceValidator newIncludeValidator(XmlSchema schema)

processExtensibilityComponents

private void processExtensibilityComponents(XmlSchemaObject schemaObject,
                                            org.w3c.dom.Element parentElement,
                                            boolean namespaces)

A generic method to process the extra attributes and the the extra elements present within the schema. What are considered extensions are child elements with non schema namespace and child attributes with any namespace

Parameters:

schemaObject -

parentElement -

putCachedSchema

private void putCachedSchema(java.lang.String targetNamespace,
                             java.lang.String schemaLocation,
                             java.lang.String baseUri,
                             XmlSchema readSchema)

Add an XmlSchema to the cache if the current thread has the cache enabled. The first three parameters are used to construct a key

Parameters:

targetNamespace -

schemaLocation -

baseUri - This parameter is the value put under the key (if the cache is enabled)

readSchema -