Package org.apache.directory.api.dsmlv2

Class ParserUtils

java.lang.Object

org.apache.directory.api.dsmlv2.ParserUtils

public final class ParserUtils
extends Object

This class is a Helper class for the DSML Parser

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE64BINARY	Base-64 identifier.
static org.dom4j.Namespace	DSML_NAMESPACE	The DSML namespace
static GrammarAction	READ_SOAP_HEADER	GrammarAction that reads the SOAP header data
static String	XML_SCHEMA_INSTANCE_URI	W3C XML Schema Instance URI.
static String	XML_SCHEMA_URI	W3C XML Schema URI.
static String	XSD	XSD namespace prefix.
static String	XSD_COLON	XSD namespace prefix with ':'.
static org.dom4j.Namespace	XSD_NAMESPACE	The XSD namespace
static String	XSI	XSI namespace prefix.
static org.dom4j.Namespace	XSI_NAMESPACE	The XSI namespace

Method Summary

Modifier and Type	Method	Description
static void	addControls(LdapApiService codec, org.dom4j.Element element, Collection<Control> controls, boolean isRequest)	Adds Controls to the given Element.
static String	base64Encode(Object value)	Encodes the value as a Base64 String
static String	getXsiTypeAttributeValue(org.xmlpull.v1.XmlPullParser xpp)	Returns the value of the attribute 'type' of the "XMLSchema-instance' namespace if it exists
static boolean	isBase64BinaryValue(org.xmlpull.v1.XmlPullParser parser, String attrValue)	Tells is the given value is a Base64 binary value
static boolean	isRequestIdNeeded(Dsmlv2Container container)	Indicates if a request ID is needed.
static boolean	needsBase64Encoding(Object value)	Indicates if the value needs to be encoded as Base64
static int	parseAndVerifyRequestID(String attributeValue, org.xmlpull.v1.XmlPullParser xpp)	Parses and verify the parsed value of the requestID
static org.dom4j.Document	styleDocument(org.dom4j.Document document)	XML Pretty Printer XSLT Transformation

Methods inherited from class java.lang.Object

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

Field Detail

XML_SCHEMA_URI

public static final String XML_SCHEMA_URI

W3C XML Schema URI.

See Also:

Constant Field Values

XML_SCHEMA_INSTANCE_URI

public static final String XML_SCHEMA_INSTANCE_URI

W3C XML Schema Instance URI.

See Also:

Constant Field Values

BASE64BINARY

public static final String BASE64BINARY

Base-64 identifier.

See Also:

Constant Field Values

XSI

public static final String XSI

XSI namespace prefix.

See Also:

Constant Field Values

XSD

public static final String XSD

XSD namespace prefix.

See Also:

Constant Field Values

XSD_COLON

public static final String XSD_COLON

XSD namespace prefix with ':'.

See Also:

Constant Field Values

DSML_NAMESPACE

public static final org.dom4j.Namespace DSML_NAMESPACE

The DSML namespace

XSD_NAMESPACE

public static final org.dom4j.Namespace XSD_NAMESPACE

The XSD namespace

XSI_NAMESPACE

public static final org.dom4j.Namespace XSI_NAMESPACE

The XSI namespace

READ_SOAP_HEADER

public static final GrammarAction READ_SOAP_HEADER

GrammarAction that reads the SOAP header data

Method Detail

getXsiTypeAttributeValue

public static String getXsiTypeAttributeValue(org.xmlpull.v1.XmlPullParser xpp)

Returns the value of the attribute 'type' of the "XMLSchema-instance' namespace if it exists

Parameters:

xpp - the XPP parser to use

Returns:

the value of the attribute 'type' of the "XMLSchema-instance' namespace if it exists

isBase64BinaryValue

public static boolean isBase64BinaryValue(org.xmlpull.v1.XmlPullParser parser,
                                          String attrValue)

Tells is the given value is a Base64 binary value

Parameters:

parser - the XPP parser to use

attrValue - the attribute value

Returns:

true if the value of the current tag is Base64BinaryEncoded, false if not

needsBase64Encoding

public static boolean needsBase64Encoding(Object value)

Indicates if the value needs to be encoded as Base64

Parameters:

value - the value to check

Returns:

true if the value needs to be encoded as Base64

base64Encode

public static String base64Encode(Object value)

Encodes the value as a Base64 String

Parameters:

value - the value to encode

Returns:

the value encoded as a Base64 String

parseAndVerifyRequestID

public static int parseAndVerifyRequestID(String attributeValue,
                                          org.xmlpull.v1.XmlPullParser xpp)
                                   throws org.xmlpull.v1.XmlPullParserException

Parses and verify the parsed value of the requestID

Parameters:

attributeValue - the value of the attribute

xpp - the XmlPullParser

Returns:

the int value of the resquestID

Throws:

org.xmlpull.v1.XmlPullParserException - if RequestID isn't an Integer and if requestID is below 0

addControls

public static void addControls(LdapApiService codec,
                               org.dom4j.Element element,
                               Collection<Control> controls,
                               boolean isRequest)

Adds Controls to the given Element.

Parameters:

codec - The LDAP Service to use

element - the element to add the Controls to

controls - a List of Controls

isRequest - A flag set to true if teh LDapMessage is a request

isRequestIdNeeded

public static boolean isRequestIdNeeded(Dsmlv2Container container)
                                 throws org.xmlpull.v1.XmlPullParserException

Indicates if a request ID is needed.

Parameters:

container - the associated container

Returns:

true if a request ID is needed (ie Processing=Parallel and ResponseOrder=Unordered)

Throws:

org.xmlpull.v1.XmlPullParserException - if the batch request has not been parsed yet

styleDocument

public static org.dom4j.Document styleDocument(org.dom4j.Document document)

XML Pretty Printer XSLT Transformation

Parameters:

document - the Dom4j Document

Returns:

the transformed document