|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.saml.protocol.AbstractResponse com.sun.identity.federation.message.FSLogoutResponse
this class FSLogoutResponse
is used to construct/parse a
federation single logout response element.
Constructor Summary | |
FSLogoutResponse()
Default constructor |
|
FSLogoutResponse(org.w3c.dom.Element root)
Constructor |
|
FSLogoutResponse(java.lang.String responseID,
java.lang.String inResponseTo,
Status status,
java.lang.String providerId,
java.lang.String relayState)
Constructor |
Method Summary | |
java.lang.String |
getID()
Gets id attribute, this applies to ID-FF 1.1 only. |
int |
getMinorVersion()
Gets minor version |
java.lang.String |
getProviderId()
Gets provider ID for this notification. |
java.lang.String |
getRelayState()
Gets RelayState parameter |
java.lang.String |
getResponseTo()
Gets inResponseTo attribute. |
java.lang.String |
getSignatureString()
Get the Signature Element as string |
java.lang.String |
getSignedXMLString()
Get Signed XML String |
Status |
getStatus()
Gets the status object |
static FSLogoutResponse |
parseBASE64EncodedString(java.lang.String encodedRes)
Creates the response object based on the BASE 64 encoded string. |
static FSLogoutResponse |
parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request)
Creates the FSLogoutResponse from
URL encoded string. |
static FSLogoutResponse |
parseXML(java.lang.String xml)
Creates the LogoutResponse object from the XML string |
void |
setID(java.lang.String id)
Sets id attribute, this applies to ID-FF 1.1 only. |
void |
setMinorVersion(int version)
Sets minor version |
void |
setProviderId(java.lang.String providerId)
Sets provider ID for this notification. |
void |
setRelayState(java.lang.String relayState)
Sets RelayState parameter |
void |
setResponseTo(java.lang.String inResponseTo)
Sets inResponseTo attribute. |
boolean |
setSignature(org.w3c.dom.Element elem)
Sets the Signature element |
void |
setStatus(Status status)
Sets the status object |
void |
setStatus(java.lang.String status)
Sets the status |
void |
signXML()
Signs the Response. |
void |
signXML(java.lang.String certAlias)
Signs the response. |
java.lang.String |
toBASE64EncodedString()
Gets the BASE64 encoded string of the response object. |
java.lang.String |
toURLEncodedQueryString()
Gets the URL encoded query string representation of the object. |
java.lang.String |
toXMLString()
Gets a String representation of the LogoutResponse element. |
java.lang.String |
toXMLString(boolean includeNS,
boolean declareNS)
Gets a String representation of the LogoutResponse element. |
java.lang.String |
toXMLString(boolean includeNS,
boolean declareNS,
boolean includeHeader)
Gets a String representation of the LogoutResponse element. |
Methods inherited from class com.sun.identity.saml.protocol.AbstractResponse |
getInResponseTo, getIssueInstant, getMajorVersion, getRecipient, getResponseID, getSignature, isSignatureValid, isSigned, setInResponseTo, setIssueInstant, setMajorVersion, setRecipient, setResponseID |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FSLogoutResponse()
public FSLogoutResponse(java.lang.String responseID, java.lang.String inResponseTo, Status status, java.lang.String providerId, java.lang.String relayState) throws FSMsgException
responseID
- response idinResponseTo
- the RequestID
that this response is
corresponding.status
- response statusproviderId
- provider IDrelayState
- relay state
FSMsgException
- if unable to construct the objectpublic FSLogoutResponse(org.w3c.dom.Element root) throws FSMsgException, SAMLException
root
- DOM Element representing the LogoutResponse
FSMsgException
- if error occurs
SAMLException
- if error occursMethod Detail |
public java.lang.String getRelayState()
RelayState
parameter
RelayState
parameterpublic void setRelayState(java.lang.String relayState)
RelayState
parameter
relayState
- RelayState
parameter to be setpublic java.lang.String getResponseTo()
public void setResponseTo(java.lang.String inResponseTo)
inResponseTo
- attribute to be set.public java.lang.String getID()
public void setID(java.lang.String id)
id
- attribute to be set.public java.lang.String getProviderId()
public void setProviderId(java.lang.String providerId)
providerId
- provider ID to be set.public java.lang.String getSignedXMLString()
FSLogoutResponse
is not signed.public java.lang.String getSignatureString()
FSLogoutResponse
is not signed.public int getMinorVersion()
getMinorVersion
in class AbstractResponse
public void setMinorVersion(int version)
setMinorVersion
in class AbstractResponse
version
- minor version to be setpublic Status getStatus()
public void setStatus(java.lang.String status)
status
- string representing the Status objectpublic void setStatus(Status status)
status
- the status object to be setpublic static FSLogoutResponse parseXML(java.lang.String xml) throws FSMsgException
LogoutResponse
object from the XML string
xml
- XML String representing the LogoutResponse
object
LogoutResponse
object
FSMsgException
- if unable to construct the objectpublic java.lang.String toXMLString() throws FSMsgException
LogoutResponse
element.
FSMsgException
- if unable to get the XML string.public java.lang.String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
LogoutResponse
element.
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 unable to get the XML string.public java.lang.String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) throws FSMsgException
LogoutResponse
element.
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 unable to get the XML string.public static FSLogoutResponse parseBASE64EncodedString(java.lang.String encodedRes) throws FSMsgException, SAMLException
encodedRes
- BASE 64 encoded response.
FSLogoutResponse
object
FSMsgException
- if unable to get the BASE 64 encoded string
SAMLException
- if unable to get the BASE 64 encoded stringpublic java.lang.String toBASE64EncodedString() throws FSMsgException
FSMsgException
- if unable to get the encoded string.public void signXML(java.lang.String certAlias) throws SAMLException
certAlias
- certificate alias which will be used for signing,
SAMLException
- if could not sign the Response.public void signXML() throws SAMLException
signXML
in class AbstractResponse
SAMLException
- if could not sign the Response.public boolean setSignature(org.w3c.dom.Element elem)
setSignature
in class AbstractResponse
elem
- Signature element to be set.
public java.lang.String toURLEncodedQueryString() throws FSMsgException
FSMsgException
- if unable to get the URL encoded query string.public static FSLogoutResponse parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request) throws FSMsgException, SAMLException
FSLogoutResponse
from
URL encoded string.
request
- HttpServletRequest
to get the URL encoded
parameters.
FSLogoutResponse
object.
SAMLException
- if unable to create the object.
FSMsgException
- if unable to create the object.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |