|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.SAMLObject
org.opensaml.SAMLNameIdentifier
Represents a SAML Subject
Field Summary | |
protected java.lang.String |
format
|
static java.lang.String |
FORMAT_EMAIL
Email Format Identifier |
static java.lang.String |
FORMAT_UNSPECIFIED
Unspecified Format Identifier |
static java.lang.String |
FORMAT_WINDOWS
Windows Domain Format Identifier |
static java.lang.String |
FORMAT_X509
X.509 Subject Format Identifier |
protected java.lang.String |
name
|
protected java.lang.String |
nameQualifier
|
Fields inherited from class org.opensaml.SAMLObject |
config, log, root |
Constructor Summary | |
SAMLNameIdentifier()
Default constructor |
|
SAMLNameIdentifier(org.w3c.dom.Element e)
Reconstructs a name identifier from a DOM tree |
|
SAMLNameIdentifier(java.io.InputStream in)
Reconstructs a name identifier from a stream |
|
SAMLNameIdentifier(java.lang.String name,
java.lang.String nameQualifier,
java.lang.String format)
Builds a name identifier out of its component parts |
Method Summary | |
void |
checkValidity()
Evaluates the object's content to see if it is currently valid if serialized. |
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 |
java.lang.String |
getFormat()
Gets the format of the name |
java.lang.String |
getName()
Gets the name of the Subject |
java.lang.String |
getNameQualifier()
Gets the name qualifier |
void |
setFormat(java.lang.String format)
Sets the format of the name |
void |
setName(java.lang.String name)
Sets the name of the Subject |
void |
setNameQualifier(java.lang.String nameQualifier)
Sets the name qualifier |
org.w3c.dom.Node |
toDOM(org.w3c.dom.Document doc,
boolean xmlns)
Transforms the object into a DOM tree using an existing document context |
Methods inherited from class org.opensaml.SAMLObject |
fromStream, plantRoot, toBase64, toDOM, toDOM, toDOM, toStream, toString |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.lang.String name
protected java.lang.String nameQualifier
protected java.lang.String format
public static final java.lang.String FORMAT_UNSPECIFIED
public static final java.lang.String FORMAT_EMAIL
public static final java.lang.String FORMAT_X509
public static final java.lang.String FORMAT_WINDOWS
Constructor Detail |
public SAMLNameIdentifier()
public SAMLNameIdentifier(java.lang.String name, java.lang.String nameQualifier, java.lang.String format) throws SAMLException
name
- Name of subject (optional)nameQualifier
- Federates or qualifies subject name (optional)format
- URI describing name semantics and format (optional)
SAMLException
- Raised if a name cannot be constructed
from the supplied informationpublic SAMLNameIdentifier(org.w3c.dom.Element e) throws SAMLException
e
- The root of a DOM tree
SAMLException
- Thrown if the object cannot be constructedpublic SAMLNameIdentifier(java.io.InputStream in) throws SAMLException
in
- A stream containing XML
SAMLException
- Raised if an exception occurs while constructing
the object.Method Detail |
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(org.w3c.dom.Element)
public java.lang.String getName()
public void setName(java.lang.String name)
name
- The namepublic java.lang.String getNameQualifier()
public void setNameQualifier(java.lang.String nameQualifier)
nameQualifier
- The name qualifierpublic java.lang.String getFormat()
public void setFormat(java.lang.String format)
format
- The name format URIpublic org.w3c.dom.Node toDOM(org.w3c.dom.Document doc, boolean xmlns) throws SAMLException
SAMLObject
toDOM
in class SAMLObject
doc
- A Document object to use in manufacturing the treexmlns
- Include namespace(s) on root element?
SAMLException
- Raised if the object is incompletely definedSAMLObject.toDOM(org.w3c.dom.Document,boolean)
public void checkValidity() throws SAMLException
SAMLObject
checkValidity
in class SAMLObject
SAMLException
- Raised if the serialized object would be invalid SAML,
excluding any embedded objectsSAMLObject.checkValidity()
public 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 |