|
|||||||||
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
public class FSLogoutResponse
This class has methods to create a Liberty LogoutResponse
.
Field Summary | |
---|---|
protected String |
id
|
protected String |
signatureString
|
protected String |
xmlString
|
Fields inherited from class com.sun.identity.saml.protocol.AbstractResponse |
---|
issueInstant, majorVersion, minorVersion, recipient, responseID, signature, signed, valid, validationDone |
Constructor Summary | |
---|---|
FSLogoutResponse()
Default Constructor. |
|
FSLogoutResponse(Element root)
Constructor creates FSLogoutResponse object from
a Document element. |
|
FSLogoutResponse(String responseID,
String inResponseTo,
Status status,
String providerId,
String relayState)
Constructor creates FSLogoutResponse object. |
Method Summary | |
---|---|
String |
getID()
Returns the value of id attribute. |
int |
getMinorVersion()
Returns the value of MinorVersion attribute. |
String |
getProviderId()
Returns the value of ProviderID attribute. |
String |
getRelayState()
Returns the value of RelayState attribute. |
String |
getResponseTo()
Returns the value of InResponseTo attribute. |
String |
getSignatureString()
Returns the Signed LogoutResponse string. |
Status |
getStatus()
Returns the Logout Status . |
static FSLogoutResponse |
parseBASE64EncodedString(String encodedRes)
Returns FSLogoutResponse object. |
static FSLogoutResponse |
parseURLEncodedRequest(HttpServletRequest request)
Returns FSLogoutResponse object. |
static FSLogoutResponse |
parseXML(String xml)
Returns the FSLogoutResponse object. |
void |
setID(String id)
Sets the value of id attribute. |
void |
setMinorVersion(int version)
Sets the value of MinorVersion attribute. |
void |
setProviderId(String providerId)
Sets the value of ProviderID attribute. |
void |
setRelayState(String relayState)
Set the value of RelayState attribute. |
void |
setResponseTo(String inResponseTo)
Sets the value of InResponseTo attribute. |
boolean |
setSignature(Element elem)
Sets the Signature. |
void |
setStatus(Status status)
Sets the Logout Status . |
void |
setStatus(String status)
Sets the Logout Status . |
void |
signXML()
Unsupported operation. |
void |
signXML(String certAlias)
Signs the LogoutResponse . |
String |
toBASE64EncodedString()
Returns a Base64 Encoded String. |
String |
toURLEncodedQueryString()
Returns an URL Encoded String. |
String |
toXMLString()
Returns a String representation of the LogoutResponse
object. |
String |
toXMLString(boolean includeNS,
boolean declareNS)
Returns a String representation of the LogoutResponse
object. |
String |
toXMLString(boolean includeNS,
boolean declareNS,
boolean includeHeader)
Returns a String representation of the LogoutResponse
object. |
Methods inherited from class com.sun.identity.saml.protocol.AbstractResponse |
---|
getInResponseTo, getIssueInstant, getMajorVersion, getRecipient, getResponseID, getSignature, isSignatureValid, isSigned, setInResponseTo, setIssueInstant, setMajorVersion, setRecipient, setResponseID |
Field Detail |
---|
protected String xmlString
protected String signatureString
protected String id
Constructor Detail |
---|
public FSLogoutResponse()
public FSLogoutResponse(String responseID, String inResponseTo, Status status, String providerId, String relayState) throws FSMsgException
FSLogoutResponse
object.
responseID
- the value of ResponseID
attribute.inResponseTo
- the value of inResponseTo
attribute.status
- the Logout Status
object.providerId
- the value of ProviderID
attribute.relayState
- the value of RelayState
attribute.
FSMsgException
- if this object cannot be created.
FSMsgException
public FSLogoutResponse(Element root) throws FSMsgException, SAMLException
FSLogoutResponse
object from
a Document element.
root
- the Document element object.
FSMsgException
- if this object cannot be created.
SAMLException
- if there is an error.Method Detail |
---|
public String getRelayState()
RelayState
attribute.
RelayState
attribute.FSLogoutResponse.setRelayState(String)
public void setRelayState(String relayState)
RelayState
attribute.
relayState
- the value of RelayState
attribute.FSLogoutResponse.getRelayState()
public String getResponseTo()
InResponseTo
attribute.
InResponseTo
attribute.FSLogoutResponse.setResponseTo(String)
public void setResponseTo(String inResponseTo)
InResponseTo
attribute.
inResponseTo
- the value of InResponseTo
attribute.FSLogoutResponse.getResponseTo()
public String getID()
id
attribute.
id
attribute.FSLogoutResponse.setID(String)
public void setID(String id)
id
attribute.
id
- the value of id
attribute.FSLogoutResponse.getID()
public String getProviderId()
ProviderID
attribute.
ProviderID
attribute.FSLogoutResponse.setProviderId(String).
public void setProviderId(String providerId)
ProviderID
attribute.
providerId
- the value of ProviderID
attribute.FSLogoutResponse.getProviderId()
public String getSignatureString()
LogoutResponse
string.
LogoutResponse
string.public int getMinorVersion()
MinorVersion
attribute.
getMinorVersion
in class AbstractResponse
MinorVersion
attribute.FSLogoutResponse.setMinorVersion(int)
public void setMinorVersion(int version)
MinorVersion
attribute.
setMinorVersion
in class AbstractResponse
version
- thevalue of MinorVersion
attribute.FSLogoutResponse.getMinorVersion()
public Status getStatus()
Status
.
Status
.FSLogoutResponse.setStatus(String)
,
FSLogoutResponse.setStatus(Status)
public void setStatus(String status)
Status
.
status
- the Logout Status
See Also:FSLogoutResponse.getStatus()
public void setStatus(Status status)
Status
.
status
- the Logout Status
See Also:FSLogoutResponse.getStatus()
public static FSLogoutResponse parseXML(String xml) throws FSMsgException
FSLogoutResponse
object.
xml
- the XML string to be parsed.
FSLogoutResponse
object created from the XML string.
FSMsgException
- if there is
error creating the object.public String toXMLString() throws FSMsgException
LogoutResponse
object. This method translates the response to an XML string.
FSMsgException
public String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
LogoutResponse
object.
FSMsgException
- if there is an error converting
this object ot a string.public String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) throws FSMsgException
LogoutResponse
object.
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 there is an error converting
this object ot a string.public static FSLogoutResponse parseBASE64EncodedString(String encodedRes) throws FSMsgException, SAMLException
FSLogoutResponse
object. The object
is created by parsing an Base64 encode authentication
request String.
encodedRes
- the encode string
FSMsgException
- if there is an error creating this object.
SAMLException
- if there is an error creating this object.public String toBASE64EncodedString() throws FSMsgException
FSMsgException
- if there is an error encoding the string.public void signXML()
signXML
in class AbstractResponse
public void signXML(String certAlias) throws SAMLException
LogoutResponse
.
certAlias
- the Certificate Alias.
XMLSignatureException
- if this object cannot be signed.
SAMLException
public boolean setSignature(Element elem)
setSignature
in class AbstractResponse
elem
- the Document Element.
public String toURLEncodedQueryString() throws FSMsgException
FSMsgException
- if there is an error.public static FSLogoutResponse parseURLEncodedRequest(HttpServletRequest request) throws FSMsgException, SAMLException
FSLogoutResponse
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |