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

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

public class FSLogoutNotification
extends AbstractRequest

This class contains methods to construct a LogoutRequest object.

フィールドの概要

protected String	id
protected Date	notOnOrAfter
protected String	sessionIndex
protected String	signatureString
protected String	xmlString

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

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

コンストラクタの概要

FSLogoutNotification()
Default Constructor.

FSLogoutNotification(Element root)
Constructor creates FSLogoutNotification object from Document Element.

FSLogoutNotification(String requestId, String providerID, NameIdentifier nameId, String relayState)
Consturctor creates FSLogoutNotification object.

メソッドの概要

String	getID() Returns the value of id attribute.
int	getMinorVersion() Returns the value of MinorVersion attribute.
NameIdentifier	getNameIdentifier() Returns the NameIdentifier object.
String	getProviderId() Returns value of ProviderID attribute.
String	getRelayState() Returns the value of RelayState attribute.
String	getSessionIndex() Returns value of SessionIndex attribute.
String	getSignatureString() Returns a signed XML string.
static FSLogoutNotification	parseURLEncodedRequest(HttpServletRequest request) Returns FSLogoutNotification object.
static FSLogoutNotification	parseXML(String xml) Constructor create FSLogoutNotification from a XML string.
void	setID(String id) Sets the value of id attribute.
void	setMinorVersion(int version) Sets the value of MinorVersion attribute.
void	setNameIdentifier(NameIdentifier nameId) Sets the NameIdentifier object.
void	setProviderId(String providerID) Sets value of ProviderID attribute.
void	setRelayState(String relayState) Sets the value of RelayState attribute.
void	setSessionIndex(String sessionIndex) Sets value of SessionIndex attribute.
boolean	setSignature(Element elem) Sets the Element signature.
void	signXML() Unsupported operation.
void	signXML(String certAlias) Signs the FSLogoutNotification object.
String	toBASE64EncodedString() Returns a Base64 Encoded String.
String	toURLEncodedQueryString() Returns an URL Encoded String.
String	toXMLString() Returns the string representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS) Returns the string representation of this object.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Returns the string representation of this object.

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

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

フィールドの詳細

sessionIndex

protected String sessionIndex

xmlString

protected String xmlString

signatureString

protected String signatureString

id

protected String id

notOnOrAfter

protected Date notOnOrAfter

コンストラクタの詳細

FSLogoutNotification

public FSLogoutNotification()

Default Constructor.

FSLogoutNotification

public FSLogoutNotification(Element root)
                     throws FSMsgException

Constructor creates FSLogoutNotification object from Document Element.

パラメータ:

root - the Document Element object.

例外:

FSMsgException - if there is an error creating this object.

FSLogoutNotification

public FSLogoutNotification(String requestId,
                            String providerID,
                            NameIdentifier nameId,
                            String relayState)
                     throws FSMsgException

Consturctor creates FSLogoutNotification object.

パラメータ:

requestId - the RequestId attribute.

providerID - the ProviderID attribute.

nameId - the NameIdentifier object.

relayState - the RelayState attribute.

例外:

FSMsgException - if there is an error creating this object.

メソッドの詳細

getID

public String getID()

Returns the value of id attribute.

戻り値:

the value of id attribute.

関連項目:

FSLogoutNotification.setID(String)

setID

public void setID(String id)

Sets the value of id attribute.

パラメータ:

id - the value of id attribute.

関連項目:

FSLogoutNotification.getID()

setRelayState

public void setRelayState(String relayState)

Sets the value of RelayState attribute.

パラメータ:

relayState - the value of RelayState attribute.

getRelayState

public String getRelayState()

Returns the value of RelayState attribute.

戻り値:

the value of RelayState attribute.

getSignatureString

public String getSignatureString()

Returns a signed XML string.

戻り値:

a signed XML string.

getMinorVersion

public int getMinorVersion()

Returns the value of MinorVersion attribute.

オーバーライド:

クラス AbstractRequest 内の getMinorVersion

戻り値:

the value of MinorVersion attribute.

関連項目:

FSLogoutNotification.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Sets the value of MinorVersion attribute.

オーバーライド:

クラス AbstractRequest 内の setMinorVersion

パラメータ:

version - the value of MinorVersion attribute.

関連項目:

FSLogoutNotification.getMinorVersion()

toXMLString

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

Returns the string representation of this object.

パラメータ:

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 creating XML string from this object.

toXMLString

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

Returns the string representation of this object.

パラメータ:

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 creating XML string from this object.

toXMLString

public String toXMLString()
                   throws FSMsgException

Returns the string representation of this object.

戻り値:

a string containing the valid XML for this element

例外:

FSMsgException - if there is an error creating XML string from this object.

parseXML

public static FSLogoutNotification parseXML(String xml)
                                     throws FSMsgException

Constructor create FSLogoutNotification from a XML string.

パラメータ:

xml - the XML string.

例外:

FSMsgException - if there is an error creating this object.

getProviderId

public String getProviderId()

Returns value of ProviderID attribute.

戻り値:

value of ProviderID attribute.

関連項目:

FSLogoutNotification.setProviderId(String)

setProviderId

public void setProviderId(String providerID)

Sets value of ProviderID attribute.

パラメータ:

providerID - value of ProviderID attribute.

関連項目:

FSLogoutNotification.getProviderId()

getSessionIndex

public String getSessionIndex()

Returns value of SessionIndex attribute.

戻り値:

value of SessionIndex attribute.

関連項目:

FSLogoutNotification.setSessionIndex(String)

setSessionIndex

public void setSessionIndex(String sessionIndex)

Sets value of SessionIndex attribute.

パラメータ:

sessionIndex - value of SessionIndex attribute.

関連項目:

FSLogoutNotification.getSessionIndex()

getNameIdentifier

public NameIdentifier getNameIdentifier()

Returns the NameIdentifier object.

戻り値:

the NameIdentifier object.

関連項目:

FSLogoutNotification.setNameIdentifier(NameIdentifier)

setNameIdentifier

public void setNameIdentifier(NameIdentifier nameId)

Sets the NameIdentifier object.

パラメータ:

nameId - the NameIdentifier object.

関連項目:

FSLogoutNotification.getNameIdentifier()

toURLEncodedQueryString

public String toURLEncodedQueryString()
                               throws FSMsgException

Returns an URL Encoded 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 FSLogoutNotification parseURLEncodedRequest(HttpServletRequest request)
                                                   throws FSMsgException

Returns FSLogoutNotification object. The object is created by parsing the HttpServletRequest object.

パラメータ:

request - the HttpServletRequest object.

戻り値:

FSLogoutNotification object.

例外:

FSMsgException - if there is an error creating FSAuthnRequest object.

signXML

public void signXML()
             throws SAMLException

Unsupported operation.

定義:

クラス AbstractRequest 内の signXML

例外:

SAMLException - If could not sign the object.

signXML

public void signXML(String certAlias)
             throws SAMLException

Signs the FSLogoutNotification object.

パラメータ:

certAlias - the Certificate Alias

例外:

SAMLException - if FSFederationTerminationNotification cannot be signed.

setSignature

public boolean setSignature(Element elem)

Sets the Element signature.

オーバーライド:

クラス AbstractRequest 内の setSignature

パラメータ:

elem - the Element object

戻り値:

true if signature is set otherwise false