|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.saml.protocol.AbstractRequest com.sun.identity.federation.message.FSLogoutNotification
This class FSLogoutNotification
is used to construct/parse
a ID-FF single logout notification element.
Constructor Summary | |
FSLogoutNotification()
Default constructor |
|
FSLogoutNotification(org.w3c.dom.Element root)
Constructor |
|
FSLogoutNotification(java.lang.String requestId,
java.lang.String providerID,
NameIdentifier nameId,
java.lang.String relayState)
Constructor |
Method Summary | |
java.lang.String |
getID()
Gets id attribute. |
int |
getMinorVersion()
Gets minor version |
NameIdentifier |
getNameIdentifier()
Gets name identifier. |
java.lang.String |
getProviderId()
Gets provider ID for this notification. |
java.lang.String |
getRelayState()
Gets RelayState parameter |
java.lang.String |
getSessionIndex()
Gets SessionIndex attribute. |
java.lang.String |
getSignatureString()
Get the Signature Element as string |
java.lang.String |
getSignedXMLString()
Get Signed XML String |
static FSLogoutNotification |
parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request)
Creates the FSLogoutNotification from
URL encoded string. |
static FSLogoutNotification |
parseXML(java.lang.String xml)
Creates the FSLogoutNotification on XML String |
void |
setID(java.lang.String id)
Sets id attribute. |
void |
setMinorVersion(int version)
Sets minor version |
void |
setNameIdentifier(NameIdentifier nameId)
Sets name identifier. |
void |
setProviderId(java.lang.String providerID)
Sets provider ID for this notification. |
void |
setRelayState(java.lang.String relayState)
Sets RelayState parameter |
void |
setSessionIndex(java.lang.String sessionIndex)
Sets SessionIndex attribute. |
boolean |
setSignature(org.w3c.dom.Element elem)
Sets the Signature . |
void |
signXML()
Signs the FSLogoutNotification |
void |
signXML(java.lang.String certAlias)
Signs the LogoutNotification object. |
java.lang.String |
toBASE64EncodedString()
Gets the BASE 64 encoded string representation of the 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 Response element. |
java.lang.String |
toXMLString(boolean includeNS,
boolean declareNS)
Gets a String representation of the object. |
java.lang.String |
toXMLString(boolean includeNS,
boolean declareNS,
boolean includeHeader)
Gets a String representation of the Response element. |
Methods inherited from class com.sun.identity.saml.protocol.AbstractRequest |
addRespondWith, getIssueInstant, getMajorVersion, getRequestID, getRespondWith, getSignature, isSignatureValid, isSigned, setIssueInstant, setMajorVersion, setRequestID |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FSLogoutNotification()
public FSLogoutNotification(org.w3c.dom.Element root) throws FSMsgException
root
- DOM Element representing the LogoutNotification
FSMsgException
- if error occurs.public FSLogoutNotification(java.lang.String requestId, java.lang.String providerID, NameIdentifier nameId, java.lang.String relayState) throws FSMsgException
requestId
- If it's null, the constructor will create one.providerID
- provider IDnameId
- name identifierrelayState
- relay state
FSMsgException
- if unable to construct the objectMethod Detail |
public java.lang.String getID()
public void setID(java.lang.String id)
id
- id to be set.public java.lang.String getRelayState()
RelayState
parameter
RelayState
parameterpublic void setRelayState(java.lang.String relayState)
RelayState
parameter
public java.lang.String getSignedXMLString()
FSLogoutNotification
is not signed.public java.lang.String getSignatureString()
FSLogoutNotification
is not signed.public int getMinorVersion()
getMinorVersion
in class AbstractRequest
public void setMinorVersion(int version)
setMinorVersion
in class AbstractRequest
version
- minor version to be setpublic java.lang.String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
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
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 java.lang.String toXMLString() throws FSMsgException
FSMsgException
- if unable to get the XML string.public static FSLogoutNotification parseXML(java.lang.String xml) throws FSMsgException
FSLogoutNotification
on XML String
xml
- XML string representing the FSLogoutNotification
object.
FSLogoutNotification
object
FSMsgException
- if unable to construct the objectpublic java.lang.String getProviderId()
public void setProviderId(java.lang.String providerID)
providerID
- provider ID to be set.public java.lang.String getSessionIndex()
SessionIndex
attribute.
SessionIndex
attribute.public void setSessionIndex(java.lang.String sessionIndex)
SessionIndex
attribute.
sessionIndex
- session index to be set.public NameIdentifier getNameIdentifier()
public void setNameIdentifier(NameIdentifier nameId)
nameId
- name identifier to be set.public java.lang.String toURLEncodedQueryString() throws FSMsgException
FSMsgException
- if unable to get the URL encoded string.public java.lang.String toBASE64EncodedString() throws FSMsgException
FSMsgException
- if unable to get the BASE 64 encoded string.public static FSLogoutNotification parseURLEncodedRequest(javax.servlet.http.HttpServletRequest request) throws FSMsgException
FSLogoutNotification
from
URL encoded string.
request
- HttpServletRequest
to get the URL encoded
parameters.
FSLogoutNotification
object.
FSMsgException
- if unable to create the object.public void signXML(java.lang.String certAlias) throws SAMLException
LogoutNotification
object.
certAlias
- alias of the certificate used to sign the
LogoutNotification
object.
SAMLException
- if it could not sign the
LogoutNotification
object.public void signXML() throws SAMLException
FSLogoutNotification
signXML
in class AbstractRequest
SAMLException
- if it could not sign the
LogoutNotification
object.public boolean setSignature(org.w3c.dom.Element elem)
Signature
.
setSignature
in class AbstractRequest
elem
- Signature element.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |