Package com.sun.identity.federation.message

Class FSNameRegistrationRequest

  • @Deprecated
public class FSNameRegistrationRequest
extends AbstractRequest
    Deprecated.
    since 12.0.0
    This class contains methods to create NameRegistrationRequest object.

    • Field Detail

      • xmlString

        protected String xmlString
        Deprecated.

      • signatureString

        protected String signatureString
        Deprecated.

      • id

        protected String id
        Deprecated.

      • minorVersion

        protected int minorVersion
        Deprecated.

    • Constructor Detail

      • FSNameRegistrationRequest

        public FSNameRegistrationRequest()
        Deprecated.
        Default Constructor.

      • FSNameRegistrationRequest

        public FSNameRegistrationRequest​(String requestId,
                                 List respondWiths,
                                 String providerId,
                                 SPProvidedNameIdentifier spProvidedNameIdentifier,
                                 IDPProvidedNameIdentifier idpProvidedNameIdentifier,
                                 OldProvidedNameIdentifier oldProvidedNameIdentifier,
                                 String relayState)
                          throws FSMsgException
        Deprecated.
        Constructor creates the FSNameRegistrationRequest object.
        Parameters:
        requestId - the value of RequestID attribute.
        respondWiths - the value of RespondWiths attribute.
        providerId - the value of ProviderID attribute.
        spProvidedNameIdentifier - the Service Provider NameIdentifier.
        idpProvidedNameIdentifier - the Identity Provider NameIdentifier.
        oldProvidedNameIdentifier - the Original Provider NameIdentifier.
        relayState - the value of RelayState attribute.
        Throws:
        FSMsgException - if there is an error creating this object.

      • FSNameRegistrationRequest

        public FSNameRegistrationRequest​(Element root)
                          throws FSMsgException
        Deprecated.
        Constructor creates FSNameRegistrationRequest> object from a Document Element.
        Parameters:
        root - the Document Element.
        Throws:
        FSMsgException - if there is an error creating this object.

    • Method Detail

      • getID

        public String getID()
        Deprecated.
        Returns the value of id attribute.
        Returns:
        the value of id attribute.
        See Also:
        setID(String)

      • setID

        public void setID​(String id)
        Deprecated.
        Sets the value of id attribute.
        Parameters:
        id - the value of id attribute.
        See Also:
        getID()

      • getRelayState

        public String getRelayState()
        Deprecated.
        Returns the value of RelayState attribute.
        Returns:
        the value of RelayState attribute.
        See Also:
        setRelayState(String)

      • setRelayState

        public void setRelayState​(String relayState)
        Deprecated.
        Set the value of RelayState attribute.
        Parameters:
        relayState - the value of RelayState attribute.
        See Also:
        getRelayState()

      • getSignatureString

        public String getSignatureString()
        Deprecated.
        Returns the signed XML string.
        Returns:
        the signed XML string.

      • toXMLString

        public String toXMLString()
                   throws FSMsgException
        Deprecated.
        Returns a String representation of the Logout Response.
        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​(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException
        Deprecated.
        Returns a String representation of the Logout Response.
        Parameters:
        includeNS - : Determines whether or not the namespace qualifier is prepended to the Element when converted
        declareNS - : Determines whether or not the namespace is declared within the Element.
        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​(boolean includeNS,
                          boolean declareNS,
                          boolean includeHeader)
                   throws FSMsgException
        Deprecated.
        Returns a String representation of the Logout Response.
        Parameters:
        includeNS - Determines whether or not the namespace qualifier is prepended to the Element when converted
        declareNS - 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.

      • getIDPProvidedNameIdentifier

        public IDPProvidedNameIdentifier getIDPProvidedNameIdentifier()
        Deprecated.
        Returns the Identity Provider's NameIdentifier.
        Returns:
        the Identity Provider's NameIdentifier.

      • getOldProvidedNameIdentifier

        public OldProvidedNameIdentifier getOldProvidedNameIdentifier()
        Deprecated.
        Returns the original NameIdentifier.
        Returns:
        the original NameIdentifier.

      • getProviderId

        public String getProviderId()
        Deprecated.
        Returns the value of ProviderID attribute.
        Returns:
        the value of ProviderID attribute.

      • setIDPProvidedNameIdentifier

        public void setIDPProvidedNameIdentifier​(IDPProvidedNameIdentifier nameIdentifier)
        Deprecated.
        Sets the Identity Provider's NameIdentifier.
        Parameters:
        nameIdentifier - the Identity Provider's NameIdentifier.
        See Also:
        getIDPProvidedNameIdentifier()

      • setOldProvidedNameIdentifier

        public void setOldProvidedNameIdentifier​(OldProvidedNameIdentifier nameIdentifier)
        Deprecated.
        Sets the original NameIdentifier.
        Parameters:
        nameIdentifier - the original provider's NameIdentifier.
        See Also:
        getOldProvidedNameIdentifier()

      • setSPProvidedNameIdentifier

        public void setSPProvidedNameIdentifier​(SPProvidedNameIdentifier nameIdentifier)
        Deprecated.
        Sets the Service Provider's NameIdentifier.
        Parameters:
        nameIdentifier - the Identity Provider's NameIdentifier.
        See Also:
        getSPProvidedNameIdentifier()

      • setProviderId

        public void setProviderId​(String providerId)
        Deprecated.
        Sets the value of ProviderID attribute.
        Parameters:
        providerId - the value of ProviderID attribute.

      • toBASE64EncodedString

        public String toBASE64EncodedString()
                             throws FSMsgException
        Deprecated.
        Returns a Base64 Encoded String.
        Returns:
        a Base64 Encoded String.
        Throws:
        FSMsgException - if there is an error encoding the string.

      • signXML

        public void signXML​(String certAlias)
             throws SAMLException
        Deprecated.
        Signs the FSNameRegistrationRequest object.
        Parameters:
        certAlias - the Certificate Alias.
        Throws:
        SAMLException - if this object cannot be signed.

      • setSignature

        public boolean setSignature​(Element elem)
        Deprecated.
        Sets the Signature.
        Overrides:
        setSignature in class AbstractRequest
        Parameters:
        elem - the Document Element.
        Returns:
        true if success otherwise false.

      • toURLEncodedQueryString

        public String toURLEncodedQueryString()
                               throws FSMsgException
        Deprecated.
        Returns an URL Encoded String.
        Returns:
        a url encoded query string.
        Throws:
        FSMsgException - if there is an error.

      • parseURLEncodedRequest

        public static FSNameRegistrationRequest parseURLEncodedRequest​(jakarta.servlet.http.HttpServletRequest request)
                                                        throws FSMsgException,
                                                               SAMLException
        Deprecated.
        Returns FSNameRegistrationRequest object. The object is creating by parsing the HttpServletRequest object.
        Parameters:
        request - the HttpServletRequest object.
        Throws:
        FSMsgException - if there is an error creating this object.
        SAMLException - if there is an error.