Package com.caplin.keymaster

Interface IAuthenticationParameters

  • All Known Implementing Classes:
    AuthenticationParameters
    public interface IAuthenticationParameters
    Represents additional parameters that may be used when generating or formatting KeyMaster tokens.

    If you are implementing your own IKeyMasterFormatter then an object implementing this IAuthenticationParameters can be used to pass in additional parameters.

    A standard implementation of IAuthenticationParameters is provided with KeyMaster; see AuthenticationParameters.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getExtraDataToSign()
      Gets any extra data within the token that KeyMaster will sign.
      java.lang.String getLiberatorUsername()
      Gets the username that should be used to log in to Liberator.
      java.util.Map<java.lang.String,​java.lang.String> getMappingData()
      Gets the mapping data.
      void setExtraDataToSign​(java.lang.String value)
      Sets any extra data within the token that KeyMaster will sign.
      void setLiberatorUsername​(java.lang.String username)
      Sets the username that should be used to log in to Liberator.
      void setMappingData​(java.util.Map<java.lang.String,​java.lang.String> value)
      Sets the mapping data.

    • Method Detail

      • getExtraDataToSign

        java.lang.String getExtraDataToSign()
        Gets any extra data within the token that KeyMaster will sign.
        Returns:
        The extra data.

      • setExtraDataToSign

        void setExtraDataToSign​(java.lang.String value)
        Sets any extra data within the token that KeyMaster will sign.

        If you have written a custom authentication module then you can use the setExtraDataToSign to securely send information from KeyMaster to your authentication module.

        Note: If you are using KeyMaster permissioning then you should not set this property.

        Parameters:
        value - the extra data to sign

      • getLiberatorUsername

        java.lang.String getLiberatorUsername()
        Gets the username that should be used to log in to Liberator.

        This property is used by StreamLink clients to obtain the username that is supplied to a Liberator login request. In a production system this name would normally be the authenticated username, which typically has been authenticated through a single sign-on facility.

        This field is used by the StandardFormatter.

        Returns:
        The username.

      • setLiberatorUsername

        void setLiberatorUsername​(java.lang.String username)
        Sets the username that should be used to log in to Liberator.

        This property is used by StreamLink clients to obtain the username that is supplied to a Liberator login request. In a production system this name would normally be the authenticated username, which typically has been authenticated through a single sign-on facility.

        This field is used by the StandardFormatter.

        Parameters:
        username - the liberator user name.
        Throws:
        java.lang.IllegalArgumentException - Thrown when the supplied value is null or empty.

      • getMappingData

        java.util.Map<java.lang.String,​java.lang.String> getMappingData()
        Gets the mapping data.

        Mapping data will be signed and its values will be available for use in Liberator mappings using %{key}. Keys may only contain alphanumeric, underscore and full stop characters.

        Returns:
        The mapping data.

      • setMappingData

        void setMappingData​(java.util.Map<java.lang.String,​java.lang.String> value)
        Sets the mapping data.

        Mapping data will be signed and its values will be available for use in Liberator mappings using %{key}. Keys may only contain alphanumeric, underscore and full stop characters.

        Parameters:
        value - the mapping data.
        Throws:
        java.lang.IllegalArgumentException - Thrown when the supplied value is null.