(no commit message)
[openafs-wiki.git] / archive / JavaAdminAPI / K5User.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc on Wed Apr 10 17:43:54 PDT 2002 -->\r
6 <TITLE>\r
7 Java AFS Admin API: Class  K5User\r
8 </TITLE>\r
9 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
10 </HEAD>\r
11 <BODY BGCOLOR="white">\r
12 \r
13 <!-- ========== START OF NAVBAR ========== -->\r
14 <A NAME="navbar_top"><!-- --></A>\r
15 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">\r
16 <TR>\r
17 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
18 <A NAME="navbar_top_firstrow"><!-- --></A>\r
19 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">\r
20   <TR ALIGN="center" VALIGN="top">\r
21   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
22   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
23   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/K5User.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
24   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
25   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
26   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
27   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
28   </TR>\r
29 </TABLE>\r
30 </TD>\r
31 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
32 <B>Java AFS Admin API v1.3</B></EM>\r
33 </TD>\r
34 </TR>\r
35 \r
36 <TR>\r
37 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
38 &nbsp;<A HREF="K5PasswordPolicy.html"><B>PREV CLASS</B></A>&nbsp;\r
39 &nbsp;<A HREF="Key.html"><B>NEXT CLASS</B></A></FONT></TD>\r
40 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
41   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;\r
42 &nbsp;<A HREF="K5User.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>\r
43 </TR>\r
44 <TR>\r
45 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
46   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
47 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
48 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
49 </TR>\r
50 </TABLE>\r
51 <!-- =========== END OF NAVBAR =========== -->\r
52 \r
53 <HR>\r
54 <!-- ======== START OF CLASS DATA ======== -->\r
55 <H2>\r
56 <FONT SIZE="-1">\r
57 org.openafs.jafsadm</FONT>\r
58 <BR>\r
59 Class  K5User</H2>\r
60 <PRE>\r
61 <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>\r
62   |\r
63   +--<B>org.openafs.jafsadm.K5User</B>\r
64 </PRE>\r
65 <HR>\r
66 <DL>\r
67 <DT>public class <B>K5User</B><DT>extends <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></DL>\r
68 \r
69 <P>\r
70 An abstract representation of an AFS Kerberos V user.\r
71  <BR><BR>\r
72 \r
73  <TABLE WIDTH="100%" CELLSPACING="2" CELLPADDING="8" BORDER="1"><TR><TD>\r
74  <FONT COLOR="AA0000"><B>This document should be considered a preliminary \r
75  draft posted for the purpose of feedback and should not be\r
76  considered a functional API document.</FONT>\r
77  \r
78  <P>The members of this class are strictly modeled after \r
79  the <code>kadmin command</code>.</B>\r
80  </TD></TR></TABLE><BR><BR>\r
81 <P>\r
82 <DL>\r
83 <DT><B>Version: </B><DD>1.0, 3/31/02</DD>\r
84 </DL>\r
85 <HR>\r
86 \r
87 <P>\r
88 <!-- ======== INNER CLASS SUMMARY ======== -->\r
89 \r
90 \r
91 <!-- =========== FIELD SUMMARY =========== -->\r
92 \r
93 \r
94 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
95 \r
96 <A NAME="constructor_summary"><!-- --></A>\r
97 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
98 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
99 <TD COLSPAN=2><FONT SIZE="+2">\r
100 <B>Constructor Summary</B></FONT></TD>\r
101 </TR>\r
102 <TR BGCOLOR="white" CLASS="TableRowColor">\r
103 <TD><CODE><B><A HREF="K5User.html#K5User(java.lang.String, org.openafs.jafsadm.Cell)">K5User</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,\r
104        <A HREF="Cell.html">Cell</A>&nbsp;cell)</CODE>\r
105 \r
106 <BR>\r
107 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new <CODE>K5User</CODE> object instance given the name of the AFS user\r
108  and the AFS cell, represented by <CODE>cell</CODE>, to which it belongs.</TD>\r
109 </TR>\r
110 <TR BGCOLOR="white" CLASS="TableRowColor">\r
111 <TD><CODE><B><A HREF="K5User.html#K5User(java.lang.String, org.openafs.jafsadm.Cell, org.openafs.jafsadm.K5PasswordPolicy)">K5User</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,\r
112        <A HREF="Cell.html">Cell</A>&nbsp;cell,\r
113        <A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A>&nbsp;passwordPolicy)</CODE>\r
114 \r
115 <BR>\r
116 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new <CODE>K5User</CODE> object instance given the name of the AFS user\r
117  and the AFS cell, represented by <CODE>cell</CODE>, to which it belongs and the \r
118  Kerberos 5 Password Policy to be applied.</TD>\r
119 </TR>\r
120 </TABLE>\r
121 &nbsp;\r
122 <!-- ========== METHOD SUMMARY =========== -->\r
123 \r
124 <A NAME="method_summary"><!-- --></A>\r
125 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
126 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
127 <TD COLSPAN=2><FONT SIZE="+2">\r
128 <B>Method Summary</B></FONT></TD>\r
129 </TR>\r
130 <TR BGCOLOR="white" CLASS="TableRowColor">\r
131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
132 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
133 <TD><CODE><B><A HREF="K5User.html#allowsDuplicateSessionKey()">allowsDuplicateSessionKey</A></B>()</CODE>\r
134 \r
135 <BR>\r
136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5 Attribute: Tests if this principal is allowed to obtain a session key\r
137  for another user.</TD>\r
138 </TR>\r
139 <TR BGCOLOR="white" CLASS="TableRowColor">\r
140 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
141 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
142 <TD><CODE><B><A HREF="K5User.html#allowsForwardableTickets()">allowsForwardableTickets</A></B>()</CODE>\r
143 \r
144 <BR>\r
145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5 Attribute: Tests if this principal is allowed to obtain forwardable tickets.</TD>\r
146 </TR>\r
147 <TR BGCOLOR="white" CLASS="TableRowColor">\r
148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
149 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
150 <TD><CODE><B><A HREF="K5User.html#allowsPostDatedTickets()">allowsPostDatedTickets</A></B>()</CODE>\r
151 \r
152 <BR>\r
153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5 Attribute: Tests if this principal is allowed to obtain postdated tickets.</TD>\r
154 </TR>\r
155 <TR BGCOLOR="white" CLASS="TableRowColor">\r
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
157 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
158 <TD><CODE><B><A HREF="K5User.html#allowsProxiableTickets()">allowsProxiableTickets</A></B>()</CODE>\r
159 \r
160 <BR>\r
161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5 Attribute: Tests if this principal is allowed to obtain proxiable tickets.</TD>\r
162 </TR>\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">\r
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
165 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
166 <TD><CODE><B><A HREF="K5User.html#allowsRenewableTickets()">allowsRenewableTickets</A></B>()</CODE>\r
167 \r
168 <BR>\r
169 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5 Attribute: Tests if this principal is allowed to obtain renewable tickets.</TD>\r
170 </TR>\r
171 <TR BGCOLOR="white" CLASS="TableRowColor">\r
172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
173 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
174 <TD><CODE><B><A HREF="K5User.html#allowsServiceTickets()">allowsServiceTickets</A></B>()</CODE>\r
175 \r
176 <BR>\r
177 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5 Attribute: Tests if this principal is allowed to obtain service tickets.</TD>\r
178 </TR>\r
179 <TR BGCOLOR="white" CLASS="TableRowColor">\r
180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
181 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
182 <TD><CODE><B><A HREF="K5User.html#canChangePassword()">canChangePassword</A></B>()</CODE>\r
183 \r
184 <BR>\r
185 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns whether or not the user can change their password</TD>\r
186 </TR>\r
187 <TR BGCOLOR="white" CLASS="TableRowColor">\r
188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
189 <CODE>&nbsp;int</CODE></FONT></TD>\r
190 <TD><CODE><B><A HREF="K5User.html#compareTo(org.openafs.jafsadm.K5User)">compareTo</A></B>(<A HREF="K5User.html">K5User</A>&nbsp;user)</CODE>\r
191 \r
192 <BR>\r
193 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares two K5User objects respective to their names and does not\r
194  factor any other attribute.</TD>\r
195 </TR>\r
196 <TR BGCOLOR="white" CLASS="TableRowColor">\r
197 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
198 <CODE>&nbsp;int</CODE></FONT></TD>\r
199 <TD><CODE><B><A HREF="K5User.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A>&nbsp;obj)</CODE>\r
200 \r
201 <BR>\r
202 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Comparable interface method.</TD>\r
203 </TR>\r
204 <TR BGCOLOR="white" CLASS="TableRowColor">\r
205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
206 <CODE>&nbsp;void</CODE></FONT></TD>\r
207 <TD><CODE><B><A HREF="K5User.html#create(java.lang.String)">create</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;password)</CODE>\r
208 \r
209 <BR>\r
210 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the Kerberos 5 entries for a new user in this cell.</TD>\r
211 </TR>\r
212 <TR BGCOLOR="white" CLASS="TableRowColor">\r
213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
214 <CODE>&nbsp;void</CODE></FONT></TD>\r
215 <TD><CODE><B><A HREF="K5User.html#delete()">delete</A></B>()</CODE>\r
216 \r
217 <BR>\r
218 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the K5 entries for a user in this cell.</TD>\r
219 </TR>\r
220 <TR BGCOLOR="white" CLASS="TableRowColor">\r
221 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
222 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
223 <TD><CODE><B><A HREF="K5User.html#equals(org.openafs.jafsadm.K5User)">equals</A></B>(<A HREF="K5User.html">K5User</A>&nbsp;otherUser)</CODE>\r
224 \r
225 <BR>\r
226 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether two <code>K5User</code> objects are equal, based on their names.</TD>\r
227 </TR>\r
228 <TR BGCOLOR="white" CLASS="TableRowColor">\r
229 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
230 <CODE>&nbsp;<A HREF="Cell.html">Cell</A></CODE></FONT></TD>\r
231 <TD><CODE><B><A HREF="K5User.html#getCell()">getCell</A></B>()</CODE>\r
232 \r
233 <BR>\r
234 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Cell/Realm this user belongs to.</TD>\r
235 </TR>\r
236 <TR BGCOLOR="white" CLASS="TableRowColor">\r
237 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
238 <CODE>&nbsp;int</CODE></FONT></TD>\r
239 <TD><CODE><B><A HREF="K5User.html#getFailLoginCount()">getFailLoginCount</A></B>()</CODE>\r
240 \r
241 <BR>\r
242 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the number of failed login attempts this user is allowed before being locked out.</TD>\r
243 </TR>\r
244 <TR BGCOLOR="white" CLASS="TableRowColor">\r
245 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
246 <CODE>&nbsp;int</CODE></FONT></TD>\r
247 <TD><CODE><B><A HREF="K5User.html#getKeyVersion()">getKeyVersion</A></B>()</CODE>\r
248 \r
249 <BR>\r
250 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the version of the user's key.</TD>\r
251 </TR>\r
252 <TR BGCOLOR="white" CLASS="TableRowColor">\r
253 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
254 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>\r
255 <TD><CODE><B><A HREF="K5User.html#getLastChangePasswordDate()">getLastChangePasswordDate</A></B>()</CODE>\r
256 \r
257 <BR>\r
258 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the last date and time the user changed its password.</TD>\r
259 </TR>\r
260 <TR BGCOLOR="white" CLASS="TableRowColor">\r
261 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
262 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>\r
263 <TD><CODE><B><A HREF="K5User.html#getLastModDate()">getLastModDate</A></B>()</CODE>\r
264 \r
265 <BR>\r
266 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the date and time the user was last modified.</TD>\r
267 </TR>\r
268 <TR BGCOLOR="white" CLASS="TableRowColor">\r
269 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
270 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>\r
271 <TD><CODE><B><A HREF="K5User.html#getLastModName()">getLastModName</A></B>()</CODE>\r
272 \r
273 <BR>\r
274 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the name of this user that last modified this user.</TD>\r
275 </TR>\r
276 <TR BGCOLOR="white" CLASS="TableRowColor">\r
277 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
278 <CODE>&nbsp;int</CODE></FONT></TD>\r
279 <TD><CODE><B><A HREF="K5User.html#getMasterKeyVersion()">getMasterKeyVersion</A></B>()</CODE>\r
280 \r
281 <BR>\r
282 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the master key version of this user.</TD>\r
283 </TR>\r
284 <TR BGCOLOR="white" CLASS="TableRowColor">\r
285 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
286 <CODE>&nbsp;int</CODE></FONT></TD>\r
287 <TD><CODE><B><A HREF="K5User.html#getMaxRenewableLife()">getMaxRenewableLife</A></B>()</CODE>\r
288 \r
289 <BR>\r
290 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the the maximum renewable life of this user.</TD>\r
291 </TR>\r
292 <TR BGCOLOR="white" CLASS="TableRowColor">\r
293 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
294 <CODE>&nbsp;int</CODE></FONT></TD>\r
295 <TD><CODE><B><A HREF="K5User.html#getMaxTicketLifetime()">getMaxTicketLifetime</A></B>()</CODE>\r
296 \r
297 <BR>\r
298 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the maximum lifetime of a ticket issued to this user (in seconds).</TD>\r
299 </TR>\r
300 <TR BGCOLOR="white" CLASS="TableRowColor">\r
301 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
302 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>\r
303 <TD><CODE><B><A HREF="K5User.html#getName()">getName</A></B>()</CODE>\r
304 \r
305 <BR>\r
306 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this user.</TD>\r
307 </TR>\r
308 <TR BGCOLOR="white" CLASS="TableRowColor">\r
309 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
310 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>\r
311 <TD><CODE><B><A HREF="K5User.html#getPasswordExpirationDate()">getPasswordExpirationDate</A></B>()</CODE>\r
312 \r
313 <BR>\r
314 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the date and time the password expires.</TD>\r
315 </TR>\r
316 <TR BGCOLOR="white" CLASS="TableRowColor">\r
317 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
318 <CODE>&nbsp;<A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A></CODE></FONT></TD>\r
319 <TD><CODE><B><A HREF="K5User.html#getPasswordPolicy()">getPasswordPolicy</A></B>()</CODE>\r
320 \r
321 <BR>\r
322 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the password policy assigned to this user.</TD>\r
323 </TR>\r
324 <TR BGCOLOR="white" CLASS="TableRowColor">\r
325 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
326 <CODE>&nbsp;int</CODE></FONT></TD>\r
327 <TD><CODE><B><A HREF="K5User.html#getSaltType()">getSaltType</A></B>()</CODE>\r
328 \r
329 <BR>\r
330 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the specified salt for generating the key.</TD>\r
331 </TR>\r
332 <TR BGCOLOR="white" CLASS="TableRowColor">\r
333 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
334 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A></CODE></FONT></TD>\r
335 <TD><CODE><B><A HREF="K5User.html#getUserExpirationDate()">getUserExpirationDate</A></B>()</CODE>\r
336 \r
337 <BR>\r
338 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns the date and time the user expires.</TD>\r
339 </TR>\r
340 <TR BGCOLOR="white" CLASS="TableRowColor">\r
341 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
342 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
343 <TD><CODE><B><A HREF="K5User.html#requiresHardwareAuth()">requiresHardwareAuth</A></B>()</CODE>\r
344 \r
345 <BR>\r
346 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5 Attribute: Tests if this principal is required to preauthenticate using a hardware device before being allowed to kinit.</TD>\r
347 </TR>\r
348 <TR BGCOLOR="white" CLASS="TableRowColor">\r
349 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
350 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
351 <TD><CODE><B><A HREF="K5User.html#requiresPasswordChange()">requiresPasswordChange</A></B>()</CODE>\r
352 \r
353 <BR>\r
354 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5 Attribute: Flag in attributes field to force a password change.</TD>\r
355 </TR>\r
356 <TR BGCOLOR="white" CLASS="TableRowColor">\r
357 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
358 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
359 <TD><CODE><B><A HREF="K5User.html#requiresPreAuth()">requiresPreAuth</A></B>()</CODE>\r
360 \r
361 <BR>\r
362 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5 Attribute: Tests if this principal is required to preauthenticate before being allowed to kinit.</TD>\r
363 </TR>\r
364 <TR BGCOLOR="white" CLASS="TableRowColor">\r
365 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
366 <CODE>&nbsp;void</CODE></FONT></TD>\r
367 <TD><CODE><B><A HREF="K5User.html#setChangePassword(boolean)">setChangePassword</A></B>(boolean&nbsp;setting)</CODE>\r
368 \r
369 <BR>\r
370 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets whether or not the user can change their password</TD>\r
371 </TR>\r
372 <TR BGCOLOR="white" CLASS="TableRowColor">\r
373 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
374 <CODE>&nbsp;void</CODE></FONT></TD>\r
375 <TD><CODE><B><A HREF="K5User.html#setDuplicateSessionKey(boolean)">setDuplicateSessionKey</A></B>(boolean&nbsp;flag)</CODE>\r
376 \r
377 <BR>\r
378 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets attribute to allow/deny this principal from obtaining a session key for another user.</TD>\r
379 </TR>\r
380 <TR BGCOLOR="white" CLASS="TableRowColor">\r
381 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
382 <CODE>&nbsp;void</CODE></FONT></TD>\r
383 <TD><CODE><B><A HREF="K5User.html#setFailLoginCount(int)">setFailLoginCount</A></B>(int&nbsp;logins)</CODE>\r
384 \r
385 <BR>\r
386 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets the number of failed login attempts this user is allowed before being locked out.</TD>\r
387 </TR>\r
388 <TR BGCOLOR="white" CLASS="TableRowColor">\r
389 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
390 <CODE>&nbsp;void</CODE></FONT></TD>\r
391 <TD><CODE><B><A HREF="K5User.html#setForwardableTickets(boolean)">setForwardableTickets</A></B>(boolean&nbsp;flag)</CODE>\r
392 \r
393 <BR>\r
394 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets attribute to allow/deny this principal from obtaining forwardable tickets.</TD>\r
395 </TR>\r
396 <TR BGCOLOR="white" CLASS="TableRowColor">\r
397 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
398 <CODE>&nbsp;void</CODE></FONT></TD>\r
399 <TD><CODE><B><A HREF="K5User.html#setGrantTickets(boolean)">setGrantTickets</A></B>(boolean&nbsp;setting)</CODE>\r
400 \r
401 <BR>\r
402 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets whether or not TGS will issue tickets for this K5User</TD>\r
403 </TR>\r
404 <TR BGCOLOR="white" CLASS="TableRowColor">\r
405 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
406 <CODE>&nbsp;void</CODE></FONT></TD>\r
407 <TD><CODE><B><A HREF="K5User.html#setHardwareAuth(boolean)">setHardwareAuth</A></B>(boolean&nbsp;flag)</CODE>\r
408 \r
409 <BR>\r
410 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets attribute to require this principal to preauthenticate using a\r
411  hardware device before being allowed to kinit, if <CODE>flag</CODE> is true.</TD>\r
412 </TR>\r
413 <TR BGCOLOR="white" CLASS="TableRowColor">\r
414 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
415 <CODE>&nbsp;void</CODE></FONT></TD>\r
416 <TD><CODE><B><A HREF="K5User.html#setMaxTicketLifetime(int)">setMaxTicketLifetime</A></B>(int&nbsp;seconds)</CODE>\r
417 \r
418 <BR>\r
419 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets the maximum lifetime of a ticket issued to this user (in seconds).</TD>\r
420 </TR>\r
421 <TR BGCOLOR="white" CLASS="TableRowColor">\r
422 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
423 <CODE>&nbsp;void</CODE></FONT></TD>\r
424 <TD><CODE><B><A HREF="K5User.html#setPassword(java.lang.String)">setPassword</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;newPassword)</CODE>\r
425 \r
426 <BR>\r
427 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the password of this user to something new.</TD>\r
428 </TR>\r
429 <TR BGCOLOR="white" CLASS="TableRowColor">\r
430 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
431 <CODE>&nbsp;void</CODE></FONT></TD>\r
432 <TD><CODE><B><A HREF="K5User.html#setPasswordChange(boolean)">setPasswordChange</A></B>(boolean&nbsp;flag)</CODE>\r
433 \r
434 <BR>\r
435 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets attribute to force a password change for this principal, if <CODE>flag</CODE> is true.</TD>\r
436 </TR>\r
437 <TR BGCOLOR="white" CLASS="TableRowColor">\r
438 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
439 <CODE>&nbsp;void</CODE></FONT></TD>\r
440 <TD><CODE><B><A HREF="K5User.html#setPasswordExpiration(java.util.GregorianCalendar)">setPasswordExpiration</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A>&nbsp;expirationDate)</CODE>\r
441 \r
442 <BR>\r
443 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets the date and time the password expires.</TD>\r
444 </TR>\r
445 <TR BGCOLOR="white" CLASS="TableRowColor">\r
446 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
447 <CODE>&nbsp;void</CODE></FONT></TD>\r
448 <TD><CODE><B><A HREF="K5User.html#setPasswordPolicy(org.openafs.jafsadm.K5PasswordPolicy)">setPasswordPolicy</A></B>(<A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A>&nbsp;policy)</CODE>\r
449 \r
450 <BR>\r
451 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets the password policy for this user.</TD>\r
452 </TR>\r
453 <TR BGCOLOR="white" CLASS="TableRowColor">\r
454 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
455 <CODE>&nbsp;void</CODE></FONT></TD>\r
456 <TD><CODE><B><A HREF="K5User.html#setPostDatedTickets(boolean)">setPostDatedTickets</A></B>(boolean&nbsp;flag)</CODE>\r
457 \r
458 <BR>\r
459 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets attribute to allow/deny this principal from obtaining postdated tickets.</TD>\r
460 </TR>\r
461 <TR BGCOLOR="white" CLASS="TableRowColor">\r
462 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
463 <CODE>&nbsp;void</CODE></FONT></TD>\r
464 <TD><CODE><B><A HREF="K5User.html#setPreAuth(boolean)">setPreAuth</A></B>(boolean&nbsp;flag)</CODE>\r
465 \r
466 <BR>\r
467 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets attribute to require this principal to preauthenticate before \r
468  being allowed to kinit, if <CODE>flag</CODE> is true.</TD>\r
469 </TR>\r
470 <TR BGCOLOR="white" CLASS="TableRowColor">\r
471 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
472 <CODE>&nbsp;void</CODE></FONT></TD>\r
473 <TD><CODE><B><A HREF="K5User.html#setProxiableTickets(boolean)">setProxiableTickets</A></B>(boolean&nbsp;flag)</CODE>\r
474 \r
475 <BR>\r
476 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets attribute to allow/deny this principal from obtaining proxiable tickets.</TD>\r
477 </TR>\r
478 <TR BGCOLOR="white" CLASS="TableRowColor">\r
479 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
480 <CODE>&nbsp;void</CODE></FONT></TD>\r
481 <TD><CODE><B><A HREF="K5User.html#setRenewableTickets(boolean)">setRenewableTickets</A></B>(boolean&nbsp;flag)</CODE>\r
482 \r
483 <BR>\r
484 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets attribute to allow/deny this principal from obtaining renewable tickets.</TD>\r
485 </TR>\r
486 <TR BGCOLOR="white" CLASS="TableRowColor">\r
487 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
488 <CODE>&nbsp;void</CODE></FONT></TD>\r
489 <TD><CODE><B><A HREF="K5User.html#setSaltType(int)">setSaltType</A></B>(int&nbsp;type)</CODE>\r
490 \r
491 <BR>\r
492 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets the specified salt for generating the key.</TD>\r
493 </TR>\r
494 <TR BGCOLOR="white" CLASS="TableRowColor">\r
495 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
496 <CODE>&nbsp;void</CODE></FONT></TD>\r
497 <TD><CODE><B><A HREF="K5User.html#setServiceTickets(boolean)">setServiceTickets</A></B>(boolean&nbsp;flag)</CODE>\r
498 \r
499 <BR>\r
500 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets attribute to allow/deny this principal from obtaining service tickets.</TD>\r
501 </TR>\r
502 <TR BGCOLOR="white" CLASS="TableRowColor">\r
503 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
504 <CODE>&nbsp;void</CODE></FONT></TD>\r
505 <TD><CODE><B><A HREF="K5User.html#setUserExpiration(java.util.GregorianCalendar)">setUserExpiration</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A>&nbsp;expirationDate)</CODE>\r
506 \r
507 <BR>\r
508 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Sets the date and time the user expires.</TD>\r
509 </TR>\r
510 <TR BGCOLOR="white" CLASS="TableRowColor">\r
511 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
512 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>\r
513 <TD><CODE><B><A HREF="K5User.html#toString()">toString</A></B>()</CODE>\r
514 \r
515 <BR>\r
516 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this <CODE>User</CODE></TD>\r
517 </TR>\r
518 <TR BGCOLOR="white" CLASS="TableRowColor">\r
519 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
520 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
521 <TD><CODE><B><A HREF="K5User.html#willGrantTickets()">willGrantTickets</A></B>()</CODE>\r
522 \r
523 <BR>\r
524 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;K5: Returns whether or not TGS will issue tickets for this user</TD>\r
525 </TR>\r
526 </TABLE>\r
527 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
528 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
529 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
530 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></B></TD>\r
531 </TR>\r
532 <TR BGCOLOR="white" CLASS="TableRowColor">\r
533 <TD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>\r
534 </TR>\r
535 </TABLE>\r
536 &nbsp;\r
537 <P>\r
538 \r
539 <!-- ============ FIELD DETAIL =========== -->\r
540 \r
541 \r
542 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
543 \r
544 <A NAME="constructor_detail"><!-- --></A>\r
545 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
546 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
547 <TD COLSPAN=1><FONT SIZE="+2">\r
548 <B>Constructor Detail</B></FONT></TD>\r
549 </TR>\r
550 </TABLE>\r
551 \r
552 <A NAME="K5User(java.lang.String, org.openafs.jafsadm.Cell)"><!-- --></A><H3>\r
553 K5User</H3>\r
554 <PRE>\r
555 public <B>K5User</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,\r
556               <A HREF="Cell.html">Cell</A>&nbsp;cell)\r
557        throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
558 <DL>\r
559 <DD>Constructs a new <CODE>K5User</CODE> object instance given the name of the AFS user\r
560  and the AFS cell, represented by <CODE>cell</CODE>, to which it belongs.<DD><DL>\r
561 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the user to represent<DD><CODE>cell</CODE> - the cell to which the user belongs.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
562 </DD>\r
563 </DL>\r
564 <HR>\r
565 \r
566 <A NAME="K5User(java.lang.String, org.openafs.jafsadm.Cell, org.openafs.jafsadm.K5PasswordPolicy)"><!-- --></A><H3>\r
567 K5User</H3>\r
568 <PRE>\r
569 public <B>K5User</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,\r
570               <A HREF="Cell.html">Cell</A>&nbsp;cell,\r
571               <A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A>&nbsp;passwordPolicy)\r
572        throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
573 <DL>\r
574 <DD>Constructs a new <CODE>K5User</CODE> object instance given the name of the AFS user\r
575  and the AFS cell, represented by <CODE>cell</CODE>, to which it belongs and the \r
576  Kerberos 5 Password Policy to be applied.<DD><DL>\r
577 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the user to represent<DD><CODE>cell</CODE> - the cell to which the user belongs.<DD><CODE>passwordPolicy</CODE> - the K5 password policy to be applied to this user.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
578 </DD>\r
579 </DL>\r
580 \r
581 <!-- ============ METHOD DETAIL ========== -->\r
582 \r
583 <A NAME="method_detail"><!-- --></A>\r
584 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
585 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
586 <TD COLSPAN=1><FONT SIZE="+2">\r
587 <B>Method Detail</B></FONT></TD>\r
588 </TR>\r
589 </TABLE>\r
590 \r
591 <A NAME="create(java.lang.String)"><!-- --></A><H3>\r
592 create</H3>\r
593 <PRE>\r
594 public void <B>create</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;password)\r
595             throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
596 <DL>\r
597 <DD>Creates the Kerberos 5 entries for a new user in this cell.  Automatically assigns \r
598  a user id.  Be sure to call <code>refreshUsers</code> afterward to update this <code>\r
599  Cell's</code> user list.<DD><DL>\r
600 <DT><B>Parameters:</B><DD><CODE>password</CODE> - the password for the new user<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
601 </DD>\r
602 </DL>\r
603 <HR>\r
604 \r
605 <A NAME="delete()"><!-- --></A><H3>\r
606 delete</H3>\r
607 <PRE>\r
608 public void <B>delete</B>()\r
609             throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
610 <DL>\r
611 <DD>Deletes the K5 entries for a user in this cell. Deletes this user \r
612  from the membership list of the groups to which it belonged, but does not \r
613  delete the groups owned by this user.  Also nullifies this corresponding \r
614  Java object.<DD><DL>\r
615 <DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
616 </DD>\r
617 </DL>\r
618 <HR>\r
619 \r
620 <A NAME="getName()"><!-- --></A><H3>\r
621 getName</H3>\r
622 <PRE>\r
623 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>\r
624 <DL>\r
625 <DD>Returns the name of this user.<DD><DL>\r
626 <DT><B>Returns:</B><DD>the name of this user</DL>\r
627 </DD>\r
628 </DL>\r
629 <HR>\r
630 \r
631 <A NAME="getCell()"><!-- --></A><H3>\r
632 getCell</H3>\r
633 <PRE>\r
634 public <A HREF="Cell.html">Cell</A> <B>getCell</B>()</PRE>\r
635 <DL>\r
636 <DD>Returns the Cell/Realm this user belongs to.<DD><DL>\r
637 <DT><B>Returns:</B><DD>the Cell this user belongs to</DL>\r
638 </DD>\r
639 </DL>\r
640 <HR>\r
641 \r
642 <A NAME="willGrantTickets()"><!-- --></A><H3>\r
643 willGrantTickets</H3>\r
644 <PRE>\r
645 public boolean <B>willGrantTickets</B>()\r
646                          throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
647 <DL>\r
648 <DD>K5: Returns whether or not TGS will issue tickets for this user<DD><DL>\r
649 <DT><B>Returns:</B><DD>whether or not TGS will issue tickets for this user<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
650 </DD>\r
651 </DL>\r
652 <HR>\r
653 \r
654 <A NAME="canChangePassword()"><!-- --></A><H3>\r
655 canChangePassword</H3>\r
656 <PRE>\r
657 public boolean <B>canChangePassword</B>()\r
658                           throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
659 <DL>\r
660 <DD>K5: Returns whether or not the user can change their password<DD><DL>\r
661 <DT><B>Returns:</B><DD>whether or not the user can change their password<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
662 </DD>\r
663 </DL>\r
664 <HR>\r
665 \r
666 <A NAME="getUserExpirationDate()"><!-- --></A><H3>\r
667 getUserExpirationDate</H3>\r
668 <PRE>\r
669 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>getUserExpirationDate</B>()\r
670                                         throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
671 <DL>\r
672 <DD>K5: Returns the date and time the user expires.  \r
673  A <code>null</code> value indicates the user never exipres (or that\r
674  there is no k5 entry for this user).<DD><DL>\r
675 <DT><B>Returns:</B><DD>the date and time the user expires<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
676 </DD>\r
677 </DL>\r
678 <HR>\r
679 \r
680 <A NAME="getLastModDate()"><!-- --></A><H3>\r
681 getLastModDate</H3>\r
682 <PRE>\r
683 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>getLastModDate</B>()\r
684                                  throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
685 <DL>\r
686 <DD>K5: Returns the date and time the user was last modified.<DD><DL>\r
687 <DT><B>Returns:</B><DD>the date and time the user was last modified<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
688 </DD>\r
689 </DL>\r
690 <HR>\r
691 \r
692 <A NAME="getLastModName()"><!-- --></A><H3>\r
693 getLastModName</H3>\r
694 <PRE>\r
695 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>getLastModName</B>()\r
696                       throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
697 <DL>\r
698 <DD>K5: Returns the name of this user that last modified this user.<DD><DL>\r
699 <DT><B>Returns:</B><DD>the name of this user that last modified this user.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
700 </DD>\r
701 </DL>\r
702 <HR>\r
703 \r
704 <A NAME="getLastChangePasswordDate()"><!-- --></A><H3>\r
705 getLastChangePasswordDate</H3>\r
706 <PRE>\r
707 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>getLastChangePasswordDate</B>()\r
708                                             throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
709 <DL>\r
710 <DD>K5: Returns the last date and time the user changed its password.<DD><DL>\r
711 <DT><B>Returns:</B><DD>the last date and time the user changed its password.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
712 </DD>\r
713 </DL>\r
714 <HR>\r
715 \r
716 <A NAME="getMaxTicketLifetime()"><!-- --></A><H3>\r
717 getMaxTicketLifetime</H3>\r
718 <PRE>\r
719 public int <B>getMaxTicketLifetime</B>()\r
720                          throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
721 <DL>\r
722 <DD>K5: Returns the maximum lifetime of a ticket issued to this user (in seconds).<DD><DL>\r
723 <DT><B>Returns:</B><DD>the maximum lifetime of a ticket issued to this user (in seconds).<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
724 </DD>\r
725 </DL>\r
726 <HR>\r
727 \r
728 <A NAME="getPasswordPolicy()"><!-- --></A><H3>\r
729 getPasswordPolicy</H3>\r
730 <PRE>\r
731 public <A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A> <B>getPasswordPolicy</B>()\r
732                                    throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
733 <DL>\r
734 <DD>K5: Returns the password policy assigned to this user.<DD><DL>\r
735 <DT><B>Returns:</B><DD>the password policy assigned to this user.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
736 </DD>\r
737 </DL>\r
738 <HR>\r
739 \r
740 <A NAME="getPasswordExpirationDate()"><!-- --></A><H3>\r
741 getPasswordExpirationDate</H3>\r
742 <PRE>\r
743 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> <B>getPasswordExpirationDate</B>()\r
744                                             throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
745 <DL>\r
746 <DD>K5: Returns the date and time the password expires.  \r
747  A <code>null</code> value indicates the password never exipres (or that\r
748  there is no k5 entry for this user).<DD><DL>\r
749 <DT><B>Returns:</B><DD>the number of days for which a password is valid<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
750 </DD>\r
751 </DL>\r
752 <HR>\r
753 \r
754 <A NAME="getFailLoginCount()"><!-- --></A><H3>\r
755 getFailLoginCount</H3>\r
756 <PRE>\r
757 public int <B>getFailLoginCount</B>()\r
758                       throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
759 <DL>\r
760 <DD>K5: Returns the number of failed login attempts this user is allowed before being locked out.  \r
761  A value of 0 indicates there is no limit.<DD><DL>\r
762 <DT><B>Returns:</B><DD>the number of failed login attempts a user is allowed<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
763 </DD>\r
764 </DL>\r
765 <HR>\r
766 \r
767 <A NAME="getMasterKeyVersion()"><!-- --></A><H3>\r
768 getMasterKeyVersion</H3>\r
769 <PRE>\r
770 public int <B>getMasterKeyVersion</B>()\r
771                         throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
772 <DL>\r
773 <DD>K5: Returns the master key version of this user.<DD><DL>\r
774 <DT><B>Returns:</B><DD>the master key version<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
775 </DD>\r
776 </DL>\r
777 <HR>\r
778 \r
779 <A NAME="getKeyVersion()"><!-- --></A><H3>\r
780 getKeyVersion</H3>\r
781 <PRE>\r
782 public int <B>getKeyVersion</B>()\r
783                   throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
784 <DL>\r
785 <DD>K5: Returns the version of the user's key.<DD><DL>\r
786 <DT><B>Returns:</B><DD>the key version<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
787 </DD>\r
788 </DL>\r
789 <HR>\r
790 \r
791 <A NAME="getMaxRenewableLife()"><!-- --></A><H3>\r
792 getMaxRenewableLife</H3>\r
793 <PRE>\r
794 public int <B>getMaxRenewableLife</B>()\r
795                         throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
796 <DL>\r
797 <DD>K5: Returns the the maximum renewable life of this user.<DD><DL>\r
798 <DT><B>Returns:</B><DD>the the the maximum renewable life of this user.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
799 </DD>\r
800 </DL>\r
801 <HR>\r
802 \r
803 <A NAME="getSaltType()"><!-- --></A><H3>\r
804 getSaltType</H3>\r
805 <PRE>\r
806 public int <B>getSaltType</B>()\r
807                 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
808 <DL>\r
809 <DD>K5: Returns the specified salt for generating the key.<DD><DL>\r
810 <DT><B>Returns:</B><DD>the key version<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
811 </DD>\r
812 </DL>\r
813 <HR>\r
814 \r
815 <A NAME="allowsPostDatedTickets()"><!-- --></A><H3>\r
816 allowsPostDatedTickets</H3>\r
817 <PRE>\r
818 public boolean <B>allowsPostDatedTickets</B>()\r
819                                throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
820 <DL>\r
821 <DD>K5 Attribute: Tests if this principal is allowed to obtain postdated tickets.<DD><DL>\r
822 <DT><B>Returns:</B><DD>the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
823 </DD>\r
824 </DL>\r
825 <HR>\r
826 \r
827 <A NAME="allowsForwardableTickets()"><!-- --></A><H3>\r
828 allowsForwardableTickets</H3>\r
829 <PRE>\r
830 public boolean <B>allowsForwardableTickets</B>()\r
831                                  throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
832 <DL>\r
833 <DD>K5 Attribute: Tests if this principal is allowed to obtain forwardable tickets.<DD><DL>\r
834 <DT><B>Returns:</B><DD>the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
835 </DD>\r
836 </DL>\r
837 <HR>\r
838 \r
839 <A NAME="allowsRenewableTickets()"><!-- --></A><H3>\r
840 allowsRenewableTickets</H3>\r
841 <PRE>\r
842 public boolean <B>allowsRenewableTickets</B>()\r
843                                throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
844 <DL>\r
845 <DD>K5 Attribute: Tests if this principal is allowed to obtain renewable tickets.<DD><DL>\r
846 <DT><B>Returns:</B><DD>the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
847 </DD>\r
848 </DL>\r
849 <HR>\r
850 \r
851 <A NAME="allowsProxiableTickets()"><!-- --></A><H3>\r
852 allowsProxiableTickets</H3>\r
853 <PRE>\r
854 public boolean <B>allowsProxiableTickets</B>()\r
855                                throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
856 <DL>\r
857 <DD>K5 Attribute: Tests if this principal is allowed to obtain proxiable tickets.<DD><DL>\r
858 <DT><B>Returns:</B><DD>the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
859 </DD>\r
860 </DL>\r
861 <HR>\r
862 \r
863 <A NAME="allowsServiceTickets()"><!-- --></A><H3>\r
864 allowsServiceTickets</H3>\r
865 <PRE>\r
866 public boolean <B>allowsServiceTickets</B>()\r
867                              throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
868 <DL>\r
869 <DD>K5 Attribute: Tests if this principal is allowed to obtain service tickets.<DD><DL>\r
870 <DT><B>Returns:</B><DD>the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
871 </DD>\r
872 </DL>\r
873 <HR>\r
874 \r
875 <A NAME="allowsDuplicateSessionKey()"><!-- --></A><H3>\r
876 allowsDuplicateSessionKey</H3>\r
877 <PRE>\r
878 public boolean <B>allowsDuplicateSessionKey</B>()\r
879                                   throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
880 <DL>\r
881 <DD>K5 Attribute: Tests if this principal is allowed to obtain a session key\r
882  for another user.  True implies that user-to-user authentication is enabled\r
883  for this principal.<DD><DL>\r
884 <DT><B>Returns:</B><DD>the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
885 </DD>\r
886 </DL>\r
887 <HR>\r
888 \r
889 <A NAME="requiresPreAuth()"><!-- --></A><H3>\r
890 requiresPreAuth</H3>\r
891 <PRE>\r
892 public boolean <B>requiresPreAuth</B>()\r
893                         throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
894 <DL>\r
895 <DD>K5 Attribute: Tests if this principal is required to preauthenticate before being allowed to kinit.<DD><DL>\r
896 <DT><B>Returns:</B><DD>the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
897 </DD>\r
898 </DL>\r
899 <HR>\r
900 \r
901 <A NAME="requiresHardwareAuth()"><!-- --></A><H3>\r
902 requiresHardwareAuth</H3>\r
903 <PRE>\r
904 public boolean <B>requiresHardwareAuth</B>()\r
905                              throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
906 <DL>\r
907 <DD>K5 Attribute: Tests if this principal is required to preauthenticate using a hardware device before being allowed to kinit.<DD><DL>\r
908 <DT><B>Returns:</B><DD>the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
909 </DD>\r
910 </DL>\r
911 <HR>\r
912 \r
913 <A NAME="requiresPasswordChange()"><!-- --></A><H3>\r
914 requiresPasswordChange</H3>\r
915 <PRE>\r
916 public boolean <B>requiresPasswordChange</B>()\r
917                                throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
918 <DL>\r
919 <DD>K5 Attribute: Flag in attributes field to force a password change.<DD><DL>\r
920 <DT><B>Returns:</B><DD>the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
921 </DD>\r
922 </DL>\r
923 <HR>\r
924 \r
925 <A NAME="setGrantTickets(boolean)"><!-- --></A><H3>\r
926 setGrantTickets</H3>\r
927 <PRE>\r
928 public void <B>setGrantTickets</B>(boolean&nbsp;setting)</PRE>\r
929 <DL>\r
930 <DD>K5: Sets whether or not TGS will issue tickets for this K5User<DD><DL>\r
931 <DT><B>Parameters:</B><DD><CODE>setting</CODE> - whether or not TGS will issue tickets for this user</DL>\r
932 </DD>\r
933 </DL>\r
934 <HR>\r
935 \r
936 <A NAME="setFailLoginCount(int)"><!-- --></A><H3>\r
937 setFailLoginCount</H3>\r
938 <PRE>\r
939 public void <B>setFailLoginCount</B>(int&nbsp;logins)</PRE>\r
940 <DL>\r
941 <DD>K5: Sets the number of failed login attempts this user is allowed before being locked out.  \r
942  A value of 0 indicates there is no limit.<DD><DL>\r
943 <DT><B>Parameters:</B><DD><CODE>logins</CODE> - the number of failed login attempts a user is allowed</DL>\r
944 </DD>\r
945 </DL>\r
946 <HR>\r
947 \r
948 <A NAME="setChangePassword(boolean)"><!-- --></A><H3>\r
949 setChangePassword</H3>\r
950 <PRE>\r
951 public void <B>setChangePassword</B>(boolean&nbsp;setting)</PRE>\r
952 <DL>\r
953 <DD>K5: Sets whether or not the user can change their password<DD><DL>\r
954 <DT><B>Parameters:</B><DD><CODE>setting</CODE> - whether or not the user can change their password</DL>\r
955 </DD>\r
956 </DL>\r
957 <HR>\r
958 \r
959 <A NAME="setUserExpiration(java.util.GregorianCalendar)"><!-- --></A><H3>\r
960 setUserExpiration</H3>\r
961 <PRE>\r
962 public void <B>setUserExpiration</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A>&nbsp;expirationDate)</PRE>\r
963 <DL>\r
964 <DD>K5: Sets the date and time the user expires.  \r
965  A <code>null</code> value indicates the user never exipres.<DD><DL>\r
966 <DT><B>Parameters:</B><DD><CODE>expirationDate</CODE> - the date and time the user expires</DL>\r
967 </DD>\r
968 </DL>\r
969 <HR>\r
970 \r
971 <A NAME="setPasswordExpiration(java.util.GregorianCalendar)"><!-- --></A><H3>\r
972 setPasswordExpiration</H3>\r
973 <PRE>\r
974 public void <B>setPasswordExpiration</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A>&nbsp;expirationDate)</PRE>\r
975 <DL>\r
976 <DD>K5: Sets the date and time the password expires.  \r
977  A <code>null</code> value indicates the password never exipres.<DD><DL>\r
978 <DT><B>Parameters:</B><DD><CODE>expirationDate</CODE> - the date and time the user expires</DL>\r
979 </DD>\r
980 </DL>\r
981 <HR>\r
982 \r
983 <A NAME="setMaxTicketLifetime(int)"><!-- --></A><H3>\r
984 setMaxTicketLifetime</H3>\r
985 <PRE>\r
986 public void <B>setMaxTicketLifetime</B>(int&nbsp;seconds)</PRE>\r
987 <DL>\r
988 <DD>K5: Sets the maximum lifetime of a ticket issued to this user (in seconds).<DD><DL>\r
989 <DT><B>Parameters:</B><DD><CODE>seconds</CODE> - the maximum lifetime of a ticket issued to this user (in seconds).</DL>\r
990 </DD>\r
991 </DL>\r
992 <HR>\r
993 \r
994 <A NAME="setPasswordPolicy(org.openafs.jafsadm.K5PasswordPolicy)"><!-- --></A><H3>\r
995 setPasswordPolicy</H3>\r
996 <PRE>\r
997 public void <B>setPasswordPolicy</B>(<A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A>&nbsp;policy)</PRE>\r
998 <DL>\r
999 <DD>K5: Sets the password policy for this user.<DD><DL>\r
1000 <DT><B>Parameters:</B><DD><CODE>policy</CODE> - the K5 password policy</DL>\r
1001 </DD>\r
1002 </DL>\r
1003 <HR>\r
1004 \r
1005 <A NAME="setPassword(java.lang.String)"><!-- --></A><H3>\r
1006 setPassword</H3>\r
1007 <PRE>\r
1008 public void <B>setPassword</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;newPassword)\r
1009                  throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1010 <DL>\r
1011 <DD>Sets the password of this user to something new.  Sets the key version \r
1012  to 0 automatically.<DD><DL>\r
1013 <DT><B>Parameters:</B><DD><CODE>newPassword</CODE> - the new password for this user<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1014 </DD>\r
1015 </DL>\r
1016 <HR>\r
1017 \r
1018 <A NAME="setSaltType(int)"><!-- --></A><H3>\r
1019 setSaltType</H3>\r
1020 <PRE>\r
1021 public void <B>setSaltType</B>(int&nbsp;type)\r
1022                  throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1023 <DL>\r
1024 <DD>K5: Sets the specified salt for generating the key.<DD><DL>\r
1025 <DT><B>Returns:</B><DD>the key version<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1026 </DD>\r
1027 </DL>\r
1028 <HR>\r
1029 \r
1030 <A NAME="setPostDatedTickets(boolean)"><!-- --></A><H3>\r
1031 setPostDatedTickets</H3>\r
1032 <PRE>\r
1033 public void <B>setPostDatedTickets</B>(boolean&nbsp;flag)\r
1034                          throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1035 <DL>\r
1036 <DD>K5: Sets attribute to allow/deny this principal from obtaining postdated tickets.\r
1037 \r
1038  Effectively sets the KRB5_KDB_DISALLOW_POSTDATED flag on the principal in\r
1039  the database if <CODE>flag</CODE> is false.<DD><DL>\r
1040 <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1041 </DD>\r
1042 </DL>\r
1043 <HR>\r
1044 \r
1045 <A NAME="setForwardableTickets(boolean)"><!-- --></A><H3>\r
1046 setForwardableTickets</H3>\r
1047 <PRE>\r
1048 public void <B>setForwardableTickets</B>(boolean&nbsp;flag)\r
1049                            throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1050 <DL>\r
1051 <DD>K5: Sets attribute to allow/deny this principal from obtaining forwardable tickets.\r
1052 \r
1053  Effectively sets the KRB5_KDB_DISALLOW_FORWARDABLE flag on the principal in\r
1054  the database if <CODE>flag</CODE> is false.<DD><DL>\r
1055 <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1056 </DD>\r
1057 </DL>\r
1058 <HR>\r
1059 \r
1060 <A NAME="setRenewableTickets(boolean)"><!-- --></A><H3>\r
1061 setRenewableTickets</H3>\r
1062 <PRE>\r
1063 public void <B>setRenewableTickets</B>(boolean&nbsp;flag)\r
1064                          throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1065 <DL>\r
1066 <DD>K5: Sets attribute to allow/deny this principal from obtaining renewable tickets.\r
1067 \r
1068  Effectively sets the KRB5_KDB_DISALLOW_RENEWABLE flag on the principal in\r
1069  the database if <CODE>flag</CODE> is false.<DD><DL>\r
1070 <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1071 </DD>\r
1072 </DL>\r
1073 <HR>\r
1074 \r
1075 <A NAME="setProxiableTickets(boolean)"><!-- --></A><H3>\r
1076 setProxiableTickets</H3>\r
1077 <PRE>\r
1078 public void <B>setProxiableTickets</B>(boolean&nbsp;flag)\r
1079                          throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1080 <DL>\r
1081 <DD>K5: Sets attribute to allow/deny this principal from obtaining proxiable tickets.\r
1082 \r
1083  Effectively sets the KRB5_KDB_DISALLOW_PROXIABLE flag on the principal in\r
1084  the database if <CODE>flag</CODE> is false.<DD><DL>\r
1085 <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1086 </DD>\r
1087 </DL>\r
1088 <HR>\r
1089 \r
1090 <A NAME="setServiceTickets(boolean)"><!-- --></A><H3>\r
1091 setServiceTickets</H3>\r
1092 <PRE>\r
1093 public void <B>setServiceTickets</B>(boolean&nbsp;flag)\r
1094                        throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1095 <DL>\r
1096 <DD>K5: Sets attribute to allow/deny this principal from obtaining service tickets.\r
1097 \r
1098  Effectively sets the KRB5_KDB_DISALLOW_SVR flag on the principal in\r
1099  the database if <CODE>flag</CODE> is false.<DD><DL>\r
1100 <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1101 </DD>\r
1102 </DL>\r
1103 <HR>\r
1104 \r
1105 <A NAME="setDuplicateSessionKey(boolean)"><!-- --></A><H3>\r
1106 setDuplicateSessionKey</H3>\r
1107 <PRE>\r
1108 public void <B>setDuplicateSessionKey</B>(boolean&nbsp;flag)\r
1109                             throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1110 <DL>\r
1111 <DD>K5: Sets attribute to allow/deny this principal from obtaining a session key for another user.\r
1112 \r
1113  Effectively sets the KRB5_KDB_DISALLOW_DUP_SKEY flag on the principal in\r
1114  the database if <CODE>flag</CODE> is false.<DD><DL>\r
1115 <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1116 </DD>\r
1117 </DL>\r
1118 <HR>\r
1119 \r
1120 <A NAME="setPreAuth(boolean)"><!-- --></A><H3>\r
1121 setPreAuth</H3>\r
1122 <PRE>\r
1123 public void <B>setPreAuth</B>(boolean&nbsp;flag)\r
1124                 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1125 <DL>\r
1126 <DD>K5: Sets attribute to require this principal to preauthenticate before \r
1127  being allowed to kinit, if <CODE>flag</CODE> is true.\r
1128 \r
1129  Effectively sets the KRB5_KDB_REQUIRES_PRE_AUTH flag on the principal in\r
1130  the database if <CODE>flag</CODE> is true.<DD><DL>\r
1131 <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1132 </DD>\r
1133 </DL>\r
1134 <HR>\r
1135 \r
1136 <A NAME="setHardwareAuth(boolean)"><!-- --></A><H3>\r
1137 setHardwareAuth</H3>\r
1138 <PRE>\r
1139 public void <B>setHardwareAuth</B>(boolean&nbsp;flag)\r
1140                      throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1141 <DL>\r
1142 <DD>K5: Sets attribute to require this principal to preauthenticate using a\r
1143  hardware device before being allowed to kinit, if <CODE>flag</CODE> is true.\r
1144 \r
1145  Effectively sets the KRB5_KDB_REQUIRES_HW_AUTH flag on the principal in\r
1146  the database if <CODE>flag</CODE> is true.<DD><DL>\r
1147 <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1148 </DD>\r
1149 </DL>\r
1150 <HR>\r
1151 \r
1152 <A NAME="setPasswordChange(boolean)"><!-- --></A><H3>\r
1153 setPasswordChange</H3>\r
1154 <PRE>\r
1155 public void <B>setPasswordChange</B>(boolean&nbsp;flag)\r
1156                        throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
1157 <DL>\r
1158 <DD>K5: Sets attribute to force a password change for this principal, if <CODE>flag</CODE> is true.\r
1159 \r
1160  Effectively sets the KRB5_KDB_REQUIRES_PWCHANGE flag on the principal in\r
1161  the database if <CODE>flag</CODE> is true.<DD><DL>\r
1162 <DT><B>Parameters:</B><DD><CODE>flag</CODE> - the attribute flag<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
1163 </DD>\r
1164 </DL>\r
1165 <HR>\r
1166 \r
1167 <A NAME="compareTo(org.openafs.jafsadm.K5User)"><!-- --></A><H3>\r
1168 compareTo</H3>\r
1169 <PRE>\r
1170 public int <B>compareTo</B>(<A HREF="K5User.html">K5User</A>&nbsp;user)</PRE>\r
1171 <DL>\r
1172 <DD>Compares two K5User objects respective to their names and does not\r
1173  factor any other attribute.    Alphabetic case is significant in \r
1174  comparing names.<DD><DL>\r
1175 <DT><B>Parameters:</B><DD><CODE>user</CODE> - The K5User object to be compared to this K5User instance<DT><B>Returns:</B><DD>Zero if the argument is equal to this User's name, a\r
1176                 value less than zero if this User's name is\r
1177                 lexicographically less than the argument, or a value greater\r
1178                 than zero if this User's name is lexicographically\r
1179                 greater than the argument</DL>\r
1180 </DD>\r
1181 </DL>\r
1182 <HR>\r
1183 \r
1184 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>\r
1185 compareTo</H3>\r
1186 <PRE>\r
1187 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A>&nbsp;obj)</PRE>\r
1188 <DL>\r
1189 <DD>Comparable interface method.<DD><DL>\r
1190 <DT><B>See Also: </B><DD><A HREF="K5User.html#compareTo(org.openafs.jafsadm.K5User)"><CODE>compareTo(K5User)</CODE></A></DL>\r
1191 </DD>\r
1192 </DL>\r
1193 <HR>\r
1194 \r
1195 <A NAME="equals(org.openafs.jafsadm.K5User)"><!-- --></A><H3>\r
1196 equals</H3>\r
1197 <PRE>\r
1198 public boolean <B>equals</B>(<A HREF="K5User.html">K5User</A>&nbsp;otherUser)</PRE>\r
1199 <DL>\r
1200 <DD>Tests whether two <code>K5User</code> objects are equal, based on their names.<DD><DL>\r
1201 <DT><B>Parameters:</B><DD><CODE>otherUser</CODE> - the user to test<DT><B>Returns:</B><DD>whether the specifed user is the same as this user</DL>\r
1202 </DD>\r
1203 </DL>\r
1204 <HR>\r
1205 \r
1206 <A NAME="toString()"><!-- --></A><H3>\r
1207 toString</H3>\r
1208 <PRE>\r
1209 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>\r
1210 <DL>\r
1211 <DD>Returns the name of this <CODE>User</CODE><DD><DL>\r
1212 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html#toString()">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A></CODE></DL>\r
1213 </DD>\r
1214 <DD><DL>\r
1215 <DT><B>Returns:</B><DD>the name of this <CODE>User</CODE></DL>\r
1216 </DD>\r
1217 </DL>\r
1218 <!-- ========= END OF CLASS DATA ========= -->\r
1219 <HR>\r
1220 \r
1221 <!-- ========== START OF NAVBAR ========== -->\r
1222 <A NAME="navbar_bottom"><!-- --></A>\r
1223 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">\r
1224 <TR>\r
1225 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
1226 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
1227 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">\r
1228   <TR ALIGN="center" VALIGN="top">\r
1229   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
1230   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
1231   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/K5User.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
1232   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
1233   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
1234   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
1235   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
1236   </TR>\r
1237 </TABLE>\r
1238 </TD>\r
1239 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
1240 Java AFS Admin (jafsadm) API for OpenAFS</EM>\r
1241 </TD>\r
1242 </TR>\r
1243 \r
1244 <TR>\r
1245 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
1246 &nbsp;<A HREF="K5PasswordPolicy.html"><B>PREV CLASS</B></A>&nbsp;\r
1247 &nbsp;<A HREF="Key.html"><B>NEXT CLASS</B></A></FONT></TD>\r
1248 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
1249   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;\r
1250 &nbsp;<A HREF="K5User.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>\r
1251 </TR>\r
1252 <TR>\r
1253 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
1254   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
1255 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
1256 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
1257 </TR>\r
1258 </TABLE>\r
1259 <!-- =========== END OF NAVBAR =========== -->\r
1260 \r
1261 <HR>\r
1262 <FONT FACE=Arial,Helvetica SIZE="1">Copyright (c) 2001-2002 International Business Machines Corp.<BR>  All rights reserved.<BR>  See <A HREF=copyright.html>copyright statement</A>.<BR></FONT>\r
1263 </BODY>\r
1264 </HTML>\r
1265 \r
1266 \r