org.opensaml.core.xml.io

Interface Marshaller

All Known Implementing Classes:

AbstractElementExtensibleXMLObjectMarshaller, AbstractExtensibleXMLObjectMarshaller, AbstractNameIDTypeMarshaller, AbstractSAMLObjectMarshaller, AbstractXACMLObjectMarshaller, AbstractXMLEncryptionMarshaller, AbstractXMLObjectMarshaller, AbstractXMLSignatureMarshaller, ActionMarshaller, ActionMarshaller, ActionMatchTypeMarshaller, ActionNamespaceMarshaller, ActionsTypeMarshaller, ActionTypeMarshaller, ActionTypeMarshaller, AdditionalMetadataLocationMarshaller, AdviceMarshaller, AdviceMarshaller, AffiliateMemberMarshaller, AffiliationDescriptorMarshaller, AgreementMethodMarshaller, AlgorithmIdentifierTypeMarshaller, ApplyTypeMarshaller, ArtifactMarshaller, ArtifactResolutionServiceMarshaller, ArtifactResolveMarshaller, ArtifactResponseMarshaller, AssertionArtifactMarshaller, AssertionConsumerServiceMarshaller, AssertionIDReferenceMarshaller, AssertionIDRefMarshaller, AssertionIDRequestMarshaller, AssertionIDRequestServiceMarshaller, AssertionMarshaller, AssertionMarshaller, AssertionURIRefMarshaller, AsynchronousMarshaller, AttributeAssignmentTypeMarshaller, AttributeAuthorityDescriptorMarshaller, AttributeConsumingServiceMarshaller, AttributeDesignatorMarshaller, AttributeDesignatorTypeMarshaller, AttributeMarshaller, AttributeMarshaller, AttributeProfileMarshaller, AttributeQueryDescriptorTypeMarshaller, AttributeQueryMarshaller, AttributeQueryMarshaller, AttributeSelectorTypeMarshaller, AttributeServiceMarshaller, AttributeStatementMarshaller, AttributeStatementMarshaller, AttributeTypeMarshaller, AttributeValueTypeMarshaller, AttributeValueTypeMarshaller, AudienceMarshaller, AudienceMarshaller, AudienceRestrictionConditionMarshaller, AudienceRestrictionMarshaller, AuthenticatingAuthorityMarshaller, AuthenticationQueryMarshaller, AuthenticationStatementMarshaller, AuthnAuthorityDescriptorMarshaller, AuthnContextClassRefMarshaller, AuthnContextDeclMarshaller, AuthnContextDeclRefMarshaller, AuthnContextMarshaller, AuthnQueryDescriptorTypeMarshaller, AuthnQueryMarshaller, AuthnQueryServiceMarshaller, AuthnRequestMarshaller, AuthnStatementMarshaller, AuthorityBindingMarshaller, AuthorizationDecisionQueryMarshaller, AuthorizationDecisionStatementMarshaller, AuthzDecisionQueryDescriptorTypeMarshaller, AuthzDecisionQueryMarshaller, AuthzDecisionStatementMarshaller, AuthzServiceMarshaller, BaseIDMarshaller, BaseXMLObjectMarshaller, ChannelBindingsMarshaller, CipherDataMarshaller, CipherReferenceMarshaller, CombinerParametersTypeMarshaller, CombinerParameterTypeMarshaller, CompanyMarshaller, ConditionsMarshaller, ConditionsMarshaller, ConditionTypeMarshaller, ConfirmationMethodMarshaller, ContactPersonMarshaller, CryptoBinaryMarshaller, DataReferenceMarshaller, DecisionTypeMarshaller, DefaultsTypeMarshaller, DelegateMarshaller, DelegationRestrictionTypeMarshaller, DEREncodedKeyValueMarshaller, DescriptionMarshaller, DescriptionTypeMarshaller, DHKeyValueMarshaller, DigestMethodMarshaller, DigestMethodMarshaller, DiscoHintsMarshaller, DiscoveryResponseMarshaller, DisplayNameMarshaller, DomainHintMarshaller, DoNotCacheConditionMarshaller, DSAKeyValueMarshaller, ECKeyValueMarshaller, EmailAddressMarshaller, EncryptedAssertionMarshaller, EncryptedAttributeMarshaller, EncryptedDataMarshaller, EncryptedElementTypeMarshaller, EncryptedIDMarshaller, EncryptedKeyMarshaller, EncryptedTypeMarshaller, EncryptionMethodMarshaller, EncryptionMethodMarshaller, EncryptionPropertiesMarshaller, EncryptionPropertyMarshaller, EndpointMarshaller, EntitiesDescriptorMarshaller, EntityAttributesMarshaller, EntityDescriptorMarshaller, EnvironmentMatchTypeMarshaller, EnvironmentsTypeMarshaller, EnvironmentTypeMarshaller, EnvironmentTypeMarshaller, EvidenceMarshaller, EvidenceMarshaller, ExtensionsMarshaller, ExtensionsMarshaller, FunctionTypeMarshaller, GeneratedKeyMarshaller, GeolocationHintMarshaller, GetCompleteMarshaller, GivenNameMarshaller, IDPEntryMarshaller, IDPListMarshaller, IDPSSODescriptorMarshaller, IdReferenceTypeMarshaller, IndexedEndpointMarshaller, InformationURLMarshaller, IPHintMarshaller, IssuerMarshaller, KeyDescriptorMarshaller, KeyInfoMarshaller, KeyInfoReferenceMarshaller, KeyReferenceMarshaller, KeyValueMarshaller, KeywordsMarshaller, LocalizedNameMarshaller, LocalizedURIMarshaller, LogoMarshaller, LogoutRequestMarshaller, LogoutResponseMarshaller, ManageNameIDRequestMarshaller, ManageNameIDResponseMarshaller, ManageNameIDServiceMarshaller, MGFMarshaller, MissingAttributeDetailTypeMarshaller, NamedCurveMarshaller, NameIdentifierMarshaller, NameIDFormatMarshaller, NameIDMappingRequestMarshaller, NameIDMappingResponseMarshaller, NameIDMappingServiceMarshaller, NameIDMarshaller, NameIDPolicyMarshaller, NewEncryptedIDMarshaller, NewIDMarshaller, ObligationsTypeMarshaller, ObligationTypeMarshaller, OneTimeUseMarshaller, OrganizationDisplayNameMarshaller, OrganizationMarshaller, OrganizationNameMarshaller, OrganizationURLMarshaller, OriginatorKeyInfoMarshaller, PDPDescriptorMarshaller, PGPDataMarshaller, PolicyCombinerParametersTypeMarshaller, PolicySetCombinerParametersTypeMarshaller, PolicySetTypeMarshaller, PolicyTypeMarshaller, PrivacyStatementURLMarshaller, ProxyRestrictionMarshaller, PublicationInfoMarshaller, PublicationMarshaller, PublicationPathMarshaller, QueryDescriptorTypeMarshaller, RecipientKeyInfoMarshaller, ReferencedPoliciesTypeMarshaller, ReferenceListMarshaller, ReferenceTypeMarshaller, RegistrationInfoMarshaller, RegistrationPolicyMarshaller, RelayStateMarshaller, RequestAbstractTypeMarshaller, RequestAbstractTypeMarshaller, RequestAuthenticatedMarshaller, RequestedAttributeMarshaller, RequestedAuthnContextMarshaller, RequesterIDMarshaller, RequestInitiatorMarshaller, RequestMarshaller, RequestMarshaller, RequestTypeMarshaller, ResourceContentTypeMarshaller, ResourceMatchTypeMarshaller, ResourcesTypeMarshaller, ResourceTypeMarshaller, ResourceTypeMarshaller, RespondToMarshaller, ResponseAbstractTypeMarshaller, ResponseMarshaller, ResponseMarshaller, ResponseMarshaller, ResponseTypeMarshaller, ResultTypeMarshaller, RetrievalMethodMarshaller, RoleDescriptorMarshaller, RSAKeyValueMarshaller, RuleCombinerParametersTypeMarshaller, RuleTypeMarshaller, ScopingMarshaller, ServiceDescriptionMarshaller, ServiceNameMarshaller, SessionIndexMarshaller, SessionKeyMarshaller, SignatureMarshaller, SigningMethodMarshaller, SingleLogoutServiceMarshaller, SingleSignOnServiceMarshaller, SPKIDataMarshaller, SPSSODescriptorMarshaller, SSODescriptorMarshaller, StatusCodeMarshaller, StatusCodeMarshaller, StatusCodeTypeMarshaller, StatusDetailMarshaller, StatusDetailMarshaller, StatusDetailTypeMarshaller, StatusMarshaller, StatusMarshaller, StatusMessageMarshaller, StatusMessageMarshaller, StatusMessageTypeMarshaller, StatusResponseTypeMarshaller, StatusTypeMarshaller, SubjectAttributeDesignatorTypeMarshaller, SubjectConfirmationDataMarshaller, SubjectConfirmationMarshaller, SubjectConfirmationMarshaller, SubjectConfirmationMarshaller, SubjectLocalityMarshaller, SubjectLocalityMarshaller, SubjectMarshaller, SubjectMarshaller, SubjectMatchTypeMarshaller, SubjectQueryMarshaller, SubjectQueryMarshaller, SubjectStatementMarshaller, SubjectsTypeMarshaller, SubjectTypeMarshaller, SubjectTypeMarshaller, SurNameMarshaller, TargetTypeMarshaller, TelephoneNumberMarshaller, TerminateMarshaller, TransformMarshaller, TransformsMarshaller, TransformsMarshaller, UIInfoMarshaller, UsagePolicyMarshaller, VariableDefinitionTypeMarshaller, VariableReferenceTypeMarshaller, X509DataMarshaller, X509DigestMarshaller, X509IssuerSerialMarshaller, X509SerialNumberMarshaller, XACMLAuthzDecisionQueryTypeMarshaller, XACMLAuthzDecisionStatementTypeMarshaller, XACMLPolicyQueryTypeMarshaller, XACMLPolicyStatementTypeMarshaller, 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

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

@Nonnull
Element marshall(@Nonnull
                          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

@Nonnull
Element marshall(@Nonnull
                          XMLObject xmlObject,
                          @Nonnull
                          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

@Nonnull
Element marshall(@Nonnull
                          XMLObject xmlObject,
                          @Nonnull
                          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.