Interface AuthenticationMechanismConfiguration


  • public interface AuthenticationMechanismConfiguration
    The interface for authentication method implementations to retrieve configuration properties regarding the method.
    • Method Detail

      • getDefaultTemplateName

        java.lang.String getDefaultTemplateName()
        Method to retrieve the default template name.
        Returns:
        The template name.
      • getDefaultTemplateSpecification

        byte[] getDefaultTemplateSpecification()
        Method to retrieve the default template content.
        Returns:
        The default template content.
      • getMechanismReplies

        java.util.Vector<?> getMechanismReplies()
        Method that retrieves all authentication method replies. May be used in RADIUS authentication and as challenge state template containers for other authentication methods.
        Returns:
        A Vector with zero or more MechanismReply objects.
        See Also:
        MechanismReply
      • getMechanismConfigurations

        java.util.Vector<MechanismConfiguration> getMechanismConfigurations()
        Method that retrieves all authentication method configurations. These configurations corresponds to the key-value pairs configured in the "Extended Properties" box on the authentication method in the Administrator.
        Returns:
        Vector containing MechanismConfiguration objects.
        See Also:
        MechanismConfiguration
      • getExtraProperties

        java.util.HashMap<java.lang.String,​java.lang.Object> getExtraProperties()
        A map of properties for the mechanism. Used to store properties that is unique for the current mech. Removes the need to add special parameters thats only used by one method.
        Returns:
        a Hashmap of properties
      • getMechanismServers

        java.util.Vector<MechanismServer> getMechanismServers()
        Method that retrieves all authentication method servers. These servers correspond to the dynamically configured "Authentication Servers" in the Administrator.
        Returns:
        A Vector with zero or more MechanismServer objects.
        See Also:
        MechanismServer
      • getCAName

        java.lang.String getCAName()
        Returns the key for the configured Certificate Authority for this authentication method. Currently only used in Hybrid Access Gateway implemented Certificate authentication.
        Returns:
        The Certificate Authority key.
      • getMechanismName

        java.lang.String getMechanismName()
        Returns the name of this authentication method.
        Returns:
        name The authentication method name.
      • getMechanismId

        int getMechanismId()
        Returns the internal ID of this authentication method.
        Returns:
        id The authentication method ID.
      • getAuthenticationMechanism

        com.portwise.core.controller.authentication.AuthenticationMechanism getAuthenticationMechanism()