edu.ucsb.nceas.metacat.admin

## Class AuthAdmin

- java.lang.Object
- - edu.ucsb.nceas.metacat.admin.MetacatAdmin
  - - edu.ucsb.nceas.metacat.admin.AuthAdmin

-     public class AuthAdmin
      extends MetacatAdmin

  Control the display of the Authentication configuration page and the processing of the configuration values.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static java.lang.String` | `FILECLASS`
    `static java.lang.String` | `LDAPCLASS`

    - ### Fields inherited from class edu.ucsb.nceas.metacat.admin.MetacatAdmin

      `FAILURE, IN_PROGRESS, SUCCESS`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `configureAuth(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Handle configuration of the Authentication properties
    `static AuthAdmin` | `getInstance()` Get the single instance of the MetaCatConfig.
    `protected java.util.Vector<java.lang.String>` | `validateOptions(javax.servlet.http.HttpServletRequest request)` Validate the most important configuration options submitted by the user.

    - ### Methods inherited from class edu.ucsb.nceas.metacat.admin.MetacatAdmin

      `updateUpgradeStatus`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### FILECLASS

          public static final java.lang.String FILECLASS

      See Also:
        Constant Field Values

    - #### LDAPCLASS

          public static final java.lang.String LDAPCLASS

      See Also:
        Constant Field Values

  - ### Method Detail

    - #### getInstance

          public static AuthAdmin getInstance()

      Get the single instance of the MetaCatConfig.
      Returns:
        the single instance of MetaCatConfig

    - #### configureAuth

          public void configureAuth(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
                             throws AdminException

      Handle configuration of the Authentication properties
      Parameters:
        `request` - the http request information
        `response` - the http response to be sent back to the client
      Throws:
        `AdminException`

    - #### validateOptions

          protected java.util.Vector<java.lang.String> validateOptions(javax.servlet.http.HttpServletRequest request)

      Validate the most important configuration options submitted by the user.
      Specified by:
        `validateOptions` in class `MetacatAdmin`
      Returns:
        a vector holding error message for any fields that fail validation.

Copyright © 2023 Regents of the University of California. All Rights Reserved.