|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.SAMLObject
Abstract base class for all SAML constructs
Field Summary | |
protected SAMLConfig |
config
OpenSAML configuration |
protected org.apache.log4j.Logger |
log
Class-specific logging object |
protected org.w3c.dom.Node |
root
Root node of a DOM tree capturing the object |
Constructor Summary | |
SAMLObject()
|
Method Summary | |
void |
checkValidity()
Evaluates the object's content to see if it is currently valid if serialized. |
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 |
protected static org.w3c.dom.Element |
fromStream(java.io.InputStream in)
Allows parsing of objects from a stream of XML |
protected org.w3c.dom.Node |
plantRoot()
Installs the root node of this DOM as the document element |
byte[] |
toBase64()
Returns a base64-encoded XML representation of the SAML object |
org.w3c.dom.Node |
toDOM()
Transforms the object into a DOM tree without an existing document context, including namespace declarations |
org.w3c.dom.Node |
toDOM(boolean xmlns)
Transforms the object into a DOM tree without an existing document context |
org.w3c.dom.Node |
toDOM(org.w3c.dom.Document doc)
Transforms the object into a DOM tree using an existing document context, including namespace declarations |
org.w3c.dom.Node |
toDOM(org.w3c.dom.Document doc,
boolean xmlns)
Transforms the object into a DOM tree using an existing document context |
void |
toStream(java.io.OutputStream out)
Serializes the XML representation of the SAML object to a stream |
java.lang.String |
toString()
Serializes a SAML object to a string in exclusive canonical form. |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected org.w3c.dom.Node root
protected org.apache.log4j.Logger log
protected SAMLConfig config
Constructor Detail |
public SAMLObject()
Method Detail |
protected static org.w3c.dom.Element fromStream(java.io.InputStream in) throws SAMLException
in
- A stream containing XML
SAMLException
- Raised if an exception occurs while constructing
the objectpublic void checkValidity() throws SAMLException
SAMLException
- Raised if the serialized object would be invalid SAML,
excluding any embedded objectspublic void fromDOM(org.w3c.dom.Element e) throws SAMLException
e
- Root element of a DOM tree
SAMLException
- Raised if an exception occurs while constructing
the objectpublic void toStream(java.io.OutputStream out) throws java.io.IOException, SAMLException
out
- Stream to use for output
java.io.IOException
- Raised if an I/O problem is detected
SAMLException
- Raised if the object is incompletely definedpublic byte[] toBase64() throws java.io.IOException, SAMLException
java.io.IOException
- Raised if an I/O problem is detected
SAMLException
- Raised if the object is incompletely definedpublic org.w3c.dom.Node toDOM(org.w3c.dom.Document doc, boolean xmlns) throws SAMLException
doc
- A Document object to use in manufacturing the treexmlns
- Include namespace(s) on root element?
SAMLException
- Raised if the object is incompletely definedpublic org.w3c.dom.Node toDOM(boolean xmlns) throws SAMLException
xmlns
- Include namespace(s) on root element?
SAMLException
- Raised if the object is incompletely definedpublic org.w3c.dom.Node toDOM(org.w3c.dom.Document doc) throws SAMLException
doc
- A Document object to use in manufacturing the tree
SAMLException
- Raised if the object is incompletely definedpublic org.w3c.dom.Node toDOM() throws SAMLException
SAMLException
- Raised if the object is incompletely definedprotected org.w3c.dom.Node plantRoot()
protected java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
Object.clone()
public java.lang.String toString()
Object.toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |