org.opensaml.common.impl
Class AbstractSAMLObjectMarshaller

java.lang.Object
  extended by org.opensaml.xml.io.AbstractXMLObjectMarshaller
      extended by org.opensaml.common.impl.AbstractSAMLObjectMarshaller
All Implemented Interfaces:
Marshaller
Direct Known Subclasses:
AbstractNameIDTypeMarshaller, ActionMarshaller, ActionMarshaller, ActionNamespaceMarshaller, AdditionalMetadataLocationMarshaller, AdviceMarshaller, AdviceMarshaller, AffiliateMemberMarshaller, AffiliationDescriptorMarshaller, ArtifactMarshaller, AssertionArtifactMarshaller, AssertionIDReferenceMarshaller, AssertionIDRefMarshaller, AssertionMarshaller, AssertionMarshaller, AssertionURIRefMarshaller, AttributeConsumingServiceMarshaller, AttributeDesignatorMarshaller, AttributeMarshaller, AttributeProfileMarshaller, AttributeStatementMarshaller, AudienceMarshaller, AudienceMarshaller, AudienceRestrictionConditionMarshaller, AudienceRestrictionMarshaller, AuthenticatingAuthorityMarshaller, AuthnContextClassRefMarshaller, AuthnContextDeclMarshaller, AuthnContextDeclRefMarshaller, AuthnContextMarshaller, AuthnStatementMarshaller, AuthorityBindingMarshaller, AuthzDecisionStatementMarshaller, BaseIDMarshaller, CompanyMarshaller, ConditionsMarshaller, ConditionsMarshaller, ConfirmationMethodMarshaller, ContactPersonMarshaller, DoNotCacheConditionMarshaller, EmailAddressMarshaller, EncryptedElementTypeMarshaller, EndpointMarshaller, EntitiesDescriptorMarshaller, EntityDescriptorMarshaller, EvidenceMarshaller, EvidenceMarshaller, GetCompleteMarshaller, GivenNameMarshaller, IDPEntryMarshaller, IDPListMarshaller, KeyDescriptorMarshaller, NameIdentifierMarshaller, NameIDFormatMarshaller, NameIDPolicyMarshaller, NewIDMarshaller, OneTimeUseMarshaller, OrganizationDisplayNameMarshaller, OrganizationMarshaller, OrganizationNameMarshaller, OrganizationURLMarshaller, ProxyRestrictionMarshaller, QueryDescriptorTypeMarshaller, RequestAbstractTypeMarshaller, RequestAbstractTypeMarshaller, RequestedAuthnContextMarshaller, RequesterIDMarshaller, ResponseAbstractTypeMarshaller, RoleDescriptorMarshaller, ScopingMarshaller, ServiceDescriptionMarshaller, ServiceNameMarshaller, SessionIndexMarshaller, SourceIDMarshaller, StatusCodeMarshaller, StatusCodeMarshaller, StatusDetailMarshaller, StatusDetailMarshaller, StatusMarshaller, StatusMarshaller, StatusMessageMarshaller, StatusMessageMarshaller, StatusResponseTypeMarshaller, SubjectConfirmationDataMarshaller, SubjectConfirmationMarshaller, SubjectConfirmationMarshaller, SubjectLocalityMarshaller, SubjectLocalityMarshaller, SubjectMarshaller, SubjectMarshaller, SubjectQueryMarshaller, SubjectStatementMarshaller, SurNameMarshaller, TelephoneNumberMarshaller, TerminateMarshaller

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
protected AbstractSAMLObjectMarshaller(java.lang.String targetNamespaceURI, java.lang.String targetLocalName)
          Constructor.
 
Method Summary
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.xml.io.AbstractXMLObjectMarshaller
checkXMLObjectIsTarget, marshall, marshall, marshall, marshallChildElements, marshallInto, marshallNamespacePrefix, marshallNamespaces, marshallSchemaInstanceAttributes, setDocumentElement
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractSAMLObjectMarshaller

protected AbstractSAMLObjectMarshaller(java.lang.String targetNamespaceURI,
                                       java.lang.String targetLocalName)
Constructor.

Parameters:
targetNamespaceURI - the namespace URI of either the schema type QName or element QName of the elements this unmarshaller operates on
targetLocalName - the local name of either the schema type QName or element QName of the elements this unmarshaller operates on
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.

Specified by:
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.

Specified by:
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