com.sun.identity.federation.message
クラス FSAuthnRequest

java.lang.Object
  com.sun.identity.saml.protocol.AbstractRequest
      com.sun.identity.federation.message.FSAuthnRequest

public class FSAuthnRequest
extends AbstractRequest

The class FSAuthnRequest is used to create , parse AuthnRequest object.

フィールドの概要

protected String	affiliationID
protected String	assertionConsumerServiceID
protected String	authContextCompType
protected String	consentURI
protected String	id
protected int	minorVersion
protected FSScoping	scoping
protected String	signatureString
protected String	xmlString

クラス com.sun.identity.saml.protocol.AbstractRequest から継承されたフィールド

issueInstant, majorVersion, requestID, respondWiths, signature, signed, valid

コンストラクタの概要

FSAuthnRequest()
Default AuthnRequest construtor

FSAuthnRequest(Element root)
Constructor to create FSAuthnRequest object.

FSAuthnRequest(String requestId, List respondWiths, String providerID, boolean forceAuthn, boolean isPassive, boolean fed, String nameIDPolicy, String protocolProf, RequestAuthnContext authnCxt, String relaySt, String authContextCompType)
Constructor to create FSAuthnRequest object.

メソッドの概要

String	getAffiliationID() Returns the Affliation Identifier.
String	getAssertionConsumerServiceID() Returns the Assertion Consumer Service Identifier.
String	getAuthContextCompType() Returns the value of AuthContext Comparison attribute.
RequestAuthnContext	getAuthnContext() Returns the RequestedAuthnContext object.
String	getConsent() Returns the value of consent attribute.
List	getExtensions() Returns a list of Extension objects.
boolean	getFederate() Returns the value of the Federate attribute.
boolean	getForceAuthn() Returns the value of Force Authentication attribute.
String	getID() Returns the value of id attribute.
boolean	getIsPassive() Returns the value of the isPassive attribute.
int	getMinorVersion() Returns the value of the MinorVersion attribute.
String	getNameIDPolicy() Returns the NameIDPolicy object.
String	getProtocolProfile() Returns the value of ProtocolProfile attribute.
String	getProviderId() Returns the value of ProviderID attribute.
String	getRelayState() Returns the value of RelayState attribute.
FSScoping	getScoping() Returns the FSScoping object.
String	getSignatureString() Returns the signature string.
String	getSignedXMLString() Returns Signed XML String representation of this object.
static FSAuthnRequest	parseBASE64EncodedString(String encodedReq) Returns FSAuthnRequest object.
static FSAuthnRequest	parseURLEncodedRequest(HttpServletRequest request) Returns FSAuthnRequest object.
static FSAuthnRequest	parseXML(String xml) Returns the FSAuthnRequest object.
void	setAffiliationID(String affiliationID) Sets the Affiliation Identifier.
void	setAssertionConsumerServiceID(String assertionConsumerServiceID) Sets the Assertion Consumer Service Identifier.
void	setAuthContextCompType(String authType) Sets the value of AuthContext Comparison attribute.
void	setAuthnContext(RequestAuthnContext authnCxt) Sets the RequestedAuthnContext object.
void	setConsent(String consentURI) Sets the value of consent attribute.
void	setExtensions(List extensions) Sets Extension objects.
void	setFederate(boolean fed) Sets the value of the Federate attribute.
void	setForceAuthn(boolean forceAuthn) Sets the value of Force Authentication attribute.
void	setID(String id) Sets the value of id attribute.
void	setIsPassive(boolean isPassive) Sets the value of the IsPassive attribute.
void	setMinorVersion(int version) Sets the value of the MinorVersion attribute.
void	setNameIDPolicy(String nameIDPolicy) Sets the NameIDPolicy object.
void	setProtocolProfile(String protocolProf) Sets the value of ProtocolProfile attribute.
void	setProviderId(String provId) Sets the value of ProviderID attribute.
void	setRelayState(String relaySt) Set the value of RelayState attribute.
void	setScoping(FSScoping scoping) Sets the FSScoping object.
boolean	setSignature(Element elem) Sets the Signature of the Element passed.
void	signXML() Unsupported Method.
void	signXML(String certAlias) Signs the Request.
String	toBASE64EncodedString() Returns a Base64 Encoded String.
String	toURLEncodedQueryString() Returns an URL Encoded Query String.
String	toXMLString() This method translates the request to an XML document String based on the Request schema described above.
String	toXMLString(boolean includeNS, boolean declareNS) Creates a String representation of the <lib:AuthnRequest> element.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Creates a String representation of the <lib:AuthnRequest> element.

クラス com.sun.identity.saml.protocol.AbstractRequest から継承されたメソッド

addRespondWith, getIssueInstant, getMajorVersion, getRequestID, getRespondWith, getSignature, isSignatureValid, isSigned, setIssueInstant, setMajorVersion, setRequestID

フィールドの詳細

xmlString

protected String xmlString

signatureString

protected String signatureString

authContextCompType

protected String authContextCompType

id

protected String id

assertionConsumerServiceID

protected String assertionConsumerServiceID

consentURI

protected String consentURI

affiliationID

protected String affiliationID

minorVersion

protected int minorVersion

scoping

protected FSScoping scoping

コンストラクタの詳細

FSAuthnRequest

public FSAuthnRequest()

Default AuthnRequest construtor

FSAuthnRequest

public FSAuthnRequest(String requestId,
                      List respondWiths,
                      String providerID,
                      boolean forceAuthn,
                      boolean isPassive,
                      boolean fed,
                      String nameIDPolicy,
                      String protocolProf,
                      RequestAuthnContext authnCxt,
                      String relaySt,
                      String authContextCompType)
               throws FSMsgException

Constructor to create FSAuthnRequest object.

パラメータ:

requestId - the request identifier.

respondWiths - List of respond withs attributes.

providerID - provider id of the requesting provider.

forceAuthn - Force Authentication boolean value.

isPassive - attribute for IDP to be passive or active.

fed - attribute to distingush this request for Federation or SSO

nameIDPolicy - Name ID Policy for this request, possible values are "none", "onetime", "federated", "any".

protocolProf - ProtocolProfile used for the SSO.

authnCxt - Authentication Context used for the SSO.

relaySt - Relay State i.e. original URL to be redirected after SSO.

authContextCompType - AuthContext comparison type.

例外:

FSMsgException - on error.

FSMsgException

FSAuthnRequest

public FSAuthnRequest(Element root)
               throws FSMsgException

Constructor to create FSAuthnRequest object.

パラメータ:

root - the Document Element object.

例外:

FSMsgException - on error.

FSMsgException

メソッドの詳細

toXMLString

public String toXMLString()
                   throws FSMsgException

This method translates the request to an XML document String based on the Request schema described above. NOTE: this is a complete AuthnRequest xml string with RequestID, MajorVersion, etc.

戻り値:

XML String representing the request.

例外:

FSMsgException - if there is an error.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException

Creates a String representation of the <lib:AuthnRequest> element.

パラメータ:

includeNS - : Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - : Determines whether or not the namespace is declared within the Element.

戻り値:

string containing the valid XML for this element.

例外:

FSMsgException - if there is an error.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS,
                          boolean includeHeader)
                   throws FSMsgException

Creates a String representation of the <lib:AuthnRequest> element.

パラメータ:

includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

includeHeader - Determines whether the output include the xml declaration header.

戻り値:

A string containing the valid XML for this element.

例外:

FSMsgException - if there is an error.

parseXML

public static FSAuthnRequest parseXML(String xml)
                               throws FSMsgException

Returns the FSAuthnRequest object.

パラメータ:

xml - the XML string.

戻り値:

FSAuthnRequest object.

例外:

FSMsgException - if there is error creating the object.

getSignedXMLString

public String getSignedXMLString()

Returns Signed XML String representation of this object.

戻り値:

signed XML String.

getSignatureString

public String getSignatureString()

Returns the signature string.

戻り値:

the signature string.

getExtensions

public List getExtensions()

Returns a list of Extension objects. Each entry of the list is a Extension object.

戻り値:

a list of Extension elements.

関連項目:

FSAuthnRequest.setExtensions(List)

setExtensions

public void setExtensions(List extensions)

Sets Extension objects. Each entry of the list is a Extension object.

パラメータ:

extensions - a list of Extension objects.

関連項目:

FSAuthnRequest.getExtensions()

getForceAuthn

public boolean getForceAuthn()

Returns the value of Force Authentication attribute.

戻り値:

the value of Force Authentication attribute.

setForceAuthn

public void setForceAuthn(boolean forceAuthn)

Sets the value of Force Authentication attribute.

パラメータ:

forceAuthn - value of Force Authentication attribute.

getIsPassive

public boolean getIsPassive()

Returns the value of the isPassive attribute.

戻り値:

value of isPassive attribute.

setIsPassive

public void setIsPassive(boolean isPassive)

Sets the value of the IsPassive attribute.

パラメータ:

isPassive - value of isPassive attribute.

getFederate

public boolean getFederate()

Returns the value of the Federate attribute.

戻り値:

the value fo the Federate attribute.

setFederate

public void setFederate(boolean fed)

Sets the value of the Federate attribute.

パラメータ:

fed - the value of the Federate attribute.

getNameIDPolicy

public String getNameIDPolicy()

Returns the NameIDPolicy object.

戻り値:

the NameIDPolicy object.

関連項目:

FSAuthnRequest.setNameIDPolicy(String)

setNameIDPolicy

public void setNameIDPolicy(String nameIDPolicy)

Sets the NameIDPolicy object.

パラメータ:

nameIDPolicy - the new NameIDPolicy object.

関連項目:

FSAuthnRequest.getNameIDPolicy()

getProtocolProfile

public String getProtocolProfile()

Returns the value of ProtocolProfile attribute.

戻り値:

the value of ProtocolProfile attribute.

関連項目:

FSAuthnRequest.setProtocolProfile(String)

setProtocolProfile

public void setProtocolProfile(String protocolProf)

Sets the value of ProtocolProfile attribute.

パラメータ:

protocolProf - the value of ProtocolProfile attribute.

関連項目:

FSAuthnRequest.getProtocolProfile()

getRelayState

public String getRelayState()

Returns the value of RelayState attribute.

戻り値:

the value of RelayState attribute.

関連項目:

FSAuthnRequest.setRelayState(String)

setRelayState

public void setRelayState(String relaySt)

Set the value of RelayState attribute.

パラメータ:

relaySt - the value of RelayState attribute.

関連項目:

FSAuthnRequest.getRelayState()

getAuthnContext

public RequestAuthnContext getAuthnContext()

Returns the RequestedAuthnContext object.

戻り値:

the RequestedAuthnContext object.

関連項目:

FSAuthnRequest.setAuthnContext(RequestAuthnContext)

setAuthnContext

public void setAuthnContext(RequestAuthnContext authnCxt)

Sets the RequestedAuthnContext object.

パラメータ:

authnCxt - the RequestAuthnContext object.

関連項目:

FSAuthnRequest.getAuthnContext()

getProviderId

public String getProviderId()

Returns the value of ProviderID attribute.

戻り値:

the value of ProviderID attribute.

関連項目:

FSAuthnRequest.setProviderId(String).

setProviderId

public void setProviderId(String provId)

Sets the value of ProviderID attribute.

パラメータ:

provId - the value of ProviderID attribute.

関連項目:

FSAuthnRequest.getProviderId()

getAuthContextCompType

public String getAuthContextCompType()

Returns the value of AuthContext Comparison attribute.

戻り値:

he value of AuthContext Comparison attribute.

関連項目:

FSAuthnRequest.setAuthContextCompType(String)

setAuthContextCompType

public void setAuthContextCompType(String authType)

Sets the value of AuthContext Comparison attribute.

パラメータ:

authType - he value of AuthContext Comparison attribute.

関連項目:

FSAuthnRequest.getAuthContextCompType()

getID

public String getID()

Returns the value of id attribute.

戻り値:

the value of id attribute.

関連項目:

FSAuthnRequest.setID(String)

setID

public void setID(String id)

Sets the value of id attribute.

パラメータ:

id - the value of id attribute.

関連項目:

FSAuthnRequest.getID()

getMinorVersion

public int getMinorVersion()

Returns the value of the MinorVersion attribute.

オーバーライド:

クラス AbstractRequest 内の getMinorVersion

戻り値:

the value of the MinorVersion attribute.

関連項目:

FSAuthnRequest.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Sets the value of the MinorVersion attribute.

オーバーライド:

クラス AbstractRequest 内の setMinorVersion

パラメータ:

version - the value of the MinorVersion attribute.

関連項目:

FSAuthnRequest.getMinorVersion()

getAffiliationID

public String getAffiliationID()

Returns the Affliation Identifier.

戻り値:

the Affliation Identifier.

関連項目:

FSAuthnRequest.setAffiliationID(String)

setAffiliationID

public void setAffiliationID(String affiliationID)

Sets the Affiliation Identifier.

パラメータ:

affiliationID - the Affiliation Identifier.

関連項目:

FSAuthnRequest.getAffiliationID()

getAssertionConsumerServiceID

public String getAssertionConsumerServiceID()

Returns the Assertion Consumer Service Identifier.

戻り値:

the Assertion Consumer Service Identifier.

関連項目:

FSAuthnRequest.setAssertionConsumerServiceID(String)

setAssertionConsumerServiceID

public void setAssertionConsumerServiceID(String assertionConsumerServiceID)

Sets the Assertion Consumer Service Identifier.

パラメータ:

assertionConsumerServiceID - the Assertion Consumer Service Identifier.

関連項目:

FSAuthnRequest.getAssertionConsumerServiceID()

getConsent

public String getConsent()

Returns the value of consent attribute.

戻り値:

the value of consent attribute.

関連項目:

FSAuthnRequest.setConsent(String)

setConsent

public void setConsent(String consentURI)

Sets the value of consent attribute.

パラメータ:

consentURI - the value of consent attribute.

関連項目:

FSAuthnRequest.getConsent()

setScoping

public void setScoping(FSScoping scoping)

Sets the FSScoping object.

パラメータ:

scoping - the FSScoping object.

関連項目:

FSAuthnRequest.getScoping()

getScoping

public FSScoping getScoping()

Returns the FSScoping object.

戻り値:

the FSScoping object.

関連項目:

FSAuthnRequest.setScoping(FSScoping)

toURLEncodedQueryString

public String toURLEncodedQueryString()
                               throws FSMsgException

Returns an URL Encoded Query String.

戻り値:

a url encoded query string.

例外:

FSMsgException - if there is an error.

toBASE64EncodedString

public String toBASE64EncodedString()
                             throws FSMsgException

Returns a Base64 Encoded String.

戻り値:

a Base64 Encoded String.

例外:

FSMsgException - if there is an error encoding the string.

parseURLEncodedRequest

public static FSAuthnRequest parseURLEncodedRequest(HttpServletRequest request)
                                             throws FSMsgException

Returns FSAuthnRequest object. The object is creating by parsing the HttpServletRequest object.

パラメータ:

request - the HttpServletRequest object.

例外:

FSMsgException - if there is an error creating FSAuthnRequest object.

parseBASE64EncodedString

public static FSAuthnRequest parseBASE64EncodedString(String encodedReq)
                                               throws FSMsgException

Returns FSAuthnRequest object. The object is created by parsing an Base64 encode authentication request string.

パラメータ:

encodedReq - the encode string

例外:

FSMsgException - if there is an error creating FSAuthnRequest object.

signXML

public void signXML(String certAlias)
             throws SAMLException

Signs the Request.

パラメータ:

certAlias - the Certificate Alias.

例外:

XMLSignatureException - if FSAuthnRequest cannot be signed.

SAMLException

signXML

public void signXML()
             throws SAMLException

Unsupported Method.

定義:

クラス AbstractRequest 内の signXML

例外:

SAMLException - If could not sign the object.

setSignature

public boolean setSignature(Element elem)

Sets the Signature of the Element passed.

オーバーライド:

クラス AbstractRequest 内の setSignature

パラメータ:

elem - the Document Element.

戻り値:

true if success otherwise false.