Class FSFederationTerminationNotification
- java.lang.Object
-
- com.sun.identity.saml.protocol.AbstractRequest
-
- com.sun.identity.federation.message.FSFederationTerminationNotification
-
@Deprecated public class FSFederationTerminationNotification extends AbstractRequest
Deprecated.since 12.0.0This class has methods for creating object and message for Federation Termination.
-
-
Field Summary
Fields Modifier and Type Field Description protected StringidDeprecated.protected StringsignatureStringDeprecated.protected StringxmlStringDeprecated.-
Fields inherited from class com.sun.identity.saml.protocol.AbstractRequest
issueInstant, majorVersion, minorVersion, requestID, respondWiths, signature, signed, valid
-
-
Constructor Summary
Constructors Constructor Description FSFederationTerminationNotification()Deprecated.Default Constructor.FSFederationTerminationNotification(String requestId, String providerID, NameIdentifier nameId)Deprecated.CreatesFSFederationTerminationNotificationobject.FSFederationTerminationNotification(Element root)Deprecated.CreatesFSFederationTerminationNotification
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description StringgetID()Deprecated.Returns the value ofidattribute.intgetMinorVersion()Deprecated.Returns the value ofMinorVersionattribute.NameIdentifiergetNameIdentifier()Deprecated.Returns theNameIdentifierobject.StringgetProviderId()Deprecated.Returns the value ofProviderIDattribute.StringgetRelayState()Deprecated.Returns the value ofRelayStateattribute.static FSFederationTerminationNotificationparseURLEncodedRequest(jakarta.servlet.http.HttpServletRequest request)Deprecated.ReturnsFSFederationTerminationNotificationobject.static FSFederationTerminationNotificationparseXML(String xml)Deprecated.Returns theFSAuthnRequestobject.voidsetID(String id)Deprecated.Sets the value ofidattribute.voidsetMinorVersion(int version)Deprecated.Sets the value ofMinorVersionattribute.voidsetNameIdentifier(NameIdentifier nameId)Deprecated.Sets theNameIdentifierobject.voidsetProviderId(String providerID)Deprecated.Sets the value ofProviderIDattribute.voidsetRelayState(String relayState)Deprecated.Set the value ofRelayStateattribute.booleansetSignature(Element elem)Deprecated.Sets theElementsignature.voidsignXML()Deprecated.Unsupported operation.voidsignXML(String certAlias)Deprecated.Signs theFSFederationTerminationNotification.StringtoBASE64EncodedString()Deprecated.Returns aBase64encoded string representing this object.StringtoURLEncodedQueryString()Deprecated.Returns anURLencoded query string.StringtoXMLString()Deprecated.Returns the string representation of this object.StringtoXMLString(boolean includeNS, boolean declareNS)Deprecated.Returns the string representation of this object.StringtoXMLString(boolean includeNS, boolean declareNS, boolean includeHeader)Deprecated.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
-
-
-
-
Constructor Detail
-
FSFederationTerminationNotification
public FSFederationTerminationNotification()
Deprecated.Default Constructor.
-
FSFederationTerminationNotification
public FSFederationTerminationNotification(Element root) throws FSMsgException
Deprecated.CreatesFSFederationTerminationNotification- Parameters:
root- the Document Element.- Throws:
FSMsgException- if there is an error creating this object.
-
FSFederationTerminationNotification
public FSFederationTerminationNotification(String requestId, String providerID, NameIdentifier nameId) throws FSMsgException
Deprecated.CreatesFSFederationTerminationNotificationobject.- Parameters:
requestId- the request identifier.providerID- the provider identifier.nameId- theNameIdentifierobject.- Throws:
FSMsgException- if there is an error creating this object.
-
-
Method Detail
-
toXMLString
public String toXMLString(boolean includeNS, boolean declareNS) throws FSMsgException
Deprecated.Returns the string representation of this object. This method translates the response to an XML document string based on the Response schema described above.- Returns:
- An XML String representing the response. NOTE: this is a complete SAML response xml string with ResponseID, MajorVersion, etc.
- Throws:
FSMsgException- if there is an error converting this object ot a string.
-
toXMLString
public String toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) throws FSMsgException
Deprecated.Returns a String representation of the <samlp:Response> element.- Parameters:
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.- Returns:
- a string containing the valid XML for this element
- Throws:
FSMsgException- if there is an error converting this object ot a string.
-
toXMLString
public String toXMLString() throws FSMsgException
Deprecated.Returns the string representation of this object. This method translates the response to an XML document string.- Returns:
- An XML String representing the response. NOTE: this is a complete SAML response xml string with ResponseID, MajorVersion, etc.
- Throws:
FSMsgException
-
parseXML
public static FSFederationTerminationNotification parseXML(String xml) throws FSMsgException
Deprecated.Returns theFSAuthnRequestobject.- Parameters:
xml- the XML string to be parsed.- Returns:
FSAuthnRequestobject created from the XML string.- Throws:
FSMsgException- if there is error creating the object.
-
getID
public String getID()
Deprecated.Returns the value ofidattribute.- Returns:
- the value of
idattribute. - See Also:
setID(String)
-
setID
public void setID(String id)
Deprecated.Sets the value ofidattribute.- Parameters:
id- the value ofidattribute.- See Also:
getID()
-
setRelayState
public void setRelayState(String relayState)
Deprecated.Set the value ofRelayStateattribute.- Parameters:
relayState- the value ofRelayStateattribute.- See Also:
getRelayState()
-
getRelayState
public String getRelayState()
Deprecated.Returns the value ofRelayStateattribute.- Returns:
- the value of
RelayStateattribute. - See Also:
setRelayState(String)
-
getMinorVersion
public int getMinorVersion()
Deprecated.Returns the value ofMinorVersionattribute.- Overrides:
getMinorVersionin classAbstractRequest- Returns:
- the value of
MinorVersionattribute. - See Also:
setMinorVersion(int)
-
setMinorVersion
public void setMinorVersion(int version)
Deprecated.Sets the value ofMinorVersionattribute.- Overrides:
setMinorVersionin classAbstractRequest- Parameters:
version- the value ofMinorVersionattribute.- See Also:
getMinorVersion()
-
getProviderId
public String getProviderId()
Deprecated.Returns the value ofProviderIDattribute.- Returns:
- the value of
ProviderIDattribute.
-
setProviderId
public void setProviderId(String providerID)
Deprecated.Sets the value ofProviderIDattribute.- Parameters:
providerID- the value ofProviderIDattribute.- See Also:
getProviderId()
-
getNameIdentifier
public NameIdentifier getNameIdentifier()
Deprecated.Returns theNameIdentifierobject.- Returns:
- the
NameIdentifierobject.
-
setNameIdentifier
public void setNameIdentifier(NameIdentifier nameId)
Deprecated.Sets theNameIdentifierobject.- Parameters:
nameId- theNameIdentifierobject.
-
toURLEncodedQueryString
public String toURLEncodedQueryString() throws FSMsgException
Deprecated.Returns anURLencoded query string.- Returns:
- a
URLencoded query string. - Throws:
FSMsgException- if there is an error.
-
toBASE64EncodedString
public String toBASE64EncodedString() throws FSMsgException
Deprecated.Returns aBase64encoded string representing this object.- Returns:
- a
Base64encoded string representing this object. - Throws:
FSMsgException- if there is an error creating aBase64encoded string.
-
parseURLEncodedRequest
public static FSFederationTerminationNotification parseURLEncodedRequest(jakarta.servlet.http.HttpServletRequest request) throws FSMsgException, SAMLException
Deprecated.ReturnsFSFederationTerminationNotificationobject. The object is creating by parsing theHttpServletRequestobject.- Parameters:
request- theHttpServletRequestobject.- Throws:
FSMsgException- if there is an error creatingFSFederationTerminationNotificationobject.SAMLException
-
signXML
public void signXML() throws SAMLExceptionDeprecated.Unsupported operation.- Specified by:
signXMLin classAbstractRequest- Throws:
SAMLException- If could not sign the object.
-
signXML
public void signXML(String certAlias) throws SAMLException
Deprecated.Signs theFSFederationTerminationNotification. object- Parameters:
certAlias- the Certificate Alias- Throws:
SAMLException- ifFSFederationTerminationNotificationcannot be signed.
-
setSignature
public boolean setSignature(Element elem)
Deprecated.Sets theElementsignature.- Overrides:
setSignaturein classAbstractRequest- Parameters:
elem- theElementobject- Returns:
- true if signature is set otherwise false
-
-