Package com.sun.identity.federation.message

Class FSAuthnRequest

  • @Deprecated
public class FSAuthnRequest
extends AbstractRequest
    Deprecated.
    since 12.0.0
    The class FSAuthnRequest is used to create , parse AuthnRequest object.

    • Field Detail

      • xmlString

        protected String xmlString
        Deprecated.

      • signatureString

        protected String signatureString
        Deprecated.

      • authContextCompType

        protected String authContextCompType
        Deprecated.

      • id

        protected String id
        Deprecated.

      • assertionConsumerServiceID

        protected String assertionConsumerServiceID
        Deprecated.

      • consentURI

        protected String consentURI
        Deprecated.

      • affiliationID

        protected String affiliationID
        Deprecated.

      • minorVersion

        protected int minorVersion
        Deprecated.

      • scoping

        protected FSScoping scoping
        Deprecated.

    • Constructor Detail

      • FSAuthnRequest

        public FSAuthnRequest()
        Deprecated.
        Default AuthnRequest construtor

      • FSAuthnRequest

        public FSAuthnRequest​(String requestId,
                      List respondWiths,
                      String providerID,
                      boolean forceAuthn,
                      boolean isPassive,
                      boolean fed,
                      String nameIDPolicy,
                      String protocolProf,
                      RequestAuthnContext authnCxt,
                      String relaySt,
                      String authContextCompType)
               throws FSMsgException
        Deprecated.
        Constructor to create FSAuthnRequest object.
        Parameters:
        requestId - the request identifier.
        respondWiths - List of respond withs attributes.
        providerID - provider id of the requesting provider.
        forceAuthn - Force Authentication boolean value.
        isPassive - attribute for IDP to be passive or active.
        fed - attribute to distingush this request for Federation or SSO
        nameIDPolicy - Name ID Policy for this request, possible values are "none", "onetime", "federated", "any".
        protocolProf - ProtocolProfile used for the SSO.
        authnCxt - Authentication Context used for the SSO.
        relaySt - Relay State i.e. original URL to be redirected after SSO.
        authContextCompType - AuthContext comparison type.
        Throws:
        FSMsgException

      • FSAuthnRequest

        public FSAuthnRequest​(Element root)
               throws FSMsgException
        Deprecated.
        Constructor to create FSAuthnRequest object.
        Parameters:
        root - the Document Element object.
        Throws:
        FSMsgException

    • Method Detail

      • toXMLString

        public String toXMLString()
                   throws FSMsgException
        Deprecated.
        This method translates the request to an XML document String based on the Request schema described above. NOTE: this is a complete AuthnRequest xml string with RequestID, MajorVersion, etc.
        Returns:
        XML String representing the request.
        Throws:
        FSMsgException - if there is an error.

      • toXMLString

        public String toXMLString​(boolean includeNS,
                          boolean declareNS)
                   throws FSMsgException
        Deprecated.
        Creates a String representation of the <lib:AuthnRequest> element.
        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:
        string containing the valid XML for this element.
        Throws:
        FSMsgException - if there is an error.

      • toXMLString

        public String toXMLString​(boolean includeNS,
                          boolean declareNS,
                          boolean includeHeader)
                   throws FSMsgException
        Deprecated.
        Creates a String representation of the <lib:AuthnRequest> element.
        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.

      • parseXML

        public static FSAuthnRequest parseXML​(String xml)
                               throws FSMsgException
        Deprecated.
        Returns the FSAuthnRequest object.
        Parameters:
        xml - the XML string.
        Returns:
        FSAuthnRequest object.
        Throws:
        FSMsgException - if there is error creating the object.

      • getSignedXMLString

        public String getSignedXMLString()
        Deprecated.
        Returns Signed XML String representation of this object.
        Returns:
        signed XML String.

      • getSignatureString

        public String getSignatureString()
        Deprecated.
        Returns the signature string.
        Returns:
        the signature string.

      • getExtensions

        public List getExtensions()
        Deprecated.
        Returns a list of Extension objects. Each entry of the list is a Extension object.
        Returns:
        a list of Extension elements.
        See Also:
        setExtensions(List)

      • setExtensions

        public void setExtensions​(List extensions)
        Deprecated.
        Sets Extension objects. Each entry of the list is a Extension object.
        Parameters:
        extensions - a list of Extension objects.
        See Also:
        getExtensions()

      • getForceAuthn

        public boolean getForceAuthn()
        Deprecated.
        Returns the value of Force Authentication attribute.
        Returns:
        the value of Force Authentication attribute.

      • setForceAuthn

        public void setForceAuthn​(boolean forceAuthn)
        Deprecated.
        Sets the value of Force Authentication attribute.
        Parameters:
        forceAuthn - value of Force Authentication attribute.

      • getIsPassive

        public boolean getIsPassive()
        Deprecated.
        Returns the value of the isPassive attribute.
        Returns:
        value of isPassive attribute.

      • setIsPassive

        public void setIsPassive​(boolean isPassive)
        Deprecated.
        Sets the value of the IsPassive attribute.
        Parameters:
        isPassive - value of isPassive attribute.

      • getFederate

        public boolean getFederate()
        Deprecated.
        Returns the value of the Federate attribute.
        Returns:
        the value fo the Federate attribute.

      • setFederate

        public void setFederate​(boolean fed)
        Deprecated.
        Sets the value of the Federate attribute.
        Parameters:
        fed - the value of the Federate attribute.

      • getNameIDPolicy

        public String getNameIDPolicy()
        Deprecated.
        Returns the NameIDPolicy object.
        Returns:
        the NameIDPolicy object.
        See Also:
        setNameIDPolicy(String)

      • setNameIDPolicy

        public void setNameIDPolicy​(String nameIDPolicy)
        Deprecated.
        Sets the NameIDPolicy object.
        Parameters:
        nameIDPolicy - the new NameIDPolicy object.
        See Also:
        getNameIDPolicy()

      • getProtocolProfile

        public String getProtocolProfile()
        Deprecated.
        Returns the value of ProtocolProfile attribute.
        Returns:
        the value of ProtocolProfile attribute.
        See Also:
        setProtocolProfile(String)

      • setProtocolProfile

        public void setProtocolProfile​(String protocolProf)
        Deprecated.
        Sets the value of ProtocolProfile attribute.
        Parameters:
        protocolProf - the value of ProtocolProfile attribute.
        See Also:
        getProtocolProfile()

      • 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 relaySt)
        Deprecated.
        Set the value of RelayState attribute.
        Parameters:
        relaySt - the value of RelayState attribute.
        See Also:
        getRelayState()

      • setAuthnContext

        public void setAuthnContext​(RequestAuthnContext authnCxt)
        Deprecated.
        Sets the RequestedAuthnContext object.
        Parameters:
        authnCxt - the RequestAuthnContext object.
        See Also:
        getAuthnContext()

      • getProviderId

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

      • setProviderId

        public void setProviderId​(String provId)
        Deprecated.
        Sets the value of ProviderID attribute.
        Parameters:
        provId - the value of ProviderID attribute.
        See Also:
        getProviderId()

      • getAuthContextCompType

        public String getAuthContextCompType()
        Deprecated.
        Returns the value of AuthContext Comparison attribute.
        Returns:
        he value of AuthContext Comparison attribute.
        See Also:
        setAuthContextCompType(String)

      • setAuthContextCompType

        public void setAuthContextCompType​(String authType)
        Deprecated.
        Sets the value of AuthContext Comparison attribute.
        Parameters:
        authType - he value of AuthContext Comparison attribute.
        See Also:
        getAuthContextCompType()

      • 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()

      • setMinorVersion

        public void setMinorVersion​(int version)
        Deprecated.
        Sets the value of the MinorVersion attribute.
        Overrides:
        setMinorVersion in class AbstractRequest
        Parameters:
        version - the value of the MinorVersion attribute.
        See Also:
        getMinorVersion()

      • getAffiliationID

        public String getAffiliationID()
        Deprecated.
        Returns the Affliation Identifier.
        Returns:
        the Affliation Identifier.
        See Also:
        setAffiliationID(String)

      • setAffiliationID

        public void setAffiliationID​(String affiliationID)
        Deprecated.
        Sets the Affiliation Identifier.
        Parameters:
        affiliationID - the Affiliation Identifier.
        See Also:
        getAffiliationID()

      • getAssertionConsumerServiceID

        public String getAssertionConsumerServiceID()
        Deprecated.
        Returns the Assertion Consumer Service Identifier.
        Returns:
        the Assertion Consumer Service Identifier.
        See Also:
        setAssertionConsumerServiceID(String)

      • setAssertionConsumerServiceID

        public void setAssertionConsumerServiceID​(String assertionConsumerServiceID)
        Deprecated.
        Sets the Assertion Consumer Service Identifier.
        Parameters:
        assertionConsumerServiceID - the Assertion Consumer Service Identifier.
        See Also:
        getAssertionConsumerServiceID()

      • getConsent

        public String getConsent()
        Deprecated.
        Returns the value of consent attribute.
        Returns:
        the value of consent attribute.
        See Also:
        setConsent(String)

      • setConsent

        public void setConsent​(String consentURI)
        Deprecated.
        Sets the value of consent attribute.
        Parameters:
        consentURI - the value of consent attribute.
        See Also:
        getConsent()

      • setScoping

        public void setScoping​(FSScoping scoping)
        Deprecated.
        Sets the FSScoping object.
        Parameters:
        scoping - the FSScoping object.
        See Also:
        getScoping()

      • toURLEncodedQueryString

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

      • 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.

      • parseURLEncodedRequest

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

      • parseBASE64EncodedString

        public static FSAuthnRequest parseBASE64EncodedString​(String encodedReq)
                                               throws FSMsgException
        Deprecated.
        Returns FSAuthnRequest object. The object is created by parsing an Base64 encode authentication request string.
        Parameters:
        encodedReq - the encode string
        Throws:
        FSMsgException - if there is an error creating FSAuthnRequest object.

      • signXML

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

      • setSignature

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