概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド

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

java.lang.Object
  上位を拡張 com.sun.identity.saml.protocol.AbstractRequest
      上位を拡張 com.sun.identity.federation.message.FSFederationTerminationNotification

public class FSFederationTerminationNotification
extends AbstractRequest

This class has methods for creating object and message for Federation Termination.

フィールドの概要
protected  String id
           
protected  String signatureString
           
protected  String xmlString
           
 
クラス com.sun.identity.saml.protocol.AbstractRequest から継承されたフィールド
issueInstant, majorVersion, minorVersion, requestID, respondWiths, signature, signed, valid
 
コンストラクタの概要
FSFederationTerminationNotification()
          Default Constructor.
FSFederationTerminationNotification(Element root)
          Creates FSFederationTerminationNotification from a Document Element.
FSFederationTerminationNotification(String requestId, String providerID, NameIdentifier nameId)
          Creates FSFederationTerminationNotification 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 the value of ProviderID attribute.
 String getRelayState()
          Returns the value of RelayState attribute.
static FSFederationTerminationNotification parseURLEncodedRequest(HttpServletRequest request)
          Returns FSFederationTerminationNotification object.
static FSFederationTerminationNotification parseXML(String xml)
          Returns the FSAuthnRequest object.
 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 the value of ProviderID attribute.
 void setRelayState(String relayState)
          Set the value of RelayState attribute.
 boolean setSignature(Element elem)
          Sets the Element signature.
 void signXML()
          Unsupported operation.
 void signXML(String certAlias)
          Signs the FSFederationTerminationNotification.
 String toBASE64EncodedString()
          Returns a Base64 encoded string representing this object.
 String toURLEncodedQueryString()
          Returns an URL encoded query 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 a String representation of the <samlp:Response> 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

id

protected String id
コンストラクタの詳細

FSFederationTerminationNotification

public FSFederationTerminationNotification()
Default Constructor.

FSFederationTerminationNotification

public FSFederationTerminationNotification(Element root)
                                    throws FSMsgException
Creates FSFederationTerminationNotification from a Document Element.

パラメータ:
root - the Document Element.
例外:
FSMsgException - if there is an error creating this object.

FSFederationTerminationNotification

public FSFederationTerminationNotification(String requestId,
                                           String providerID,
                                           NameIdentifier nameId)
                                    throws FSMsgException
Creates FSFederationTerminationNotification object.

パラメータ:
requestId - the request identifier.
providerID - the provider identifier.
nameId - the NameIdentifier object.
例外:
FSMsgException - if there is an error creating this object.
メソッドの詳細

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException
Returns the string representation of this object. This method translates the response to an XML document string based on the Response schema described above.

戻り値:
An XML String representing the response. NOTE: this is a complete SAML response xml string with ResponseID, MajorVersion, etc.
例外:
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 <samlp:Response> 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 converting this object ot a string.

toXMLString

public String toXMLString()
                   throws FSMsgException
Returns the string representation of this object. This method translates the response to an XML document string.

戻り値:
An XML String representing the response. NOTE: this is a complete SAML response xml string with ResponseID, MajorVersion, etc.
例外:
FSMsgException

parseXML

public static FSFederationTerminationNotification parseXML(String xml)
                                                    throws FSMsgException
Returns the FSAuthnRequest object.

パラメータ:
xml - the XML string to be parsed.
戻り値:
FSAuthnRequest object created from the XML string.
例外:
FSMsgException - if there is error creating the object.

getID

public String getID()
Returns the value of id attribute.

戻り値:
the value of id attribute.
関連項目:
FSFederationTerminationNotification.setID(String)

setID

public void setID(String id)
Sets the value of id attribute.

パラメータ:
id - the value of id attribute.
関連項目:
FSFederationTerminationNotification.getID()

setRelayState

public void setRelayState(String relayState)
Set the value of RelayState attribute.

パラメータ:
relayState - the value of RelayState attribute.
関連項目:
FSFederationTerminationNotification.getRelayState()

getRelayState

public String getRelayState()
Returns the value of RelayState attribute.

戻り値:
the value of RelayState attribute.
関連項目:
FSFederationTerminationNotification.setRelayState(String)

getMinorVersion

public int getMinorVersion()
Returns the value of MinorVersion attribute.

オーバーライド:
クラス AbstractRequest 内の getMinorVersion
戻り値:
the value of MinorVersion attribute.
関連項目:
FSFederationTerminationNotification.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)
Sets the value of MinorVersion attribute.

オーバーライド:
クラス AbstractRequest 内の setMinorVersion
パラメータ:
version - the value of MinorVersion attribute.
関連項目:
FSFederationTerminationNotification.getMinorVersion()

getProviderId

public String getProviderId()
Returns the value of ProviderID attribute.

戻り値:
the value of ProviderID attribute.
関連項目:
FSFederationTerminationNotification.setProviderId(String).

setProviderId

public void setProviderId(String providerID)
Sets the value of ProviderID attribute.

パラメータ:
providerID - the value of ProviderID attribute.
関連項目:
FSFederationTerminationNotification.getProviderId()

getNameIdentifier

public NameIdentifier getNameIdentifier()
Returns the NameIdentifier object.

戻り値:
the NameIdentifier object.

setNameIdentifier

public void setNameIdentifier(NameIdentifier nameId)
Sets the NameIdentifier object.

パラメータ:
nameId - the NameIdentifier object.

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 representing this object.

戻り値:
a Base64 encoded string representing this object.
例外:
FSMsgException - if there is an error creating a Base64 encoded string.

parseURLEncodedRequest

public static FSFederationTerminationNotification parseURLEncodedRequest(HttpServletRequest request)
                                                                  throws FSMsgException,
                                                                         SAMLException
Returns FSFederationTerminationNotification object. The object is creating by parsing the HttpServletRequest object.

パラメータ:
request - the HttpServletRequest object.
例外:
FSMsgException - if there is an error creating FSFederationTerminationNotification object.
SAMLException

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 FSFederationTerminationNotification. 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
概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド