Interface I_CmsCredentialsResolver

  • All Known Implementing Classes:
    CmsDefaultCredentialsResolver

    public interface I_CmsCredentialsResolver
    This interface can be used to override or replace user names or passwords which occur in the OpenCms configuration, for example to hide passwords from users who can read the configuration files.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DB_PASSWORD
      Credential type for database pool passwords.
      static java.lang.String DB_USER
      Credential type for database pool user names.
      static java.lang.String LDAP_PASSWORD
      Credential type for LDAP passwords.
      static java.lang.String LDAP_USER
      Credential type for LDAP users.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String resolveCredential​(java.lang.String credentialType, java.lang.String valueFromConfiguration)
      Translates user names or passwords for authentication.
    • Method Detail

      • resolveCredential

        java.lang.String resolveCredential​(java.lang.String credentialType,
                                           java.lang.String valueFromConfiguration)
        Translates user names or passwords for authentication.

        Parameters:
        credentialType - the type of credential to resolve (this is equal to one of the constants defined in this interface)
        valueFromConfiguration - the original value which was read from the configuration file (may be null)
        Returns:
        the credential value that should be used for authentication