|
|||||||||
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
public class FSLogoutNotification
This class contains methods to construct a LogoutRequest
object.
Field Summary | |
---|---|
protected String |
id
|
protected Date |
notOnOrAfter
|
protected String |
sessionIndex
|
protected String |
signatureString
|
protected String |
xmlString
|
Fields inherited from class com.sun.identity.saml.protocol.AbstractRequest |
---|
issueInstant, majorVersion, minorVersion, requestID, respondWiths, signature, signed, valid |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
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. |
Methods inherited from class com.sun.identity.saml.protocol.AbstractRequest |
---|
addRespondWith, getIssueInstant, getMajorVersion, getRequestID, getRespondWith, getSignature, isSignatureValid, isSigned, setIssueInstant, setMajorVersion, setRequestID |
Field Detail |
---|
protected String sessionIndex
protected String xmlString
protected String signatureString
protected String id
protected Date notOnOrAfter
Constructor Detail |
---|
public FSLogoutNotification()
public FSLogoutNotification(Element root) throws FSMsgException
FSLogoutNotification
object
from Document Element.
root
- the Document Element object.
FSMsgException
- if there is an error creating this
object.public FSLogoutNotification(String requestId, String providerID, NameIdentifier nameId, String relayState) throws FSMsgException
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.Method Detail |
---|
public String getID()
id
attribute.
id
attribute.FSLogoutNotification.setID(String)
public void setID(String id)
id
attribute.
id
- the value of id
attribute.FSLogoutNotification.getID()
public void setRelayState(String relayState)
RelayState
attribute.
relayState
- the value of RelayState
attribute.public String getRelayState()
RelayState
attribute.
RelayState
attribute.public String getSignatureString()
XML
string.
XML
string.public int getMinorVersion()
MinorVersion
attribute.
getMinorVersion
in class AbstractRequest
MinorVersion
attribute.FSLogoutNotification.setMinorVersion(int)
public void setMinorVersion(int version)
MinorVersion
attribute.
setMinorVersion
in class AbstractRequest
version
- the value of MinorVersion
attribute.FSLogoutNotification.getMinorVersion()
public 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.
XML
for this element
FSMsgException
- if there is an error creating
XML
string from this object.public 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.
XML
for this element
FSMsgException
- if there is an error creating
XML
string from this object.public String toXMLString() throws FSMsgException
XML
for this element
FSMsgException
- if there is an error creating
XML
string from this object.public static FSLogoutNotification parseXML(String xml) throws FSMsgException
FSLogoutNotification
from a
XML
string.
xml
- the XML
string.
FSMsgException
- if there is an error creating
this object.public String getProviderId()
ProviderID
attribute.
ProviderID
attribute.FSLogoutNotification.setProviderId(String)
public void setProviderId(String providerID)
ProviderID
attribute.
providerID
- value of ProviderID
attribute.FSLogoutNotification.getProviderId()
public String getSessionIndex()
SessionIndex
attribute.
SessionIndex
attribute.FSLogoutNotification.setSessionIndex(String)
public void setSessionIndex(String sessionIndex)
SessionIndex
attribute.
sessionIndex
- value of SessionIndex
attribute.FSLogoutNotification.getSessionIndex()
public NameIdentifier getNameIdentifier()
NameIdentifier
object.
NameIdentifier
object.FSLogoutNotification.setNameIdentifier(NameIdentifier)
public void setNameIdentifier(NameIdentifier nameId)
NameIdentifier
object.
nameId
- the NameIdentifier
object.FSLogoutNotification.getNameIdentifier()
public String toURLEncodedQueryString() throws FSMsgException
FSMsgException
- if there is an error.public String toBASE64EncodedString() throws FSMsgException
FSMsgException
- if there is an error encoding
the string.public static FSLogoutNotification parseURLEncodedRequest(HttpServletRequest request) throws FSMsgException
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.public void signXML() throws SAMLException
signXML
in class AbstractRequest
SAMLException
- If could not sign the object.public void signXML(String certAlias) throws SAMLException
FSLogoutNotification
object.
certAlias
- the Certificate Alias
SAMLException
- if
FSFederationTerminationNotification
cannot be signed.public boolean setSignature(Element elem)
Element
signature.
setSignature
in class AbstractRequest
elem
- the Element
object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |