|
||||||||||
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.SAMLAuthenticationStatement
Represents a SAML Authentication Statement
Field Summary | |
static String |
AuthenticationMethod_HardwareToken
The authentication was performed by means of an unspecified hardware token. |
static String |
AuthenticationMethod_Kerberos
The authentication was performed by means of the Kerberos protocol [RFC 1510], an instantiation of the Needham-Schroeder symmetric key authentication mechanism [Needham78]. |
static String |
AuthenticationMethod_Password
The authentication was performed by means of a password. |
static String |
AuthenticationMethod_PGP_PublicKey
The authentication was performed by some (unspecified) mechanism on a key authenticated by means of a PGP web of trust [PGP]. |
static String |
AuthenticationMethod_SPKI_PublicKey
The authentication was performed by some (unspecified) mechanism on a key authenticated by means of a SPKI PKI [SPKI]. |
static String |
AuthenticationMethod_SRP
The authentication was performed by means of Secure Remote Password protocol as specified in [RFC 2945]. |
static String |
AuthenticationMethod_SSL_TLS_Client
The authentication was performed using either the SSL or TLS protocol with certificate based client authentication. |
static String |
AuthenticationMethod_Unspecified
The authentication was performed by an unspecified means. |
static String |
AuthenticationMethod_X509_PublicKey
The authentication was performed by some (unspecified) mechanism on a key authenticated by means of an X.509 PKI [X.500][PKIX]. |
static String |
AuthenticationMethod_XKMS_PublicKey
The authentication was performed by some (unspecified) mechanism on a key authenticated by means of a XKMS trust service [XKMS]. |
static String |
AuthenticationMethod_XML_DSig
The authentication was performed by means of an XML digital signature [RFC 3075]. |
protected Date |
authInstant
|
protected String |
authMethod
|
protected ArrayList |
bindings
|
protected String |
subjectDNS
|
protected String |
subjectIP
|
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 | |
SAMLAuthenticationStatement()
Default constructor |
|
SAMLAuthenticationStatement(Element e)
Reconstructs a statement from a DOM tree |
|
SAMLAuthenticationStatement(InputStream in)
Reconstructs a statement from a stream |
|
SAMLAuthenticationStatement(SAMLSubject subject,
Date authInstant,
String subjectIP,
String subjectDNS,
Collection bindings)
Builds a statement out of its component parts |
|
SAMLAuthenticationStatement(SAMLSubject subject,
String authMethod,
Date authInstant,
String subjectIP,
String subjectDNS,
Collection bindings)
Builds a statement out of its component parts |
Method Summary | |
void |
addBinding(SAMLAuthorityBinding binding)
Adds SAML authority binding information |
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 |
Date |
getAuthInstant()
Gets the datetime of authentication |
String |
getAuthMethod()
Gets the authentication method |
Iterator |
getBindings()
Gets SAML authority binding information |
String |
getSubjectDNS()
Gets the subject's DNS address |
String |
getSubjectIP()
Gets the subject's IP address |
void |
removeBinding(int index)
Removes a binding by position (zero-based) |
void |
setAuthInstant(Date authInstant)
Sets the datetime of authentication |
void |
setAuthMethod(String authMethod)
Sets the authentication method |
void |
setBindings(Collection bindings)
Sets SAML authority binding information |
void |
setSubjectDNS(String subjectDNS)
Sets the subject's DNS address |
void |
setSubjectIP(String subjectIP)
Sets the subject's IP address |
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 subjectIP
protected String subjectDNS
protected String authMethod
protected Date authInstant
protected ArrayList bindings
public static final String AuthenticationMethod_Password
public static final String AuthenticationMethod_Kerberos
public static final String AuthenticationMethod_SRP
public static final String AuthenticationMethod_HardwareToken
public static final String AuthenticationMethod_SSL_TLS_Client
public static final String AuthenticationMethod_X509_PublicKey
public static final String AuthenticationMethod_PGP_PublicKey
public static final String AuthenticationMethod_SPKI_PublicKey
public static final String AuthenticationMethod_XKMS_PublicKey
public static final String AuthenticationMethod_XML_DSig
public static final String AuthenticationMethod_Unspecified
Constructor Detail |
public SAMLAuthenticationStatement()
public SAMLAuthenticationStatement(SAMLSubject subject, String authMethod, Date authInstant, String subjectIP, String subjectDNS, Collection bindings) throws SAMLException
subject
- Subject of statementauthMethod
- URI of authentication methodauthInstant
- Datetime of authenticationsubjectIP
- IP address of subject in dotted decimal
notation (optional)subjectDNS
- DNS address of subject (optional)bindings
- Collection of SAMLAuthorityBinding objects to
reference SAML responders (optional)
SAMLException
- Raised if a statement cannot be constructed
from the supplied informationpublic SAMLAuthenticationStatement(SAMLSubject subject, Date authInstant, String subjectIP, String subjectDNS, Collection bindings) throws SAMLException
subject
- Subject of statementauthInstant
- Datetime of authenticationsubjectIP
- IP address of subject in dotted decimal
notation (optional)subjectDNS
- DNS address of subject (optional)bindings
- Collection of SAMLAuthorityBinding objects to
reference SAML responders (optional)
SAMLException
- Raised if a statement cannot be constructed
from the supplied informationpublic SAMLAuthenticationStatement(Element e) throws SAMLException
e
- The root of a DOM tree
SAMLException
- Thrown if the object cannot be constructedpublic SAMLAuthenticationStatement(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
SAMLException
SAMLObject.fromDOM(org.w3c.dom.Element)
public String getSubjectIP()
public void setSubjectIP(String subjectIP)
subjectIP
- The subject's IP addresspublic String getSubjectDNS()
public void setSubjectDNS(String subjectDNS)
subjectDNS
- The subject's DNS addresspublic String getAuthMethod()
public void setAuthMethod(String authMethod)
authMethod
- The authentication method URIpublic Date getAuthInstant()
public void setAuthInstant(Date authInstant)
authInstant
- The date and time of authenticationpublic Iterator getBindings()
public void setBindings(Collection bindings) throws SAMLException
bindings
- The bindings to include
SAMLException
- Raised if any of the bindings are invalidpublic void addBinding(SAMLAuthorityBinding binding) throws SAMLException
binding
- The binding to add
SAMLException
- Raised if the binding is invalidpublic void removeBinding(int index)
index
- The position of the binding 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
SAMLException
SAMLObject.toDOM(org.w3c.dom.Document,boolean)
public void checkValidity() throws SAMLException
SAMLObject
checkValidity
in class SAMLSubjectStatement
SAMLException
SAMLObject.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 |