org.apache.xml.security.transforms.params

Class InclusiveNamespaces

java.lang.Object

org.apache.xml.security.utils.ElementProxy

org.apache.xml.security.transforms.params.InclusiveNamespaces

All Implemented Interfaces:

TransformParam

public class InclusiveNamespaces
extends ElementProxy
implements TransformParam

This Object serves as Content for the ds:Transforms for exclusive Canonicalization.

It implements the Element interface and can be used directly in a DOM tree.

Field Summary

Fields

Modifier and Type	Field and Description
static String	_ATT_EC_PREFIXLIST Field _ATT_EC_PREFIXLIST
static String	_TAG_EC_INCLUSIVENAMESPACES Field _TAG_EC_INCLUSIVENAMESPACES
static String	ExclusiveCanonicalizationNamespace Field ExclusiveCanonicalizationNamespace

Fields inherited from class org.apache.xml.security.utils.ElementProxy

baseURI, LOG

Constructor Summary

Constructors

Constructor and Description
InclusiveNamespaces(Document doc, Set<String> prefixes) Constructor InclusiveNamespaces
InclusiveNamespaces(Document doc, String prefixList) Constructor XPathContainer
InclusiveNamespaces(Element element, String baseURI) Constructor InclusiveNamespaces

Method Summary

Modifier and Type	Method and Description
String	getBaseLocalName() Method getBaseLocalName Returns the localname of the Elements of the sub-class.
String	getBaseNamespace() Method getBaseNamespace Returns the namespace of the Elements of the sub-class.
String	getInclusiveNamespaces() Method getInclusiveNamespaces
static SortedSet<String>	prefixStr2Set(String inclusiveNamespaces) Decodes the inclusiveNamespaces String and returns all selected namespace prefixes as a Set.

Methods inherited from class org.apache.xml.security.utils.ElementProxy

addBase64Element, addBase64Text, addBigIntegerElement, addReturnToSelf, addText, addTextElement, appendOther, appendSelf, appendSelf, createElementForFamily, createElementForFamilyLocal, createText, getBaseURI, getBigIntegerFromChildElement, getBytesFromTextChild, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getFirstChild, getLocalAttribute, getTextFromChildElement, getTextFromTextChild, length, registerDefaultPrefixes, setDefaultPrefix, setDocument, setElement, setElement, setLocalAttribute, setLocalIdAttribute, setXPathNamespaceContext

Methods inherited from class java.lang.Object

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

Field Detail

_TAG_EC_INCLUSIVENAMESPACES

public static final String _TAG_EC_INCLUSIVENAMESPACES

Field _TAG_EC_INCLUSIVENAMESPACES

See Also:

Constant Field Values

_ATT_EC_PREFIXLIST

public static final String _ATT_EC_PREFIXLIST

Field _ATT_EC_PREFIXLIST

See Also:

Constant Field Values

ExclusiveCanonicalizationNamespace

public static final String ExclusiveCanonicalizationNamespace

Field ExclusiveCanonicalizationNamespace

See Also:

Constant Field Values

Constructor Detail

InclusiveNamespaces

public InclusiveNamespaces(Document doc,
                           String prefixList)

Constructor XPathContainer

Parameters:

doc -

prefixList -

InclusiveNamespaces

public InclusiveNamespaces(Document doc,
                           Set<String> prefixes)

Constructor InclusiveNamespaces

Parameters:

doc -

prefixes -

InclusiveNamespaces

public InclusiveNamespaces(Element element,
                           String baseURI)
                    throws XMLSecurityException

Constructor InclusiveNamespaces

Parameters:

element -

baseURI -

Throws:

XMLSecurityException

Method Detail

getInclusiveNamespaces

public String getInclusiveNamespaces()

Method getInclusiveNamespaces

Returns:

The Inclusive Namespace string

prefixStr2Set

public static SortedSet<String> prefixStr2Set(String inclusiveNamespaces)

Decodes the inclusiveNamespaces String and returns all selected namespace prefixes as a Set. The #default namespace token is represented as an empty namespace prefix ("xmlns").
The String inclusiveNamespaces=" xenc ds #default" is returned as a Set containing the following Strings:

• xmlns
• xenc
• ds

Parameters:

inclusiveNamespaces -

Returns:

A set to string

getBaseNamespace

public String getBaseNamespace()

Method getBaseNamespace Returns the namespace of the Elements of the sub-class.

Specified by:

getBaseNamespace in class ElementProxy

Returns:

the namespace of the Elements of the sub-class.

getBaseLocalName

public String getBaseLocalName()

Method getBaseLocalName Returns the localname of the Elements of the sub-class.

Specified by:

getBaseLocalName in class ElementProxy

Returns:

the localname of the Elements of the sub-class.