Package edu.ucsb.nceas.metacat.authentication

Class AuthOrcid

java.lang.Object

edu.ucsb.nceas.metacat.authentication.AuthOrcid

All Implemented Interfaces:

AuthInterface

public class AuthOrcid
extends Object
implements AuthInterface

Implementation of AuthInterface for ORCID auth (see orcid.org). It is needed by the metacat auth plugin framework, but methods are stubbed because they are no longer appropriate in the context of ORCID-based auth. ORCID is the default authentication mechanism as of 2024. We currently still support ldap and file-based auth for legacy deployments (hence the continued need fo the plugin framework), but in order to select these, the operator has to edit metacat-site.properties by hand.

Author:

brooke

Field Summary

Fields inherited from interface edu.ucsb.nceas.metacat.AuthInterface

GROUPDESINDEX, GROUPNAMEINDEX, USERCNINDEX, USERDNINDEX, USEREMAILINDEX, USERINFOCNINDEX, USERINFOEMAILINDEX, USERINFOORGANIDEX, USERORGINDEX, USERORGUNITINDEX

Constructor Summary

Constructors

Constructor	Description
AuthOrcid()	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(String user, String password)	Not supported for ORCID-based auth
HashMap<String,Vector<String>>	getAttributes(String foruser)	Get attributes describing a user or group
HashMap<String,Vector<String>>	getAttributes(String user, String password, String foruser)	Get attributes describing a user or group
String[][]	getGroups(String user, String password)	Not supported for ORCID-based auth
String[][]	getGroups(String user, String password, String foruser)	Not supported for ORCID-based auth
String	getPrincipals(String user, String password)	Get all groups and users from authentication service.
String[]	getUserInfo(String user, String password)	Not supported for ORCID-based auth
String[][]	getUsers(String user, String password)	Not supported for ORCID-based auth
String[]	getUsers(String user, String password, String group)	Not supported for ORCID-based auth

Methods inherited from class java.lang.Object

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

Constructor Details

AuthOrcid

public AuthOrcid()

Constructor

Method Details

authenticate

public boolean authenticate(String user,
 String password)
                     throws AuthenticationException

Not supported for ORCID-based auth

Specified by:

authenticate in interface AuthInterface

Parameters:

user - the name of the principal to authenticate

password - the password to use for authentication

Throws:

AuthenticationException

getUsers

public String[][] getUsers(String user,
 String password)

Not supported for ORCID-based auth

Specified by:

getUsers in interface AuthInterface

getUserInfo

public String[] getUserInfo(String user,
 String password)
                     throws ConnectException

Not supported for ORCID-based auth

Specified by:

getUserInfo in interface AuthInterface

Throws:

ConnectException

getUsers

public String[] getUsers(String user,
 String password,
 String group)

Not supported for ORCID-based auth

Specified by:

getUsers in interface AuthInterface

getGroups

public String[][] getGroups(String user,
 String password)
                     throws ConnectException

Not supported for ORCID-based auth

Specified by:

getGroups in interface AuthInterface

Throws:

ConnectException

getGroups

public String[][] getGroups(String user,
 String password,
 String foruser)
                     throws ConnectException

Not supported for ORCID-based auth

Specified by:

getGroups in interface AuthInterface

Throws:

ConnectException

getAttributes

public HashMap<String,Vector<String>> getAttributes(String foruser)
                                             throws ConnectException

Description copied from interface: AuthInterface

Get attributes describing a user or group

Specified by:

getAttributes in interface AuthInterface

Throws:

ConnectException

getAttributes

public HashMap<String,Vector<String>> getAttributes(String user,
 String password,
 String foruser)
                                             throws ConnectException

Description copied from interface: AuthInterface

Get attributes describing a user or group

Specified by:

getAttributes in interface AuthInterface

Parameters:

user - the user for which the attribute list is requested

password - the password for authenticating against the service

Throws:

ConnectException

getPrincipals

public String getPrincipals(String user,
 String password)
                     throws ConnectException

Description copied from interface: AuthInterface

Get all groups and users from authentication service. The output is formatted in XML.

Specified by:

getPrincipals in interface AuthInterface

Parameters:

user - the user which requests the information

password - the user's password

Throws:

ConnectException