|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.saml.protocol.AbstractRequest com.sun.identity.federation.message.FSAuthnRequest
The class FSAuthnRequest
is used to create or parse
AuthnRequest.
Constructor Summary | |
FSAuthnRequest()
Default AuthnRequest constructor |
|
FSAuthnRequest(org.w3c.dom.Element root)
Constructor |
|
FSAuthnRequest(java.lang.String requestId,
java.util.List respondWiths,
java.util.List signatures,
java.lang.String providerID,
boolean forceAuthn,
boolean isPassive,
boolean fed,
java.lang.String nameIDPolicy,
java.lang.String protocolProf,
RequestAuthnContext authnCxt,
java.lang.String relaySt,
java.lang.String authContextCompType)
Constructor |
Method Summary | |
java.lang.String |
getAffiliationID()
Gets affiliation ID |
java.lang.String |
getAssertionConsumerServiceID()
Gets AssertionConsumerServiceID parameter. |
java.lang.String |
getAuthContextCompType()
Gets authentication context comparison type. |
RequestAuthnContext |
getAuthnContext()
Gets RequestAuthnContext element |
java.lang.String |
getConsent()
Gets Consent element |
boolean |
getFederate()
Gets Federate param. |
boolean |
getForceAuthn()
Get Force Authentication param |
java.lang.String |
getID()
Gets id attribute. |
boolean |
getIsPassive()
Gets IsPassive param |
int |
getMinorVersion()
Gets minor version |
java.lang.String |
getNameIDPolicy()
Gets NameIDPolicy param. |
java.lang.String |
getProtocolProfile()
Gets ProtocolProfile parameter. |
java.lang.String |
getProviderId()
Gets provider ID for this request. |
java.lang.String |
getRelayState()
Gets RelayState parameter |
FSScoping |
getScoping()
Gets the scoping element. |
java.lang.String |
getSignatureString()
Get the Signature Element as string |
java.lang.String |
getSignedXMLString()
Get Signed XML String. |
static FSAuthnRequest |
parseBASE64EncodedString(java.lang.String encodedReq)
Gets the FSAuthnRequest from the BASE64 encoded format. |
static FSAuthnRequest |
parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request)
Gets the FSAuthnRequest from the query parameters. |
static FSAuthnRequest |
parseXML(java.lang.String xml)
Parses the XML and creates an FSAuthnRequest object |
void |
setAffiliationID(java.lang.String affiliationID)
Sets affiliation ID |
void |
setAssertionConsumerServiceID(java.lang.String assertionConsumerServiceID)
Sets AssertionConsumerServiceID parameter. |
void |
setAuthContextCompType(java.lang.String authType)
Sets authentication context comparison type. |
void |
setAuthnContext(RequestAuthnContext authnCxt)
Sets RequestAuthnContext element |
void |
setConsent(java.lang.String uri)
Sets Consent attribute |
void |
setFederate(boolean fed)
Sets Federate param. |
void |
setForceAuthn(boolean forceAuthn)
Sets force authentication |
void |
setID(java.lang.String id)
Sets id attribute. |
void |
setIsPassive(boolean isPassive)
Sets IsPassive param |
void |
setMinorVersion(int version)
Sets minor version |
void |
setNameIDPolicy(java.lang.String nameIDPolicy)
Sets NameIDPolicy param. |
void |
setProtocolProfile(java.lang.String protocolProf)
Sets ProtocolProfile parameter. |
void |
setProviderId(java.lang.String provId)
Sets provider ID for this request. |
void |
setRelayState(java.lang.String relaySt)
Sets RelayState parameter |
void |
setScoping(FSScoping scoping)
Sets the scoping element. |
boolean |
setSignature(org.w3c.dom.Element elem)
Sets the Signature . |
void |
signXML()
Signs the AuthnRequest . |
void |
signXML(java.lang.String certAlias)
Signs the AuthnRequest . |
java.lang.String |
toBASE64EncodedString()
Gets the BASE 64 encoded format of the request |
java.lang.String |
toURLEncodedQueryString()
Gets the URL encoded string format of the request. |
java.lang.String |
toXMLString()
Creates a String representation of the <lib:AuthnRequest> element. |
java.lang.String |
toXMLString(boolean includeNS,
boolean declareNS)
Creates a String representation of the <lib:AuthnRequest> element. |
java.lang.String |
toXMLString(boolean includeNS,
boolean declareNS,
boolean includeHeader)
Creates a String representation of the <lib:AuthnRequest> element. |
Methods inherited from class com.sun.identity.saml.protocol.AbstractRequest |
addRespondWith, getIssueInstant, getMajorVersion, getRequestID, getRespondWith, getSignature, isSignatureValid, isSigned, setIssueInstant, setMajorVersion, setRequestID |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FSAuthnRequest()
public FSAuthnRequest(java.lang.String requestId, java.util.List respondWiths, java.util.List signatures, java.lang.String providerID, boolean forceAuthn, boolean isPassive, boolean fed, java.lang.String nameIDPolicy, java.lang.String protocolProf, RequestAuthnContext authnCxt, java.lang.String relaySt, java.lang.String authContextCompType) throws FSMsgException
requestId
- RequestID, if null, the constructor will create one.respondWiths
- List of respond withssignatures
- List of signature elementsproviderID
- provider id of the requesting providerforceAuthn
- Force AuthenticationisPassive
- parameter to tell the IDP to be passivefed
- variable to distinguish this request for Federation or SSOnameIDPolicy
- Name ID Policy for this request, possible values
are "none", "onetime", "federated", "any"protocolProf
- ProtocolProfile used for the SSOauthnCxt
- Authentication Context used for the SSOrelaySt
- Relay State i.e. original URL to be redirected after SSOauthContextCompType
- AuthContext comparison type
FSMsgException
- if unable to construct the objectpublic FSAuthnRequest(org.w3c.dom.Element root) throws FSMsgException
root
- AuthnRequest XML root element
FSMsgException
- if error occurs during parsingMethod Detail |
public java.lang.String toXMLString() throws FSMsgException
FSMsgException
- if error occurs.public java.lang.String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
includeNS
- Determines whether or not the namespace qualifier
is prepended to the Element when converteddeclareNS
- Determines whether or not the namespace is declared
within the Element.
FSMsgException
- if error occurs.public java.lang.String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) throws FSMsgException
includeNS
- Determines whether or not the namespace qualifier
is prepended to the Element when converteddeclareNS
- Determines whether or not the namespace is declared
within the Element.includeHeader
- Determines whether the output include the xml
declaration header.
FSMsgException
- if error occurs.public static FSAuthnRequest parseXML(java.lang.String xml) throws FSMsgException
FSAuthnRequest
object
xml
- XML String
FSAuthnRequest
object
FSMsgException
- if unable to construct the object.public java.lang.String getSignedXMLString()
FSAuthnRequest
is
not signed.public java.lang.String getSignatureString()
FSAuthnRequest
is
not signed.public boolean getForceAuthn()
public void setForceAuthn(boolean forceAuthn)
forceAuthn
- boolean variablepublic boolean getIsPassive()
IsPassive
param
IsPassive
parampublic void setIsPassive(boolean isPassive)
IsPassive
param
isPassive
- IsPassive
parampublic boolean getFederate()
Federate
param. This is for ID-FF version 1.1 only.
Federate
parampublic void setFederate(boolean fed)
Federate
param. This is for ID-FF version 1.1 only.
fed
- Federate
attribute to be setpublic java.lang.String getNameIDPolicy()
NameIDPolicy
param.
NameIDPolicy
attribute.public void setNameIDPolicy(java.lang.String nameIDPolicy)
NameIDPolicy
param.
nameIDPolicy
- NameIDPolicy
attribute.public java.lang.String getProtocolProfile()
ProtocolProfile
parameter.
ProtocolProfile
parameter.public void setProtocolProfile(java.lang.String protocolProf)
ProtocolProfile
parameter.
protocolProf
- ProtocolProfile
parameter.public java.lang.String getRelayState()
RelayState
parameter
RelayState
parameterpublic void setRelayState(java.lang.String relaySt)
RelayState
parameter
relaySt
- RelayState
parameter to be setpublic RequestAuthnContext getAuthnContext()
RequestAuthnContext
element
RequestAuthnContext
elementpublic void setAuthnContext(RequestAuthnContext authnCxt)
RequestAuthnContext
element
authnCxt
- RequestAuthnContext
to be set.public java.lang.String getProviderId()
public void setProviderId(java.lang.String provId)
provId
- provider ID to be set.public java.lang.String getAuthContextCompType()
public void setAuthContextCompType(java.lang.String authType)
authType
- authentication context comparison type to be set.public java.lang.String getID()
public void setID(java.lang.String id)
id
- id to be set.public int getMinorVersion()
getMinorVersion
in class AbstractRequest
public void setMinorVersion(int version)
setMinorVersion
in class AbstractRequest
version
- minor version to be setpublic java.lang.String getAffiliationID()
public void setAffiliationID(java.lang.String affiliationID)
affiliationID
- affiliation ID to be setpublic java.lang.String getAssertionConsumerServiceID()
AssertionConsumerServiceID
parameter.
public void setAssertionConsumerServiceID(java.lang.String assertionConsumerServiceID)
AssertionConsumerServiceID
parameter.
assertionConsumerServiceID
- assertion consumer service id to be set.public java.lang.String getConsent()
Consent
element
Consent
elementpublic void setConsent(java.lang.String uri)
Consent
attribute
uri
- Consent
attributepublic void setScoping(FSScoping scoping)
scoping
- scoping element.public FSScoping getScoping()
public java.lang.String toURLEncodedQueryString() throws FSMsgException
FSMsgException
- if unable to convert the request.public java.lang.String toBASE64EncodedString() throws FSMsgException
FSMsgException
- if unable to get the BASE 64 encoded format.public static FSAuthnRequest parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request) throws FSMsgException
FSAuthnRequest
from the query parameters.
request
- HttpServletRequest
to retrieve query parameters
FSAuthnRequest
object
FSMsgException
- if unable to construct the object.public static FSAuthnRequest parseBASE64EncodedString(java.lang.String encodedReq) throws FSMsgException
FSAuthnRequest
from the BASE64 encoded format.
encodedReq
- FSAuthnRequest
in BASE64 encoded string.
FSAuthnRequest
object.
FSMsgException
- if unable to construct the object.public void signXML(java.lang.String certAlias) throws SAMLException
AuthnRequest
.
certAlias
- certification Alias used to sign the
AuthnRequest
SAMLException
- if it could not sign the
AuthnRequest
public void signXML() throws SAMLException
AuthnRequest
.
signXML
in class AbstractRequest
SAMLException
- if it could not sign the
AuthnRequest
public boolean setSignature(org.w3c.dom.Element elem)
Signature
.
setSignature
in class AbstractRequest
elem
- Signature element.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |