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

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

public class FSNameRegistrationRequest
extends AbstractRequest

This class contains methods to create NameRegistrationRequest object.

フィールドの概要

protected String	id
protected int	minorVersion
protected String	signatureString
protected String	xmlString

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

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

コンストラクタの概要

FSNameRegistrationRequest()
Default Constructor.

FSNameRegistrationRequest(Element root)
Constructor creates FSNameRegistrationRequest> object from a Document Element.

FSNameRegistrationRequest(String requestId, List respondWiths, String providerId, SPProvidedNameIdentifier spProvidedNameIdentifier, IDPProvidedNameIdentifier idpProvidedNameIdentifier, OldProvidedNameIdentifier oldProvidedNameIdentifier, String relayState)
Constructor creates the FSNameRegistrationRequest object.

メソッドの概要

String	getID() Returns the value of id attribute.
IDPProvidedNameIdentifier	getIDPProvidedNameIdentifier() Returns the Identity Provider's NameIdentifier.
int	getMinorVersion() Returns the MinorVersion.
OldProvidedNameIdentifier	getOldProvidedNameIdentifier() Returns the original NameIdentifier.
String	getProviderId() Returns the value of ProviderID attribute.
String	getRelayState() Returns the value of RelayState attribute.
String	getSignatureString() Returns the signed XML string.
SPProvidedNameIdentifier	getSPProvidedNameIdentifier() Returns the NameIdentifier provided by the Service Provider.
static FSNameRegistrationRequest	parseURLEncodedRequest(HttpServletRequest request) Returns FSNameRegistrationRequest object.
static FSNameRegistrationRequest	parseXML(String xml)
void	setID(String id) Sets the value of id attribute.
void	setIDPProvidedNameIdentifier(IDPProvidedNameIdentifier nameIdentifier) Sets the Identity Provider's NameIdentifier.
void	setMinorVersion(int version) Sets the MinorVersion.
void	setOldProvidedNameIdentifier(OldProvidedNameIdentifier nameIdentifier) Sets the original NameIdentifier.
void	setProviderId(String providerId) Sets the value of ProviderID attribute.
void	setRelayState(String relayState) Set the value of RelayState attribute.
boolean	setSignature(Element elem) Sets the Signature.
void	setSPProvidedNameIdentifier(SPProvidedNameIdentifier nameIdentifier) Sets the Service Provider's NameIdentifier.
void	signXML() An abstract method to sign the object.
void	signXML(String certAlias) Signs the FSNameRegistrationRequest object.
String	toBASE64EncodedString() Returns a Base64 Encoded String.
String	toURLEncodedQueryString() Returns an URL Encoded String.
String	toXMLString() Returns a String representation of the Logout Response.
String	toXMLString(boolean includeNS, boolean declareNS) Returns a String representation of the Logout Response.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Returns a String representation of the Logout Response.

クラス 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

id

protected String id

minorVersion

protected int minorVersion

コンストラクタの詳細

FSNameRegistrationRequest

public FSNameRegistrationRequest()

Default Constructor.

FSNameRegistrationRequest

public FSNameRegistrationRequest(String requestId,
                                 List respondWiths,
                                 String providerId,
                                 SPProvidedNameIdentifier spProvidedNameIdentifier,
                                 IDPProvidedNameIdentifier idpProvidedNameIdentifier,
                                 OldProvidedNameIdentifier oldProvidedNameIdentifier,
                                 String relayState)
                          throws FSMsgException

Constructor creates the FSNameRegistrationRequest object.

パラメータ:

requestId - the value of RequestID attribute.

respondWiths - the value of RespondWiths attribute.

providerId - the value of ProviderID attribute.

spProvidedNameIdentifier - the Service Provider NameIdentifier.

idpProvidedNameIdentifier - the Identity Provider NameIdentifier.

oldProvidedNameIdentifier - the Original Provider NameIdentifier.

relayState - the value of RelayState attribute.

例外:

FSMsgException - if there is an error creating this object.

FSNameRegistrationRequest

public FSNameRegistrationRequest(Element root)
                          throws FSMsgException

Constructor creates FSNameRegistrationRequest> object from a Document Element.

パラメータ:

root - the Document Element.

例外:

FSMsgException - if there is an error creating this object.

メソッドの詳細

getID

public String getID()

Returns the value of id attribute.

戻り値:

the value of id attribute.

関連項目:

FSNameRegistrationRequest.setID(String)

setID

public void setID(String id)

Sets the value of id attribute.

パラメータ:

id - the value of id attribute.

関連項目:

FSNameRegistrationRequest.getID()

getRelayState

public String getRelayState()

Returns the value of RelayState attribute.

戻り値:

the value of RelayState attribute.

関連項目:

FSNameRegistrationRequest.setRelayState(String)

setRelayState

public void setRelayState(String relayState)

Set the value of RelayState attribute.

パラメータ:

relayState - the value of RelayState attribute.

関連項目:

FSNameRegistrationRequest.getRelayState()

getSignatureString

public String getSignatureString()

Returns the signed XML string.

戻り値:

the signed XML string.

getMinorVersion

public int getMinorVersion()

Returns the MinorVersion.

オーバーライド:

クラス AbstractRequest 内の getMinorVersion

戻り値:

the MinorVersion.

関連項目:

FSNameRegistrationRequest.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Sets the MinorVersion.

オーバーライド:

クラス AbstractRequest 内の setMinorVersion

パラメータ:

version - the MinorVersion.

関連項目:

FSNameRegistrationRequest.getMinorVersion()

parseXML

public static FSNameRegistrationRequest parseXML(String xml)
                                          throws FSMsgException

例外:

FSMsgException

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns a String representation of the Logout Response.

戻り値:

a string containing the valid XML for this element

例外:

FSMsgException - if there is an error converting this object ot a string.

toXMLString

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

Returns a String representation of the Logout Response.

パラメータ:

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.

戻り値:

a string containing the valid XML for this element

例外:

FSMsgException - if there is an error converting this object ot a string.

toXMLString

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

Returns a String representation of the Logout Response.

パラメータ:

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 converting this object ot a string.

getIDPProvidedNameIdentifier

public IDPProvidedNameIdentifier getIDPProvidedNameIdentifier()

Returns the Identity Provider's NameIdentifier.

戻り値:

the Identity Provider's NameIdentifier.

getOldProvidedNameIdentifier

public OldProvidedNameIdentifier getOldProvidedNameIdentifier()

Returns the original NameIdentifier.

戻り値:

the original NameIdentifier.

getProviderId

public String getProviderId()

Returns the value of ProviderID attribute.

戻り値:

the value of ProviderID attribute.

関連項目:

FSNameRegistrationRequest.setProviderId(String).

setIDPProvidedNameIdentifier

public void setIDPProvidedNameIdentifier(IDPProvidedNameIdentifier nameIdentifier)

Sets the Identity Provider's NameIdentifier.

パラメータ:

nameIdentifier - the Identity Provider's NameIdentifier.

関連項目:

FSNameRegistrationRequest.getIDPProvidedNameIdentifier()

setOldProvidedNameIdentifier

public void setOldProvidedNameIdentifier(OldProvidedNameIdentifier nameIdentifier)

Sets the original NameIdentifier.

パラメータ:

nameIdentifier - the original provider's NameIdentifier.

関連項目:

FSNameRegistrationRequest.getOldProvidedNameIdentifier()

setSPProvidedNameIdentifier

public void setSPProvidedNameIdentifier(SPProvidedNameIdentifier nameIdentifier)

Sets the Service Provider's NameIdentifier.

パラメータ:

nameIdentifier - the Identity Provider's NameIdentifier.

関連項目:

FSNameRegistrationRequest.getSPProvidedNameIdentifier()

setProviderId

public void setProviderId(String providerId)

Sets the value of ProviderID attribute.

パラメータ:

providerId - the value of ProviderID attribute.

getSPProvidedNameIdentifier

public SPProvidedNameIdentifier getSPProvidedNameIdentifier()

Returns the NameIdentifier provided by the Service Provider.

戻り値:

the NameIdentifier provided by the Service Provider.

関連項目:

FSNameRegistrationRequest.setSPProvidedNameIdentifier(SPProvidedNameIdentifier)

toBASE64EncodedString

public String toBASE64EncodedString()
                             throws FSMsgException

Returns a Base64 Encoded String.

戻り値:

a Base64 Encoded String.

例外:

FSMsgException - if there is an error encoding the string.

signXML

public void signXML()

クラス AbstractRequest の記述:

An abstract method to sign the object.

定義:

クラス AbstractRequest 内の signXML

signXML

public void signXML(String certAlias)
             throws SAMLException

Signs the FSNameRegistrationRequest object.

パラメータ:

certAlias - the Certificate Alias.

例外:

SAMLException - if this object cannot be signed.

setSignature

public boolean setSignature(Element elem)

Sets the Signature.

オーバーライド:

クラス AbstractRequest 内の setSignature

パラメータ:

elem - the Document Element.

戻り値:

true if success otherwise false.

toURLEncodedQueryString

public String toURLEncodedQueryString()
                               throws FSMsgException

Returns an URL Encoded String.

戻り値:

a url encoded query string.

例外:

FSMsgException - if there is an error.

parseURLEncodedRequest

public static FSNameRegistrationRequest parseURLEncodedRequest(HttpServletRequest request)
                                                        throws FSMsgException,
                                                               SAMLException

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

パラメータ:

request - the HttpServletRequest object.

例外:

FSMsgException - if there is an error creating this object.

SAMLException - if there is an error.