|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.SAMLObject
org.opensaml.SAMLSignedObject
Abstract base class for all SAML objects that can be signed
Field Summary |
Fields inherited from class org.opensaml.SAMLObject |
config, log, root |
Constructor Summary | |
SAMLSignedObject()
|
Method Summary | |
protected java.lang.Object |
clone()
Copies a SAML object such that no dependencies exist between the original and the copy. |
void |
fromDOM(org.w3c.dom.Element e)
Initialization of an object from a DOM element |
abstract java.lang.String |
getId()
Gets the ID of the signed object |
java.lang.Object |
getNativeSignature()
Debugging aid to access the internal XML Signature implementation |
java.lang.String |
getSignatureAlgorithm()
Returns the algorithm identifier from the signature |
protected org.w3c.dom.Element |
getSignatureElement()
Get the DOM element containing the signature |
java.util.Iterator |
getX509Certificates()
Returns an iterator over the X.509 certificates included in the signature, if any |
protected abstract void |
insertSignature()
Places the signature into the object's DOM to prepare for signing |
boolean |
isSigned()
Returns true iff the object contains a signature |
void |
sign(java.lang.String alg,
java.security.Key k,
java.util.Collection certs)
Sign the SAML object according to the input parameters |
org.w3c.dom.Node |
toDOM()
Transforms the object into a DOM tree without an existing document context, including namespace declarations |
void |
unsign()
Remove the signature and turn this into an unsigned object. |
void |
verify()
Verifies the signature using only the keying material included within it |
void |
verify(java.security.cert.Certificate cert)
Verifies the signature using the keying material provided |
void |
verify(java.security.Key k)
Verifies the signature using the keying material provided |
Methods inherited from class org.opensaml.SAMLObject |
checkValidity, fromStream, plantRoot, toBase64, toDOM, toDOM, toDOM, toStream, toString |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public SAMLSignedObject()
Method Detail |
public java.lang.Object getNativeSignature()
public abstract java.lang.String getId()
public void fromDOM(org.w3c.dom.Element e) throws SAMLException
SAMLObject
fromDOM
in class SAMLObject
e
- Root element of a DOM tree
SAMLException
- Raised if an exception occurs while constructing
the objectSAMLObject.fromDOM(Element e)
public org.w3c.dom.Node toDOM() throws SAMLException
SAMLObject
toDOM
in class SAMLObject
SAMLException
- Raised if the object is incompletely definedSAMLObject.toDOM()
protected abstract void insertSignature() throws SAMLException
Must be overridden by subclass that knows where to place it
SAMLException
- Thrown if an error occurs while placing the signatureprotected org.w3c.dom.Element getSignatureElement()
public void unsign()
public void sign(java.lang.String alg, java.security.Key k, java.util.Collection certs) throws SAMLException
alg
- The XML signature algorithm to applyk
- The secret or private key to sign the resulting digestcerts
- The public key certificate(s) to embed in the object, if any
SAMLException
- Thrown if an error occurs while constructing the signaturepublic void verify() throws SAMLException
SAMLException
- Thrown if the signature is invalid or if an error occurspublic void verify(java.security.cert.Certificate cert) throws SAMLException
cert
- A public key certificate to use in verifying the signature
SAMLException
- Thrown if the signature is invalid or if an error occurspublic void verify(java.security.Key k) throws SAMLException
k
- A secret or public key to use in verifying the signature
SAMLException
- Thrown if the signature is invalid or if an error occurspublic java.util.Iterator getX509Certificates() throws SAMLException
SAMLException
- Thrown if the signature is missingpublic java.lang.String getSignatureAlgorithm() throws SAMLException
SAMLException
- Thrown if the signature is missingpublic boolean isSigned()
protected java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class SAMLObject
java.lang.CloneNotSupportedException
Object.clone()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |