|
|||||||||
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.FSFederationTerminationNotification
public class FSFederationTerminationNotification
This class has methods for creating object and message for Federation Termination.
Field Summary | |
---|---|
protected String |
id
|
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 | |
---|---|
FSFederationTerminationNotification()
Default Constructor. |
|
FSFederationTerminationNotification(Element root)
Creates FSFederationTerminationNotification |
|
FSFederationTerminationNotification(String requestId,
String providerID,
NameIdentifier nameId)
Creates FSFederationTerminationNotification 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 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. |
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 xmlString
protected String signatureString
protected String id
Constructor Detail |
---|
public FSFederationTerminationNotification()
public FSFederationTerminationNotification(Element root) throws FSMsgException
FSFederationTerminationNotification
public FSFederationTerminationNotification(String requestId, String providerID, NameIdentifier nameId) throws FSMsgException
FSFederationTerminationNotification
object.
requestId
- the request identifier.providerID
- the provider identifier.nameId
- the NameIdentifier
object.
FSMsgException
- if there is an error creating
this object.Method Detail |
---|
public String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
FSMsgException
- if there is an error converting
this object ot a string.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.
FSMsgException
- if there is an error converting
this object ot a string.public String toXMLString() throws FSMsgException
FSMsgException
public static FSFederationTerminationNotification parseXML(String xml) throws FSMsgException
FSAuthnRequest
object.
xml
- the XML string to be parsed.
FSAuthnRequest
object created from the XML string.
FSMsgException
- if there is
error creating the object.public String getID()
id
attribute.
id
attribute.FSFederationTerminationNotification.setID(String)
public void setID(String id)
id
attribute.
id
- the value of id
attribute.FSFederationTerminationNotification.getID()
public void setRelayState(String relayState)
RelayState
attribute.
relayState
- the value of RelayState
attribute.FSFederationTerminationNotification.getRelayState()
public String getRelayState()
RelayState
attribute.
RelayState
attribute.FSFederationTerminationNotification.setRelayState(String)
public int getMinorVersion()
MinorVersion
attribute.
getMinorVersion
in class AbstractRequest
MinorVersion
attribute.FSFederationTerminationNotification.setMinorVersion(int)
public void setMinorVersion(int version)
MinorVersion
attribute.
setMinorVersion
in class AbstractRequest
version
- the value of MinorVersion
attribute.FSFederationTerminationNotification.getMinorVersion()
public String getProviderId()
ProviderID
attribute.
ProviderID
attribute.FSFederationTerminationNotification.setProviderId(String).
public void setProviderId(String providerID)
ProviderID
attribute.
providerID
- the value of ProviderID
attribute.FSFederationTerminationNotification.getProviderId()
public NameIdentifier getNameIdentifier()
NameIdentifier
object.
NameIdentifier
object.public void setNameIdentifier(NameIdentifier nameId)
NameIdentifier
object.
nameId
- the NameIdentifier
object.public String toURLEncodedQueryString() throws FSMsgException
URL
encoded query string.
URL
encoded query string.
FSMsgException
- if there is an error.public String toBASE64EncodedString() throws FSMsgException
Base64
encoded string representing this
object.
Base64
encoded string representing this
object.
FSMsgException
- if there is an error creating
a Base64
encoded string.public static FSFederationTerminationNotification parseURLEncodedRequest(HttpServletRequest request) throws FSMsgException, SAMLException
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
public void signXML() throws SAMLException
signXML
in class AbstractRequest
SAMLException
- If could not sign the object.public void signXML(String certAlias) throws SAMLException
FSFederationTerminationNotification
.
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 |