Package edu.ucsb.nceas.metacat

Interface AuthInterface

All Known Implementing Classes:

AuthFile, AuthLdap, AuthOrcid, AuthStub, AuthTest

public interface AuthInterface

An interface representing the methods that should be implemented by an authentication service. The authentication service is used to determine if a user is authenticated, and whether they are a member of a particular group.

Field Summary

Fields

Modifier and Type	Field	Description
static final short	GROUPDESINDEX
static final short	GROUPNAMEINDEX
static final short	USERCNINDEX
static final short	USERDNINDEX
static final short	USEREMAILINDEX
static final short	USERINFOCNINDEX
static final short	USERINFOEMAILINDEX
static final short	USERINFOORGANIDEX
static final short	USERORGINDEX
static final short	USERORGUNITINDEX

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(String user, String password)	Determine if a user/password are valid according to the authentication service.
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)	Get all groups from the authentication service
String[][]	getGroups(String user, String password, String foruser)	Get the groups for a particular user from the authentication service
String	getPrincipals(String user, String password)	Get all groups and users from authentication service.
String[]	getUserInfo(String user, String password)	Get information for a user - name, organization and email address.
String[][]	getUsers(String user, String password)	Get all users from the authentication service
String[]	getUsers(String user, String password, String group)	Get the users for a particular group from the authentication service

Field Details

USERDNINDEX

static final short USERDNINDEX

See Also:

• Constant Field Values

USERCNINDEX

static final short USERCNINDEX

See Also:

• Constant Field Values

USERORGINDEX

static final short USERORGINDEX

See Also:

• Constant Field Values

USERORGUNITINDEX

static final short USERORGUNITINDEX

See Also:

• Constant Field Values

USEREMAILINDEX

static final short USEREMAILINDEX

See Also:

• Constant Field Values

GROUPNAMEINDEX

static final short GROUPNAMEINDEX

See Also:

• Constant Field Values

GROUPDESINDEX

static final short GROUPDESINDEX

See Also:

• Constant Field Values

USERINFOCNINDEX

static final short USERINFOCNINDEX

See Also:

• Constant Field Values

USERINFOORGANIDEX

static final short USERINFOORGANIDEX

See Also:

• Constant Field Values

USERINFOEMAILINDEX

static final short USERINFOEMAILINDEX

See Also:

• Constant Field Values

Method Details

authenticate

boolean authenticate(String user,
 String password)
              throws ConnectException

Determine if a user/password are valid according to the authentication service.

Parameters:

user - the name of the principal to authenticate

password - the password to use for authentication

Throws:

ConnectException

getUsers

String[][] getUsers(String user,
 String password)
             throws ConnectException

Get all users from the authentication service

Throws:

ConnectException

getUserInfo

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

Get information for a user - name, organization and email address.

Throws:

ConnectException

getUsers

String[] getUsers(String user,
 String password,
 String group)
           throws ConnectException

Get the users for a particular group from the authentication service

Throws:

ConnectException

getGroups

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

Get all groups from the authentication service

Throws:

ConnectException

getGroups

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

Get the groups for a particular user from the authentication service

Throws:

ConnectException

getAttributes

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

Get attributes describing a user or group

Parameters:

user - the user for which the attribute list is requested

Throws:

ConnectException

getAttributes

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

Get attributes describing a user or group

Parameters:

user - the user for which the attribute list is requested

authuser - the user for authenticating against the service

password - the password for authenticating against the service

Throws:

ConnectException

getPrincipals

String getPrincipals(String user,
 String password)
              throws ConnectException

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

Parameters:

user - the user which requests the information

password - the user's password

Throws:

ConnectException