Package 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	Description
static final String	FILECLASS
static final String	LDAPCLASS

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

COMPLETE, FAILURE, IN_PROGRESS, NOT_REQUIRED, PENDING, SUCCESS, UNKNOWN

Method Summary

Modifier and Type	Method	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 Vector<String>	validateOptions(javax.servlet.http.HttpServletRequest request)	Validate that a user has supplied an ORCID identifier by parsing the http request's 'auth.administrators' parameter.

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 Details

FILECLASS

public static final String FILECLASS

See Also:

• Constant Field Values

LDAPCLASS

public static final String LDAPCLASS

See Also:

• Constant Field Values

Method Details

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 Vector<String> validateOptions(javax.servlet.http.HttpServletRequest request)

Validate that a user has supplied an ORCID identifier by parsing the http request's 'auth.administrators' parameter. AuthSessions were previously created based on a selected authentication class. As LDAP and Password based authentication is being deprecated, we no longer have to check for a valid authentication class. The user is now (2024) expected to provide an ORCID ID of the form http://orcid.org/0000-0003-0958-4367 (http, NOT https)

Specified by:

validateOptions in class MetacatAdmin

Parameters:

request - Http request

Returns:

a vector holding error message for any fields that fail validation.