org.opensaml.xml.io
Interface Marshaller

All Known Implementing Classes:
AbstractNameIDTypeMarshaller, AbstractSAMLObjectMarshaller, AbstractXMLEncryptionMarshaller, AbstractXMLObjectMarshaller, AbstractXMLSignatureMarshaller, ActionMarshaller, ActionMarshaller, ActionNamespaceMarshaller, AdditionalMetadataLocationMarshaller, AdviceMarshaller, AdviceMarshaller, AffiliateMemberMarshaller, AffiliationDescriptorMarshaller, AgreementMethodMarshaller, ArtifactMarshaller, ArtifactResolutionServiceMarshaller, ArtifactResolveMarshaller, ArtifactResponseMarshaller, AssertionArtifactMarshaller, AssertionConsumerServiceMarshaller, AssertionIDReferenceMarshaller, AssertionIDRefMarshaller, AssertionIDRequestMarshaller, AssertionIDRequestServiceMarshaller, AssertionMarshaller, AssertionMarshaller, AssertionURIRefMarshaller, AttributeAuthorityDescriptorMarshaller, AttributeConsumingServiceMarshaller, AttributeDesignatorMarshaller, AttributeMarshaller, AttributeMarshaller, AttributeProfileMarshaller, AttributeQueryDescriptorMarshaller, AttributeQueryMarshaller, AttributeQueryMarshaller, AttributeServiceMarshaller, AttributeStatementMarshaller, AttributeStatementMarshaller, AudienceMarshaller, AudienceMarshaller, AudienceRestrictionConditionMarshaller, AudienceRestrictionMarshaller, AuthenticatingAuthorityMarshaller, AuthenticationQueryMarshaller, AuthenticationStatementMarshaller, AuthnAuthorityDescriptorMarshaller, AuthnContextClassRefMarshaller, AuthnContextDeclMarshaller, AuthnContextDeclRefMarshaller, AuthnContextMarshaller, AuthnQueryDescriptorMarshaller, AuthnQueryMarshaller, AuthnQueryServiceMarshaller, AuthnRequestMarshaller, AuthnStatementMarshaller, AuthorityBindingMarshaller, AuthorizationDecisionQueryMarshaller, AuthorizationDecisionStatementMarshaller, AuthzDecisionQueryDescriptorMarshaller, AuthzDecisionQueryMarshaller, AuthzDecisionStatementMarshaller, AuthzServiceMarshaller, BaseIDMarshaller, BodyMarshaller, CipherDataMarshaller, CipherReferenceMarshaller, CompanyMarshaller, ConditionsMarshaller, ConditionsMarshaller, ConfirmationMethodMarshaller, ContactPersonMarshaller, CryptoBinaryMarshaller, DataReferenceMarshaller, DetailMarshaller, DoNotCacheConditionMarshaller, DSAKeyValueMarshaller, ElementProxyMarshaller, EmailAddressMarshaller, EncryptedAssertionMarshaller, EncryptedAttributeMarshaller, EncryptedDataMarshaller, EncryptedElementTypeMarshaller, EncryptedIDMarshaller, EncryptedKeyMarshaller, EncryptedTypeMarshaller, EncryptionMethodMarshaller, EncryptionMethodMarshaller, EncryptionPropertiesMarshaller, EncryptionPropertyMarshaller, EndpointMarshaller, EntitiesDescriptorMarshaller, EntityDescriptorMarshaller, EnvelopeMarshaller, EvidenceMarshaller, EvidenceMarshaller, ExtensionsMarshaller, FaultMarshaller, GetCompleteMarshaller, GivenNameMarshaller, HeaderMarshaller, IDPEntryMarshaller, IDPListMarshaller, IDPSSODescriptorMarshaller, IndexedEndpointMarshaller, IssuerMarshaller, KeyDescriptorMarshaller, KeyInfoMarshaller, KeyInfoTypeMarshaller, KeyReferenceMarshaller, KeyValueMarshaller, LogoutRequestMarshaller, LogoutResponseMarshaller, ManageNameIDRequestMarshaller, ManageNameIDResponseMarshaller, ManageNameIDServiceMarshaller, NameIdentifierMarshaller, NameIDFormatMarshaller, NameIDMappingRequestMarshaller, NameIDMappingResponseMarshaller, NameIDMappingServiceMarshaller, NameIDMarshaller, NameIDPolicyMarshaller, NewEncryptedIDMarshaller, NewIDMarshaller, OneTimeUseMarshaller, OrganizationDisplayNameMarshaller, OrganizationMarshaller, OrganizationNameMarshaller, OrganizationURLMarshaller, OriginatorKeyInfoMarshaller, PDPDescriptorMarshaller, PGPDataMarshaller, ProxyRestrictionMarshaller, QueryDescriptorTypeMarshaller, RecipientKeyInfoMarshaller, ReferenceListMarshaller, ReferenceTypeMarshaller, RequestAbstractTypeMarshaller, RequestAbstractTypeMarshaller, RequestedAttributeMarshaller, RequestedAuthnContextMarshaller, RequesterIDMarshaller, RequestMarshaller, RespondToMarshaller, ResponseAbstractTypeMarshaller, ResponseMarshaller, ResponseMarshaller, RetrievalMethodMarshaller, RoleDescriptorMarshaller, RSAKeyValueMarshaller, ScopingMarshaller, ServiceDescriptionMarshaller, ServiceNameMarshaller, SessionIndexMarshaller, SignatureMarshaller, SingleLogoutServiceMarshaller, SingleSignOnServiceMarshaller, SourceIDMarshaller, SPKIDataMarshaller, SPSSODescriptorMarshaller, SSODescriptorMarshaller, StatusCodeMarshaller, StatusCodeMarshaller, StatusDetailMarshaller, StatusDetailMarshaller, StatusMarshaller, StatusMarshaller, StatusMessageMarshaller, StatusMessageMarshaller, StatusResponseTypeMarshaller, SubjectConfirmationDataMarshaller, SubjectConfirmationMarshaller, SubjectConfirmationMarshaller, SubjectLocalityMarshaller, SubjectLocalityMarshaller, SubjectMarshaller, SubjectMarshaller, SubjectQueryMarshaller, SubjectQueryMarshaller, SubjectStatementMarshaller, SurNameMarshaller, TelephoneNumberMarshaller, TerminateMarshaller, TransformMarshaller, TransformsMarshaller, TransformsMarshaller, X509DataMarshaller, X509IssuerSerialMarshaller, X509SerialNumberMarshaller, XSBase64BinaryMarshaller, XSIntegerMarshaller, XSQNameMarshaller, XSStringMarshaller, XSURIMarshaller

public interface Marshaller

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


Method Summary
 org.w3c.dom.Element marshall(XMLObject xmlObject)
          Marshall this element, and its children, and root them in a newly created Document.
 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.
 

Method Detail

marshall

org.w3c.dom.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

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.

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

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.

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.