org.opensaml.saml.common

Class AbstractSignableSAMLObject

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.xmlsec.signature.AbstractSignableXMLObject

org.opensaml.saml.common.AbstractSignableSAMLObject

All Implemented Interfaces:

XMLObject, SAMLObject, SignableSAMLObject, SignableXMLObject

Direct Known Subclasses:

AffiliationDescriptorImpl, AssertionImpl, AssertionImpl, EntitiesDescriptorImpl, EntityDescriptorImpl, RequestAbstractTypeImpl, RequestAbstractTypeImpl, ResponseAbstractTypeImpl, RoleDescriptorImpl, StatusResponseTypeImpl

public abstract class AbstractSignableSAMLObject
extends AbstractSignableXMLObject
implements SignableSAMLObject

Abstract SAMLObject implementation that also implements SignableXMLObject.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSignableSAMLObject(java.lang.String namespaceURI, java.lang.String elementLocalName, java.lang.String namespacePrefix) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	hashCode()
protected org.joda.time.DateTime	prepareForAssignment(org.joda.time.DateTime oldValue, org.joda.time.DateTime newValue) A helper function for derived classes that checks to see if the old and new value are equal and if so releases the cached dom.
void	setSignature(Signature newSignature) Sets the Signature XMLObject.

Methods inherited from class org.opensaml.xmlsec.signature.AbstractSignableXMLObject

getSignature, isSigned

Methods inherited from class org.opensaml.core.xml.AbstractXMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.saml.common.SignableSAMLObject

getSignatureReferenceID

Methods inherited from interface org.opensaml.xmlsec.signature.SignableXMLObject

getSignature, isSigned

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Constructor Detail

AbstractSignableSAMLObject

protected AbstractSignableSAMLObject(@Nullable
                                     java.lang.String namespaceURI,
                                     @Nonnull @NotEmpty
                                     java.lang.String elementLocalName,
                                     @Nullable
                                     java.lang.String namespacePrefix)

Constructor.

Parameters:

namespaceURI - the namespace the element is in

elementLocalName - the local name of the XML element this Object represents

namespacePrefix - the prefix for the given namespace

Method Detail

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setSignature

public void setSignature(@Nullable
                         Signature newSignature)

Sets the Signature XMLObject. When a signature is added, a default content reference that uses the ID of this object will be created and added to the signature at the time of signing. See SAMLObjectContentReference for the default digest algorithm and transforms that will be used. These default values may be changed prior to marshalling this object.

Specified by:

setSignature in interface SignableXMLObject

Overrides:

setSignature in class AbstractSignableXMLObject

Parameters:

newSignature - the Signature XMLObject

prepareForAssignment

@Nullable
protected org.joda.time.DateTime prepareForAssignment(@Nullable
                                                                org.joda.time.DateTime oldValue,
                                                                @Nullable
                                                                org.joda.time.DateTime newValue)

A helper function for derived classes that checks to see if the old and new value are equal and if so releases the cached dom. Derived classes are expected to use this thus: this.foo = prepareForAssignment(this.foo, foo); This method will do a (null) safe compare of the objects and will also invalidate the DOM if appropriate

Parameters:

oldValue - - current value

newValue - - proposed new value

Returns:

The value to assign to the saved Object