Package com.portwise.mvpnms.authentication

Interface AuthenticationMechanismInterface

    • Field Detail

      • AUTHENTICATED

        static final int AUTHENTICATED
        The authenticated return code.
        See Also:
        Constant Field Values

      • NOT_AUTHENTICATED

        static final int NOT_AUTHENTICATED
        The not authenticated return code.
        See Also:
        Constant Field Values

      • NOT_AVAILABLE_SERVICE

        static final int NOT_AVAILABLE_SERVICE
        The not available return code.
        See Also:
        Constant Field Values

      • NO_USERNAME

        static final java.lang.String NO_USERNAME
        The no username string message used in authentication replies.
        See Also:
        Constant Field Values

      • NO_PASSWORD

        static final java.lang.String NO_PASSWORD
        The no password string message used in authentication replies.
        See Also:
        Constant Field Values

      • INVALID_CREDENTIALS

        static final java.lang.String INVALID_CREDENTIALS
        Invalid credentials string message used in authentication replies.
        See Also:
        Constant Field Values

      • NO_CERTIFICATE

        static final java.lang.String NO_CERTIFICATE
        Invalid credentials string message used in authentication replies.
        See Also:
        Constant Field Values

      • INVALID_USER_CERTIFICATE

        static final java.lang.String INVALID_USER_CERTIFICATE
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • INVALID_CRL

        static final java.lang.String INVALID_CRL
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • REVOKED_USER_CERTIFICATE

        static final java.lang.String REVOKED_USER_CERTIFICATE
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • NOT_BOUND_USER_CERTIFICATE

        static final java.lang.String NOT_BOUND_USER_CERTIFICATE
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • NOT_MAPPED_USER_CERTIFICATE

        static final java.lang.String NOT_MAPPED_USER_CERTIFICATE
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • NOT_MAPPED_NO_UNIQUE_USER_FOUND

        static final java.lang.String NOT_MAPPED_NO_UNIQUE_USER_FOUND
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • NOT_MAPPED_SUBJECT_DN_IN_CERT

        static final java.lang.String NOT_MAPPED_SUBJECT_DN_IN_CERT
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • TVC_FAILED_USER_CERTIFICATE_NOT_YET_VALID

        static final java.lang.String TVC_FAILED_USER_CERTIFICATE_NOT_YET_VALID
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • TVC_FAILED_CA_CERTIFICATE_NOT_YET_VALID

        static final java.lang.String TVC_FAILED_CA_CERTIFICATE_NOT_YET_VALID
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • TVC_FAILED_USER_CERTIFICATE_EXPIRED

        static final java.lang.String TVC_FAILED_USER_CERTIFICATE_EXPIRED
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • TVC_FAILED_CA_CERTIFICATE_EXPIRED

        static final java.lang.String TVC_FAILED_CA_CERTIFICATE_EXPIRED
        Used in Policy Service) certificate mechanism.
        See Also:
        Constant Field Values

      • CVC_FAILED_USER_CERTIFICATE

        static final java.lang.String CVC_FAILED_USER_CERTIFICATE
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • SVC_FAILED_USER_CERTIFICATE

        static final java.lang.String SVC_FAILED_USER_CERTIFICATE
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • INVALID_CA_CERTIFICATE

        static final java.lang.String INVALID_CA_CERTIFICATE
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • CA_STATUS_REVOKED

        static final java.lang.String CA_STATUS_REVOKED
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • CA_STATUS_DISABLED

        static final java.lang.String CA_STATUS_DISABLED
        Used in Policy Service certificate mechanism.
        See Also:
        Constant Field Values

      • USERNAME

        static final java.lang.String USERNAME
        The username key in the authentication parameters used in authentication replies.
        See Also:
        Constant Field Values

      • PASSWORD

        static final java.lang.String PASSWORD
        The password key in the authentication parameters used in authentication replies.
        See Also:
        Constant Field Values

      • AUTHORIZATION_PARAMETER

        static final java.lang.String AUTHORIZATION_PARAMETER
        The authorization parameter key in the authentication parameters used in authentication replies. Used by Windows Integrated Login.
        See Also:
        Constant Field Values

      • DO_PARAMETER

        static final java.lang.String DO_PARAMETER
        The do parameter key in the authentication parameters used in authentication replies. Should be used by all uthentication methods.
        See Also:
        Constant Field Values

      • SHARED_SECRET

        static final java.lang.String SHARED_SECRET
        Internally used.
        See Also:
        Constant Field Values

      • MESSAGE

        static final java.lang.String MESSAGE
        The message that may be shown in user's browser.
        See Also:
        Constant Field Values

      • RADIUS_REPLY_MESSAGE

        static final java.lang.String RADIUS_REPLY_MESSAGE
        The RADIUS reply string in the authentication parameters used in authentication replies.
        See Also:
        Constant Field Values

      • CERT_ERROR_MESSAGE

        static final java.lang.String CERT_ERROR_MESSAGE
        The cert reply string in the authentication parameters.
        See Also:
        Constant Field Values

      • ARG

        static final java.lang.String ARG
        The dynamic number of arguments to be fed to the template specification's corresponding [ARGi] parameters. Mainly used in collaboration with Access Point.
        See Also:
        Constant Field Values

      • URL

        static final java.lang.String URL
        Used internally in Policy Service.
        See Also:
        Constant Field Values

      • DOMAIN

        static final java.lang.String DOMAIN
        Used internally in Policy Service.
        See Also:
        Constant Field Values

      • USER_ATTRIBUTE_MAPPING

        static final java.lang.String USER_ATTRIBUTE_MAPPING
        Used internally in Policy Service.
        See Also:
        Constant Field Values

      • CERTIFICATE_ATTRIBUTE_MAPPING

        static final java.lang.String CERTIFICATE_ATTRIBUTE_MAPPING
        Used internally in Policy Service.
        See Also:
        Constant Field Values

      • SERVER_INDEX

        static final java.lang.String SERVER_INDEX
        Internally used.
        See Also:
        Constant Field Values

    • Method Detail

      • init

        boolean init​(AuthenticationMechanismConfiguration configuration,
             AuthenticationMechanismHandler handler)
        Initialization of the authentication method. The configuration is progressed to the authentication method as well as the handler which can assist the authentication method for instance with session and logging issues.
        Parameters:
        configuration - The configuration handler.
        handler - The authentication method handler.
        Returns:
        The authentication method should return true if it is ready to receive authentication requests. It should return false, if the authentication method already in this call can determine that it will be unable to perform authentication requests, e.g. if for instance a configuration parameter is missing.

      • authenticate

        AuthenticationReply authenticate​(AuthenticationRequest request)
        The actual progress of the authentication request from Policy Service to the authentication method in question.
        Parameters:
        request - The authentication request.
        Returns:
        The authentication reply.

      • exit

        boolean exit()
        Terminates the authentication method. Close down any persistent connections or other resources allocated during run-time of the authentication method.
        Returns:
        True if the termination went well. False is returned if the termination wasn't sucessful.

      • getName

        java.lang.String getName()
        Returns the name of the authentication method.
        Returns:
        The name of the authentication method.

      • needsReloading

        boolean needsReloading​(java.lang.String transactionKey)