|
1
|
/**
|
|
2
|
* '$RCSfile$'
|
|
3
|
* Purpose: An interface representing the methods that should be
|
|
4
|
* implemented by an authentication service
|
|
5
|
* Copyright: 2000 Regents of the University of California and the
|
|
6
|
* National Center for Ecological Analysis and Synthesis
|
|
7
|
* Authors: Matt Jones
|
|
8
|
*
|
|
9
|
* '$Author: tao $'
|
|
10
|
* '$Date: 2014-01-08 17:17:20 -0800 (Wed, 08 Jan 2014) $'
|
|
11
|
* '$Revision: 8476 $'
|
|
12
|
*
|
|
13
|
* This program is free software; you can redistribute it and/or modify
|
|
14
|
* it under the terms of the GNU General Public License as published by
|
|
15
|
* the Free Software Foundation; either version 2 of the License, or
|
|
16
|
* (at your option) any later version.
|
|
17
|
*
|
|
18
|
* This program is distributed in the hope that it will be useful,
|
|
19
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
20
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
21
|
* GNU General Public License for more details.
|
|
22
|
*
|
|
23
|
* You should have received a copy of the GNU General Public License
|
|
24
|
* along with this program; if not, write to the Free Software
|
|
25
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
26
|
*/
|
|
27
|
|
|
28
|
package edu.ucsb.nceas.metacat;
|
|
29
|
|
|
30
|
import java.net.ConnectException;
|
|
31
|
import java.util.HashMap;
|
|
32
|
import java.util.Vector;
|
|
33
|
|
|
34
|
/**
|
|
35
|
* An interface representing the methods that should be
|
|
36
|
* implemented by an authentication service. The authentication service is
|
|
37
|
* used to determine if a user is authenticated, and whether they are a member
|
|
38
|
* of a particular group.
|
|
39
|
*/
|
|
40
|
public interface AuthInterface {
|
|
41
|
public static final short USERDNINDEX = 0;
|
|
42
|
public static final short USERCNINDEX = 1;
|
|
43
|
public static final short USERORGINDEX = 2;
|
|
44
|
public static final short USERORGUNITINDEX = 3;
|
|
45
|
public static final short USEREMAILINDEX = 4;
|
|
46
|
public static final short GROUPNAMEINDEX = 0;
|
|
47
|
public static final short GROUPDESINDEX = 1;
|
|
48
|
public static final short USERINFOCNINDEX = 0;
|
|
49
|
public static final short USERINFOORGANIDEX = 1;
|
|
50
|
public static final short USERINFOEMAILINDEX = 2;
|
|
51
|
|
|
52
|
/**
|
|
53
|
* Determine if a user/password are valid according to the authentication
|
|
54
|
* service.
|
|
55
|
*
|
|
56
|
* @param user the name of the principal to authenticate
|
|
57
|
* @param password the password to use for authentication
|
|
58
|
* @returns boolean true if authentication successful, false otherwise
|
|
59
|
*/
|
|
60
|
public boolean authenticate(String user, String password)
|
|
61
|
throws ConnectException;
|
|
62
|
|
|
63
|
/**
|
|
64
|
* Get all users from the authentication service
|
|
65
|
*/
|
|
66
|
public String[][] getUsers(String user, String password)
|
|
67
|
throws ConnectException;
|
|
68
|
|
|
69
|
/**
|
|
70
|
* Get information for a user - name, organization and email address.
|
|
71
|
*/
|
|
72
|
public String[] getUserInfo(String user, String password)
|
|
73
|
throws ConnectException;
|
|
74
|
|
|
75
|
/**
|
|
76
|
* Get the users for a particular group from the authentication service
|
|
77
|
*/
|
|
78
|
public String[] getUsers(String user, String password, String group)
|
|
79
|
throws ConnectException;
|
|
80
|
|
|
81
|
/**
|
|
82
|
* Get all groups from the authentication service
|
|
83
|
*/
|
|
84
|
public String[][] getGroups(String user, String password)
|
|
85
|
throws ConnectException;
|
|
86
|
|
|
87
|
/**
|
|
88
|
* Get the groups for a particular user from the authentication service
|
|
89
|
*/
|
|
90
|
public String[][] getGroups(String user, String password, String foruser)
|
|
91
|
throws ConnectException;
|
|
92
|
|
|
93
|
/**
|
|
94
|
* Get attributes describing a user or group
|
|
95
|
*
|
|
96
|
* @param user the user for which the attribute list is requested
|
|
97
|
* @returns HashMap a map of attribute name to a Vector of values
|
|
98
|
*/
|
|
99
|
public HashMap<String,Vector<String>> getAttributes(String foruser)
|
|
100
|
throws ConnectException;
|
|
101
|
|
|
102
|
/**
|
|
103
|
* Get attributes describing a user or group
|
|
104
|
*
|
|
105
|
* @param user the user for which the attribute list is requested
|
|
106
|
* @param authuser the user for authenticating against the service
|
|
107
|
* @param password the password for authenticating against the service
|
|
108
|
* @returns HashMap a map of attribute name to a Vector of values
|
|
109
|
*/
|
|
110
|
public HashMap<String,Vector<String>> getAttributes(String user, String password, String foruser)
|
|
111
|
throws ConnectException;
|
|
112
|
|
|
113
|
/**
|
|
114
|
* Get all groups and users from authentication service.
|
|
115
|
* The output is formatted in XML.
|
|
116
|
* @param user the user which requests the information
|
|
117
|
* @param password the user's password
|
|
118
|
*/
|
|
119
|
public String getPrincipals(String user, String password)
|
|
120
|
throws ConnectException;
|
|
121
|
}
|