summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/usrgrp/IUser.java
blob: febcb9e8483b1d3f319d18492a1864956571d40f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.usrgrp;


import com.netscape.certsrv.common.*;
import com.netscape.certsrv.base.*;
import java.security.cert.*;
import netscape.security.x509.*;


/**
 * This interface defines the basic interfaces for
 * a user identity. (get/set methods for a user entry attributes)
 *
 * @version $Revision$, $Date$
 */
public interface IUser extends IAttrSet, IUserConstants {

    /**
     * Retrieves name.
     * @return user name
     */
    public String getName();

    /**
     * Retrieves user identifier.
     * @return user id
     */
    public String getUserID();

    /**
     * Retrieves user full name.
     * @return user fullname
     */
    public String getFullName();

    /**
     * Retrieves user phonenumber.
     * @return user phonenumber
     */
    public String getPhone();

    /**
     * Retrieves user state
     * @return user state
     */
    public String getState();

    /**
     * Sets user full name.
     * @param name the given full name
     */
    public void setFullName(String name);

    /**
     * Sets user ldap DN.
     * @param userdn the given user DN
     */
    public void setUserDN(String userdn);

    /**
     * Gets user ldap dn
     * @return user DN
     */
    public String getUserDN();

    /**
     * Retrieves user password.
     * @return user password
     */
    public String getPassword();

    /**
     * Sets user password.
     * @param p the given password
     */
    public void setPassword(String p);

    /**
     * Sets user phonenumber
     * @param p user phonenumber 
     */
    public void setPhone(String p);

    /**
     * Sets user state
     * @param p the given user state
     */
    public void setState(String p);

    /**
     * Sets user type
     * @param userType the given user type
     */
    public void setUserType(String userType);

    /**
     * Gets user email address.
     * @return email address
     */
    public String getEmail();

    /**
     * Sets user email address.
     * @param email the given email address
     */
    public void setEmail(String email);

    /**
     * Gets list of certificates from this user
     * @return list of certificates
     */
    public X509Certificate[] getX509Certificates();

    /**
     * Sets list of certificates in this user
     * @param certs list of certificates
     */
    public void setX509Certificates(X509Certificate certs[]);

    /**
     * Get certificate DN
     * @return certificate DN
     */
    public String getCertDN();

    /**
     * Set certificate DN
     * @param userdn the given DN
     */
    public void setCertDN(String userdn);

    /**
     * Get user type
     * @return user type.
     */
    public String getUserType();
}