org.opensaml.core.xml

Class XMLObjectBaseTestCase

java.lang.Object

org.opensaml.core.OpenSAMLInitBaseTestCase

org.opensaml.core.xml.XMLObjectBaseTestCase

Direct Known Subclasses:

AbstractXMLObjectTest, AttributeMapTest, ElementProxyTest, FilesystemLoadSaveManagerTest, IDAttributeTest, MapLoadSaveManagerTest, MarshallingTest, NamespaceManagerTest, UnmarshallingSecurityTest, UnmarshallingTest, XMLObjectProviderBaseTestCase, XMLObjectSupportTest, XMLObjectXSIAttribsTest, XSBase64BinaryTest, XSBooleanTest, XSDateTimeTest, XSIntegerTest, XSQNameTest, XSStringTest, XSURITest

public abstract class XMLObjectBaseTestCase
extends OpenSAMLInitBaseTestCase

Base test case class for tests that operate on XMLObjects.

Field Summary

Fields

Modifier and Type	Field and Description
private static Calendar	baseline Baseline for duration calculations (comes from XML Schema standard).
protected static org.opensaml.core.xml.XMLObjectBuilderFactory	builderFactory XMLObject builder factory
private org.slf4j.Logger	log Logger
protected static org.opensaml.core.xml.io.MarshallerFactory	marshallerFactory XMLObject marshaller factory
protected static ParserPool	parserPool Parser pool
protected static QName	simpleXMLObjectQName QName for SimpleXMLObject
protected static org.opensaml.core.xml.io.UnmarshallerFactory	unmarshallerFactory XMLObject unmarshaller factory

Constructor Summary

Constructors

Constructor and Description
XMLObjectBaseTestCase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertXMLEquals(Document expectedDOM, org.opensaml.core.xml.XMLObject xmlObject) Asserts a given XMLObject is equal to an expected DOM.
protected void	assertXMLEquals(String failMessage, Document expectedDOM, org.opensaml.core.xml.XMLObject xmlObject) Asserts a given XMLObject is equal to an expected DOM.
protected <T extends org.opensaml.core.xml.XMLObject> T	buildXMLObject(QName name) Builds the requested XMLObject.
static long	fetchDuration(Element element, QName name) Helper method to extract the value of an XML duration attribute in milliseconds.
protected <T extends org.opensaml.core.xml.XMLObject> org.opensaml.core.xml.XMLObjectBuilder<T>	getBuilder(QName qname) Lookup the XMLObjectBuilder for a QName.
protected org.opensaml.core.xml.io.Marshaller	getMarshaller(QName qname) Lookup the marshaller for a QName
protected org.opensaml.core.xml.io.Marshaller	getMarshaller(org.opensaml.core.xml.XMLObject xmlObject) Lookup the marshaller for an XMLObject.
protected org.opensaml.core.xml.io.Unmarshaller	getUnmarshaller(Element element) Lookup the unmarshaller for a DOM Element.
protected org.opensaml.core.xml.io.Unmarshaller	getUnmarshaller(QName qname) Lookup the unmarshaller for a QName.
protected org.opensaml.core.xml.io.Unmarshaller	getUnmarshaller(org.opensaml.core.xml.XMLObject xmlObject) Lookup the unmarshaller for an XMLObject.
protected void	initXMLObjectSupport()
protected Document	parseXMLDocument(String xmlFilename) Parse an XML file as a classpath resource.
protected void	printXML(Node node, String filename) For convenience when testing, pretty-print the specified DOM node to a file, or to the console if filename is null.
protected void	printXML(org.opensaml.core.xml.XMLObject xmlObject, String filename) For convenience when testing, pretty-print the specified XMLObject to a file, or to the console if filename is null.
protected <T extends org.opensaml.core.xml.XMLObject> T	unmarshallElement(String elementFile) Unmarshalls an element file into its XMLObject.
protected <T extends org.opensaml.core.xml.XMLObject> T	unmarshallElement(String elementFile, boolean propagateErrors) Unmarshalls an element file into its XMLObject.

Methods inherited from class org.opensaml.core.OpenSAMLInitBaseTestCase

initOpenSAML

Methods inherited from class java.lang.Object

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

Field Detail

log

private final org.slf4j.Logger log

Logger

parserPool

protected static ParserPool parserPool

Parser pool

builderFactory

protected static org.opensaml.core.xml.XMLObjectBuilderFactory builderFactory

XMLObject builder factory

marshallerFactory

protected static org.opensaml.core.xml.io.MarshallerFactory marshallerFactory

XMLObject marshaller factory

unmarshallerFactory

protected static org.opensaml.core.xml.io.UnmarshallerFactory unmarshallerFactory

XMLObject unmarshaller factory

simpleXMLObjectQName

protected static QName simpleXMLObjectQName

QName for SimpleXMLObject

baseline

private static Calendar baseline

Baseline for duration calculations (comes from XML Schema standard).

Constructor Detail

XMLObjectBaseTestCase

public XMLObjectBaseTestCase()

Method Detail

fetchDuration

public static long fetchDuration(@Nonnull
                 Element element,
                 @Nonnull
                 QName name)
                          throws DatatypeConfigurationException

Helper method to extract the value of an XML duration attribute in milliseconds.

Parameters:

element - element to pull attribute from

name - name of attribute

Returns:

the attribute value converted to milliseconds

Throws:

DatatypeConfigurationException - if a DatatypeFactory can't be constructed

initXMLObjectSupport

protected void initXMLObjectSupport()
                             throws Exception

Throws:

Exception

assertXMLEquals

protected void assertXMLEquals(Document expectedDOM,
                   org.opensaml.core.xml.XMLObject xmlObject)

Asserts a given XMLObject is equal to an expected DOM. The XMLObject is marshalled and the resulting DOM object is compared against the expected DOM object for equality.

Parameters:

expectedDOM - the expected DOM

xmlObject - the XMLObject to be marshalled and compared against the expected DOM

assertXMLEquals

protected void assertXMLEquals(String failMessage,
                   Document expectedDOM,
                   org.opensaml.core.xml.XMLObject xmlObject)

Asserts a given XMLObject is equal to an expected DOM. The XMLObject is marshalled and the resulting DOM object is compared against the expected DOM object for equality.

Parameters:

failMessage - the message to display if the DOMs are not equal

expectedDOM - the expected DOM

xmlObject - the XMLObject to be marshalled and compared against the expected DOM

buildXMLObject

protected <T extends org.opensaml.core.xml.XMLObject> T buildXMLObject(QName name)

Builds the requested XMLObject.

Parameters:

name - name of the XMLObject

Returns:

the build XMLObject

unmarshallElement

protected <T extends org.opensaml.core.xml.XMLObject> T unmarshallElement(String elementFile)

Unmarshalls an element file into its XMLObject.

Returns:

the XMLObject from the file

unmarshallElement

protected <T extends org.opensaml.core.xml.XMLObject> T unmarshallElement(String elementFile,
                                                              boolean propagateErrors)
                                                               throws XMLParserException,
                                                                      org.opensaml.core.xml.io.UnmarshallingException

Unmarshalls an element file into its XMLObject.

Parameters:

propagateErrors - if true, checked exceptions will be thrown, if false then they cause assertion of test failure

Returns:

the XMLObject from the file

Throws:

XMLParserException

org.opensaml.core.xml.io.UnmarshallingException

printXML

protected void printXML(Node node,
            String filename)

For convenience when testing, pretty-print the specified DOM node to a file, or to the console if filename is null.

printXML

protected void printXML(org.opensaml.core.xml.XMLObject xmlObject,
            String filename)

For convenience when testing, pretty-print the specified XMLObject to a file, or to the console if filename is null.

getBuilder

protected <T extends org.opensaml.core.xml.XMLObject> org.opensaml.core.xml.XMLObjectBuilder<T> getBuilder(QName qname)

Lookup the XMLObjectBuilder for a QName.

Parameters:

qname - the QName for which to find the builder

Returns:

the XMLObjectBuilder

getMarshaller

protected org.opensaml.core.xml.io.Marshaller getMarshaller(QName qname)

Lookup the marshaller for a QName

Parameters:

qname - the QName for which to find the marshaller

Returns:

the marshaller

getMarshaller

protected org.opensaml.core.xml.io.Marshaller getMarshaller(org.opensaml.core.xml.XMLObject xmlObject)

Lookup the marshaller for an XMLObject.

Parameters:

xmlObject - the XMLObject for which to find the marshaller

Returns:

the marshaller

getUnmarshaller

protected org.opensaml.core.xml.io.Unmarshaller getUnmarshaller(QName qname)

Lookup the unmarshaller for a QName.

Parameters:

qname - the QName for which to find the unmarshaller

Returns:

the unmarshaller

getUnmarshaller

protected org.opensaml.core.xml.io.Unmarshaller getUnmarshaller(org.opensaml.core.xml.XMLObject xmlObject)

Lookup the unmarshaller for an XMLObject.

Parameters:

xmlObject - the XMLObject for which to find the unmarshaller

Returns:

the unmarshaller

getUnmarshaller

protected org.opensaml.core.xml.io.Unmarshaller getUnmarshaller(Element element)

Lookup the unmarshaller for a DOM Element.

Parameters:

element - the Element for which to find the unmarshaller

Returns:

the unmarshaller

parseXMLDocument

protected Document parseXMLDocument(String xmlFilename)
                             throws XMLParserException

Parse an XML file as a classpath resource.

Parameters:

xmlFilename - the file to parse

Returns:

the parsed Document

Throws:

XMLParserException - if parsing did not succeed