|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.SAMLObject
org.opensaml.SAMLStatement
org.opensaml.SAMLSubjectStatement
org.opensaml.SAMLAttributeStatement
public class SAMLAttributeStatement
Represents a SAML Attribute Statement
Field Summary | |
---|---|
protected ArrayList |
attrs
|
Fields inherited from class org.opensaml.SAMLSubjectStatement |
---|
subject |
Fields inherited from class org.opensaml.SAMLStatement |
---|
statementTypeMap |
Fields inherited from class org.opensaml.SAMLObject |
---|
config, dirty, log, parentObject, root |
Constructor Summary | |
---|---|
SAMLAttributeStatement()
Default constructor |
|
SAMLAttributeStatement(Element e)
Reconstructs an attribute statement from a DOM tree |
|
SAMLAttributeStatement(InputStream in)
Reconstructs an attribute statement from a stream |
|
SAMLAttributeStatement(SAMLSubject subject,
Collection attrs)
Builds a statement out of its component parts |
Method Summary | |
---|---|
void |
addAttribute(SAMLAttribute attribute)
Adds an attribute to the statement |
protected Element |
buildRoot(Document doc,
boolean xmlns)
Delegates the process of building the root element of an object and inserting appropriate namespaces. |
void |
checkValidity()
Evaluates the object's content to see if it is currently valid if serialized. |
Object |
clone()
Copies a SAML object such that no dependencies exist between the original and the copy |
void |
fromDOM(Element e)
Initialization of an object from a DOM element |
Iterator |
getAttributes()
Gets attributes from the statement, if any |
void |
removeAttribute(int index)
Removes an attribute by position (zero-based) |
void |
setAttributes(Collection attributes)
Sets the attributes inside the statement |
Node |
toDOM(Document doc,
boolean xmlns)
Transforms the object into a DOM tree using an existing document context |
Methods inherited from class org.opensaml.SAMLSubjectStatement |
---|
getSubject, setSubject |
Methods inherited from class org.opensaml.SAMLStatement |
---|
getInstance, getInstance, regFactory, unregFactory |
Methods inherited from class org.opensaml.SAMLObject |
---|
fromStream, fromStream, getParent, plantRoot, setDirty, setParent, 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 ArrayList attrs
Constructor Detail |
---|
public SAMLAttributeStatement()
public SAMLAttributeStatement(SAMLSubject subject, Collection attrs) throws SAMLException
subject
- Subject of statementattrs
- Collection of attributes
SAMLException
- Raised if a statement cannot be constructed
from the supplied informationpublic SAMLAttributeStatement(Element e) throws SAMLException
e
- The root of a DOM tree
SAMLException
- Thrown if the object cannot be constructedpublic SAMLAttributeStatement(InputStream in) throws SAMLException
in
- A stream containing XML
SAMLException
- Raised if an exception occurs while constructing
the object.Method Detail |
---|
public void fromDOM(Element e) throws SAMLException
SAMLObject
fromDOM
in class SAMLSubjectStatement
e
- Root element of a DOM tree
SAMLException
- Raised if an exception occurs while constructing
the objectSAMLObject.fromDOM(org.w3c.dom.Element)
public Iterator getAttributes()
public void setAttributes(Collection attributes) throws SAMLException
attributes
- The attributes to include
SAMLException
- Raised if the attributes are invalidpublic void addAttribute(SAMLAttribute attribute) throws SAMLException
attribute
- The attribute to add
SAMLException
- Raised if the subject is invalidpublic void removeAttribute(int index)
index
- The position of the attribute to removeprotected Element buildRoot(Document doc, boolean xmlns)
SAMLObject
buildRoot
in class SAMLObject
doc
- The document context to usexmlns
- Include namespace(s) on root element?
SAMLObject.buildRoot(org.w3c.dom.Document,boolean)
public Node toDOM(Document doc, boolean xmlns) throws SAMLException
SAMLObject
toDOM
in class SAMLSubjectStatement
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 SAMLSubjectStatement
SAMLException
- Raised if the serialized object would be invalid SAML,
excluding any embedded objectsSAMLObject.checkValidity()
public Object clone() throws CloneNotSupportedException
clone
in class SAMLSubjectStatement
CloneNotSupportedException
Object.clone()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |