|
|||||||||
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.SAMLAuthorizationDecisionStatement
public class SAMLAuthorizationDecisionStatement
Represents a SAML authorization decision statement.
Field Summary | |
---|---|
protected ArrayList |
actions
|
protected String |
decision
|
protected ArrayList |
evidence
|
protected String |
resource
|
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 | |
---|---|
SAMLAuthorizationDecisionStatement()
Default constructor |
|
SAMLAuthorizationDecisionStatement(Element e)
Reconstructs a statement from a DOM tree |
|
SAMLAuthorizationDecisionStatement(InputStream in)
Reconstructs a statement from a stream |
|
SAMLAuthorizationDecisionStatement(SAMLSubject subject,
String resource,
String decision,
Collection actions,
Collection evidence)
Builds an AuthorizationDecisionStatement out of its component parts |
Method Summary | |
---|---|
void |
addAction(SAMLAction action)
Adds an action to the statement |
void |
addEvidence(Object evidence)
Adds an evidence element |
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 |
getActions()
Gets the actions inside the statement |
String |
getDecision()
Gets the decision from inside the statement |
Iterator |
getEvidence()
Gets the evidence inside the statement |
String |
getResource()
Gets the resource URI inside the statement |
void |
removeAction(int index)
Removes an action by position (zero-based) |
void |
removeEvidence(int index)
Removes an evidence element by position (zero-based) |
void |
setActions(Collection actions)
Sets the actions to include in the statement |
void |
setDecision(String decision)
Sets the decision inside the statement |
void |
setEvidence(Collection evidence)
Sets the evidence to include in the statement |
void |
setResource(String resource)
Sets the resource URI 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 String resource
protected String decision
protected ArrayList actions
protected ArrayList evidence
Constructor Detail |
---|
public SAMLAuthorizationDecisionStatement()
public SAMLAuthorizationDecisionStatement(SAMLSubject subject, String resource, String decision, Collection actions, Collection evidence) throws SAMLException
subject
- subject of the statementresource
- URI of the resource being accessed at the time of
the statementactions
- specific actions the decision applies to, must be SAMLAction objectsevidence
- evidence which may be considered, must be String or SAMLAssertion objects
SAMLException
- Raised if an AuthorizationDecisionStatement
cannot be constructed from the supplied informationpublic SAMLAuthorizationDecisionStatement(Element e) throws SAMLException
e
- The root of a DOM tree
SAMLException
- Thrown if the object cannot be constructedpublic SAMLAuthorizationDecisionStatement(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 String getResource()
public void setResource(String resource)
resource
- The resource URIpublic String getDecision()
public void setDecision(String decision)
decision
- The decisionpublic Iterator getActions()
public void setActions(Collection actions) throws SAMLException
actions
- The actions to include
SAMLException
- Raised if the actions are invalidpublic void addAction(SAMLAction action) throws SAMLException
action
- The action to add
SAMLException
- Raised if the action if invalidpublic void removeAction(int index)
index
- The position of the action to removepublic Iterator getEvidence()
public void setEvidence(Collection evidence) throws SAMLException
evidence
- The evidence to include
SAMLException
- Raised if the evidence is invalidpublic void addEvidence(Object evidence) throws SAMLException
evidence
- a String or SAMLAssertion
SAMLException
- Raised if an invalid kind of object is providedpublic void removeEvidence(int index) throws IndexOutOfBoundsException
index
- The position of the element to remove
IndexOutOfBoundsException
protected 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 |