org.opensaml.saml.common

Class AbstractSAMLObjectMarshaller

java.lang.Object

org.opensaml.core.xml.io.AbstractXMLObjectMarshaller

org.opensaml.saml.common.AbstractSAMLObjectMarshaller

All Implemented Interfaces:

Marshaller

Direct Known Subclasses:

AbstractNameIDTypeMarshaller, ActionMarshaller, ActionMarshaller, ActionNamespaceMarshaller, AdditionalMetadataLocationMarshaller, AdviceMarshaller, AdviceMarshaller, AffiliateMemberMarshaller, AffiliationDescriptorMarshaller, ArtifactMarshaller, AssertionArtifactMarshaller, AssertionIDReferenceMarshaller, AssertionIDRefMarshaller, AssertionMarshaller, AssertionMarshaller, AssertionURIRefMarshaller, AsynchronousMarshaller, AttributeConsumingServiceMarshaller, AttributeDesignatorMarshaller, AttributeMarshaller, AttributeProfileMarshaller, AttributeStatementMarshaller, AudienceMarshaller, AudienceMarshaller, AudienceRestrictionConditionMarshaller, AudienceRestrictionMarshaller, AuthenticatingAuthorityMarshaller, AuthnContextClassRefMarshaller, AuthnContextDeclMarshaller, AuthnContextDeclRefMarshaller, AuthnContextMarshaller, AuthnStatementMarshaller, AuthorityBindingMarshaller, AuthzDecisionStatementMarshaller, BaseIDMarshaller, CompanyMarshaller, ConditionsMarshaller, ConditionsMarshaller, ConfirmationMethodMarshaller, ContactPersonMarshaller, DelegateMarshaller, DelegationRestrictionTypeMarshaller, DigestMethodMarshaller, DiscoHintsMarshaller, DomainHintMarshaller, DoNotCacheConditionMarshaller, EmailAddressMarshaller, EncryptedElementTypeMarshaller, EndpointMarshaller, EntitiesDescriptorMarshaller, EntityAttributesMarshaller, EntityDescriptorMarshaller, EvidenceMarshaller, EvidenceMarshaller, ExtensionsMarshaller, ExtensionsMarshaller, GeolocationHintMarshaller, GetCompleteMarshaller, GivenNameMarshaller, IDPEntryMarshaller, IDPListMarshaller, IPHintMarshaller, KeyDescriptorMarshaller, KeywordsMarshaller, LocalizedNameMarshaller, LocalizedURIMarshaller, LogoMarshaller, NameIdentifierMarshaller, NameIDFormatMarshaller, NameIDPolicyMarshaller, NewIDMarshaller, OneTimeUseMarshaller, OrganizationMarshaller, ProxyRestrictionMarshaller, PublicationInfoMarshaller, PublicationMarshaller, PublicationPathMarshaller, ReferencedPoliciesTypeMarshaller, RegistrationInfoMarshaller, RequestAbstractTypeMarshaller, RequestAbstractTypeMarshaller, RequestAuthenticatedMarshaller, RequestedAuthnContextMarshaller, RequesterIDMarshaller, RequestMarshaller, ResponseAbstractTypeMarshaller, ResponseMarshaller, RoleDescriptorMarshaller, ScopingMarshaller, SessionIndexMarshaller, SessionKeyMarshaller, SigningMethodMarshaller, StatusCodeMarshaller, StatusCodeMarshaller, StatusDetailMarshaller, StatusDetailMarshaller, StatusMarshaller, StatusMarshaller, StatusMessageMarshaller, StatusMessageMarshaller, StatusResponseTypeMarshaller, SubjectConfirmationDataMarshaller, SubjectConfirmationMarshaller, SubjectConfirmationMarshaller, SubjectConfirmationMarshaller, SubjectLocalityMarshaller, SubjectLocalityMarshaller, SubjectMarshaller, SubjectMarshaller, SubjectQueryMarshaller, SubjectStatementMarshaller, SurNameMarshaller, TelephoneNumberMarshaller, TerminateMarshaller, UIInfoMarshaller, XACMLAuthzDecisionStatementTypeMarshaller, XACMLPolicyStatementTypeMarshaller

public abstract class AbstractSAMLObjectMarshaller
extends AbstractXMLObjectMarshaller

A thread safe, abstract implementation of the Marshaller interface that handles most of the boilerplate code for Marshallers.

Constructor Summary

Constructors

Constructor and Description
AbstractSAMLObjectMarshaller()

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Element	marshall(XMLObject xmlObject, org.w3c.dom.Document document) Marshall this element, and its children, into a W3C DOM element.
org.w3c.dom.Element	marshall(XMLObject xmlObject, org.w3c.dom.Element parentElement) Marshall the given XMLObject and append it as a child to the given parent element.
protected void	marshallAttributes(XMLObject xmlObject, org.w3c.dom.Element domElement) No-op method.
protected void	marshallElementContent(XMLObject xmlObject, org.w3c.dom.Element domElement) No-op method.

Methods inherited from class org.opensaml.core.xml.io.AbstractXMLObjectMarshaller

marshall, marshallChildElements, marshallInto, marshallNamespacePrefix, marshallNamespaces, marshallSchemaInstanceAttributes, marshallUnknownAttributes, setDocumentElement

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSAMLObjectMarshaller

public AbstractSAMLObjectMarshaller()

Method Detail

marshallAttributes

protected void marshallAttributes(XMLObject xmlObject,
                                  org.w3c.dom.Element domElement)
                           throws MarshallingException

No-op method. Extending implementations should override this method if they have attributes to marshall into the Element. Marshalls a given XMLObject into a W3C Element. The given signing context should be blindly passed to the marshaller for child elements. The XMLObject passed to this method is guaranteed to be of the target name specified during this unmarshaller's construction. This default implementation of this method is a no-op

Overrides:

marshallAttributes in class AbstractXMLObjectMarshaller

Parameters:

xmlObject - the XMLObject to marshall

domElement - the W3C DOM element

Throws:

MarshallingException - thrown if there is a problem marshalling the element

marshallElementContent

protected void marshallElementContent(XMLObject xmlObject,
                                      org.w3c.dom.Element domElement)
                               throws MarshallingException

No-op method. Extending implementations should override this method if they have text content to marshall into the Element. Marshalls data from the XMLObject into content of the DOM Element. The default implementation of this method is a no-op.

Overrides:

marshallElementContent in class AbstractXMLObjectMarshaller

Parameters:

xmlObject - the XMLObject

domElement - the DOM element recieving the content

Throws:

MarshallingException - thrown if the textual content can not be added to the DOM element

marshall

public org.w3c.dom.Element marshall(XMLObject xmlObject,
                                    org.w3c.dom.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.

Specified by:

marshall in interface Marshaller

Overrides:

marshall in class AbstractXMLObjectMarshaller

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

public org.w3c.dom.Element marshall(XMLObject xmlObject,
                                    org.w3c.dom.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.

Specified by:

marshall in interface Marshaller

Overrides:

marshall in class AbstractXMLObjectMarshaller

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.