org.opensaml.xml.io

Interface Marshaller

All Known Implementing Classes:

AbstractElementExtensibleXMLObjectMarshaller, AbstractExtensibleXMLObjectMarshaller, AbstractXMLEncryptionMarshaller, AbstractXMLObjectMarshaller, AbstractXMLSignatureMarshaller, AgreementMethodMarshaller, BaseXMLObjectMarshaller, CipherDataMarshaller, CipherReferenceMarshaller, CryptoBinaryMarshaller, DataReferenceMarshaller, DEREncodedKeyValueMarshaller, DHKeyValueMarshaller, DigestMethodMarshaller, DSAKeyValueMarshaller, ECKeyValueMarshaller, EncryptedDataMarshaller, EncryptedKeyMarshaller, EncryptedTypeMarshaller, EncryptionMethodMarshaller, EncryptionPropertiesMarshaller, EncryptionPropertyMarshaller, KeyInfoMarshaller, KeyInfoReferenceMarshaller, KeyInfoTypeMarshaller, KeyReferenceMarshaller, KeyValueMarshaller, NamedCurveMarshaller, OriginatorKeyInfoMarshaller, PGPDataMarshaller, RecipientKeyInfoMarshaller, ReferenceListMarshaller, ReferenceTypeMarshaller, RetrievalMethodMarshaller, RSAKeyValueMarshaller, SignatureMarshaller, SPKIDataMarshaller, TransformMarshaller, TransformsMarshaller, TransformsMarshaller, X509DataMarshaller, X509DigestMarshaller, X509IssuerSerialMarshaller, X509SerialNumberMarshaller, XSAnyMarshaller, XSBase64BinaryMarshaller, XSBooleanMarshaller, XSDateTimeMarshaller, XSIntegerMarshaller, XSQNameMarshaller, XSStringMarshaller, XSURIMarshaller

public interface Marshaller

Marshallers are used to marshall a XMLObject into a W3C DOM element.

Method Summary

Methods

Modifier and Type	Method and Description
Element	marshall(XMLObject xmlObject) Marshall this element, and its children, and root them in a newly created Document.
Element	marshall(XMLObject xmlObject, Document document) Marshall this element, and its children, into a W3C DOM element.
Element	marshall(XMLObject xmlObject, Element parentElement) Marshall the given XMLObject and append it as a child to the given parent element.

Method Detail

marshall

Element marshall(XMLObject xmlObject)
                 throws MarshallingException

Marshall this element, and its children, and root them in a newly created Document. The Document is created by a DocumentBuilder obtained from a DocumentBuilderFactory created without any additional parameters or properties set; that is the system defaults properties are used.

Parameters:

xmlObject - the object to marshall

Returns:

the W3C DOM element representing this SAML element

Throws:

MarshallingException - thrown if there is a problem marshalling the given object

marshall

Element marshall(XMLObject xmlObject,
               Document document)
                 throws MarshallingException

Marshall this element, and its children, into a W3C DOM element. If the document does not have a Document Element the Element resulting from this marshalling will be set as the Document Element.

Parameters:

xmlObject - the object to marshall

document - the DOM document the marshalled element will be placed in

Returns:

the W3C DOM element representing this XMLObject

Throws:

MarshallingException - thrown if there is a problem marshalling the given object

marshall

Element marshall(XMLObject xmlObject,
               Element parentElement)
                 throws MarshallingException

Marshall the given XMLObject and append it as a child to the given parent element. NOTE: The given Element must be within a DOM tree whose root is the root of the Document owning the given Element.

Parameters:

xmlObject - the XMLObject to be marshalled

parentElement - the parent of the Element resulting from marshalling the given XMLObject

Returns:

the marshalled XMLObject

Throws:

MarshallingException - thrown if the given XMLObject can not be marshalled.