1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
\r
5 <!-- Generated by javadoc on Wed Apr 10 17:43:54 PDT 2002 -->
\r
7 Java AFS Admin API: Class K5User
\r
9 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
\r
11 <BODY BGCOLOR="white">
\r
13 <!-- ========== START OF NAVBAR ========== -->
\r
14 <A NAME="navbar_top"><!-- --></A>
\r
15 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
\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> </TD>
\r
22 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
23 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/K5User.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
24 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
25 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
26 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
27 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
31 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
32 <B>Java AFS Admin API v1.3</B></EM>
\r
37 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
38 <A HREF="K5PasswordPolicy.html"><B>PREV CLASS</B></A>
\r
39 <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>
\r
42 <A HREF="K5User.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
\r
45 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
46 SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
47 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
48 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
51 <!-- =========== END OF NAVBAR =========== -->
\r
54 <!-- ======== START OF CLASS DATA ======== -->
\r
57 org.openafs.jafsadm</FONT>
\r
61 <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
\r
63 +--<B>org.openafs.jafsadm.K5User</B>
\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
70 An abstract representation of an AFS Kerberos V user.
\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
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
83 <DT><B>Version: </B><DD>1.0, 3/31/02</DD>
\r
88 <!-- ======== INNER CLASS SUMMARY ======== -->
\r
91 <!-- =========== FIELD SUMMARY =========== -->
\r
94 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\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
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> name,
\r
104 <A HREF="Cell.html">Cell</A> cell)</CODE>
\r
107 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
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> name,
\r
112 <A HREF="Cell.html">Cell</A> cell,
\r
113 <A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A> passwordPolicy)</CODE>
\r
116 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
122 <!-- ========== METHOD SUMMARY =========== -->
\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
130 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
131 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
132 <CODE> boolean</CODE></FONT></TD>
\r
133 <TD><CODE><B><A HREF="K5User.html#allowsDuplicateSessionKey()">allowsDuplicateSessionKey</A></B>()</CODE>
\r
136 K5 Attribute: Tests if this principal is allowed to obtain a session key
\r
137 for another user.</TD>
\r
139 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
140 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
141 <CODE> boolean</CODE></FONT></TD>
\r
142 <TD><CODE><B><A HREF="K5User.html#allowsForwardableTickets()">allowsForwardableTickets</A></B>()</CODE>
\r
145 K5 Attribute: Tests if this principal is allowed to obtain forwardable tickets.</TD>
\r
147 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
148 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
149 <CODE> boolean</CODE></FONT></TD>
\r
150 <TD><CODE><B><A HREF="K5User.html#allowsPostDatedTickets()">allowsPostDatedTickets</A></B>()</CODE>
\r
153 K5 Attribute: Tests if this principal is allowed to obtain postdated tickets.</TD>
\r
155 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
157 <CODE> boolean</CODE></FONT></TD>
\r
158 <TD><CODE><B><A HREF="K5User.html#allowsProxiableTickets()">allowsProxiableTickets</A></B>()</CODE>
\r
161 K5 Attribute: Tests if this principal is allowed to obtain proxiable tickets.</TD>
\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
164 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
165 <CODE> boolean</CODE></FONT></TD>
\r
166 <TD><CODE><B><A HREF="K5User.html#allowsRenewableTickets()">allowsRenewableTickets</A></B>()</CODE>
\r
169 K5 Attribute: Tests if this principal is allowed to obtain renewable tickets.</TD>
\r
171 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
172 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
173 <CODE> boolean</CODE></FONT></TD>
\r
174 <TD><CODE><B><A HREF="K5User.html#allowsServiceTickets()">allowsServiceTickets</A></B>()</CODE>
\r
177 K5 Attribute: Tests if this principal is allowed to obtain service tickets.</TD>
\r
179 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
181 <CODE> boolean</CODE></FONT></TD>
\r
182 <TD><CODE><B><A HREF="K5User.html#canChangePassword()">canChangePassword</A></B>()</CODE>
\r
185 K5: Returns whether or not the user can change their password</TD>
\r
187 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
188 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
189 <CODE> 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> user)</CODE>
\r
193 Compares two K5User objects respective to their names and does not
\r
194 factor any other attribute.</TD>
\r
196 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
197 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
198 <CODE> 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> obj)</CODE>
\r
202 Comparable interface method.</TD>
\r
204 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
206 <CODE> 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> password)</CODE>
\r
210 Creates the Kerberos 5 entries for a new user in this cell.</TD>
\r
212 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
214 <CODE> void</CODE></FONT></TD>
\r
215 <TD><CODE><B><A HREF="K5User.html#delete()">delete</A></B>()</CODE>
\r
218 Deletes the K5 entries for a user in this cell.</TD>
\r
220 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
221 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
222 <CODE> 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> otherUser)</CODE>
\r
226 Tests whether two <code>K5User</code> objects are equal, based on their names.</TD>
\r
228 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
229 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
230 <CODE> <A HREF="Cell.html">Cell</A></CODE></FONT></TD>
\r
231 <TD><CODE><B><A HREF="K5User.html#getCell()">getCell</A></B>()</CODE>
\r
234 Returns the Cell/Realm this user belongs to.</TD>
\r
236 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
237 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
238 <CODE> int</CODE></FONT></TD>
\r
239 <TD><CODE><B><A HREF="K5User.html#getFailLoginCount()">getFailLoginCount</A></B>()</CODE>
\r
242 K5: Returns the number of failed login attempts this user is allowed before being locked out.</TD>
\r
244 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
245 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
246 <CODE> int</CODE></FONT></TD>
\r
247 <TD><CODE><B><A HREF="K5User.html#getKeyVersion()">getKeyVersion</A></B>()</CODE>
\r
250 K5: Returns the version of the user's key.</TD>
\r
252 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
253 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
254 <CODE> <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
258 K5: Returns the last date and time the user changed its password.</TD>
\r
260 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
261 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
262 <CODE> <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
266 K5: Returns the date and time the user was last modified.</TD>
\r
268 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
269 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
270 <CODE> <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
274 K5: Returns the name of this user that last modified this user.</TD>
\r
276 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
277 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
278 <CODE> int</CODE></FONT></TD>
\r
279 <TD><CODE><B><A HREF="K5User.html#getMasterKeyVersion()">getMasterKeyVersion</A></B>()</CODE>
\r
282 K5: Returns the master key version of this user.</TD>
\r
284 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
285 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
286 <CODE> int</CODE></FONT></TD>
\r
287 <TD><CODE><B><A HREF="K5User.html#getMaxRenewableLife()">getMaxRenewableLife</A></B>()</CODE>
\r
290 K5: Returns the the maximum renewable life of this user.</TD>
\r
292 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
293 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
294 <CODE> int</CODE></FONT></TD>
\r
295 <TD><CODE><B><A HREF="K5User.html#getMaxTicketLifetime()">getMaxTicketLifetime</A></B>()</CODE>
\r
298 K5: Returns the maximum lifetime of a ticket issued to this user (in seconds).</TD>
\r
300 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
301 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
302 <CODE> <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
306 Returns the name of this user.</TD>
\r
308 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
309 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
310 <CODE> <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
314 K5: Returns the date and time the password expires.</TD>
\r
316 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
317 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
318 <CODE> <A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A></CODE></FONT></TD>
\r
319 <TD><CODE><B><A HREF="K5User.html#getPasswordPolicy()">getPasswordPolicy</A></B>()</CODE>
\r
322 K5: Returns the password policy assigned to this user.</TD>
\r
324 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
325 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
326 <CODE> int</CODE></FONT></TD>
\r
327 <TD><CODE><B><A HREF="K5User.html#getSaltType()">getSaltType</A></B>()</CODE>
\r
330 K5: Returns the specified salt for generating the key.</TD>
\r
332 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
333 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
334 <CODE> <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
338 K5: Returns the date and time the user expires.</TD>
\r
340 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
341 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
342 <CODE> boolean</CODE></FONT></TD>
\r
343 <TD><CODE><B><A HREF="K5User.html#requiresHardwareAuth()">requiresHardwareAuth</A></B>()</CODE>
\r
346 K5 Attribute: Tests if this principal is required to preauthenticate using a hardware device before being allowed to kinit.</TD>
\r
348 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
349 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
350 <CODE> boolean</CODE></FONT></TD>
\r
351 <TD><CODE><B><A HREF="K5User.html#requiresPasswordChange()">requiresPasswordChange</A></B>()</CODE>
\r
354 K5 Attribute: Flag in attributes field to force a password change.</TD>
\r
356 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
357 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
358 <CODE> boolean</CODE></FONT></TD>
\r
359 <TD><CODE><B><A HREF="K5User.html#requiresPreAuth()">requiresPreAuth</A></B>()</CODE>
\r
362 K5 Attribute: Tests if this principal is required to preauthenticate before being allowed to kinit.</TD>
\r
364 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
365 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
366 <CODE> void</CODE></FONT></TD>
\r
367 <TD><CODE><B><A HREF="K5User.html#setChangePassword(boolean)">setChangePassword</A></B>(boolean setting)</CODE>
\r
370 K5: Sets whether or not the user can change their password</TD>
\r
372 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
373 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
374 <CODE> void</CODE></FONT></TD>
\r
375 <TD><CODE><B><A HREF="K5User.html#setDuplicateSessionKey(boolean)">setDuplicateSessionKey</A></B>(boolean flag)</CODE>
\r
378 K5: Sets attribute to allow/deny this principal from obtaining a session key for another user.</TD>
\r
380 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
381 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
382 <CODE> void</CODE></FONT></TD>
\r
383 <TD><CODE><B><A HREF="K5User.html#setFailLoginCount(int)">setFailLoginCount</A></B>(int logins)</CODE>
\r
386 K5: Sets the number of failed login attempts this user is allowed before being locked out.</TD>
\r
388 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
389 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
390 <CODE> void</CODE></FONT></TD>
\r
391 <TD><CODE><B><A HREF="K5User.html#setForwardableTickets(boolean)">setForwardableTickets</A></B>(boolean flag)</CODE>
\r
394 K5: Sets attribute to allow/deny this principal from obtaining forwardable tickets.</TD>
\r
396 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
397 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
398 <CODE> void</CODE></FONT></TD>
\r
399 <TD><CODE><B><A HREF="K5User.html#setGrantTickets(boolean)">setGrantTickets</A></B>(boolean setting)</CODE>
\r
402 K5: Sets whether or not TGS will issue tickets for this K5User</TD>
\r
404 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
405 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
406 <CODE> void</CODE></FONT></TD>
\r
407 <TD><CODE><B><A HREF="K5User.html#setHardwareAuth(boolean)">setHardwareAuth</A></B>(boolean flag)</CODE>
\r
410 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
413 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
414 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
415 <CODE> void</CODE></FONT></TD>
\r
416 <TD><CODE><B><A HREF="K5User.html#setMaxTicketLifetime(int)">setMaxTicketLifetime</A></B>(int seconds)</CODE>
\r
419 K5: Sets the maximum lifetime of a ticket issued to this user (in seconds).</TD>
\r
421 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
422 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
423 <CODE> 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> newPassword)</CODE>
\r
427 Sets the password of this user to something new.</TD>
\r
429 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
430 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
431 <CODE> void</CODE></FONT></TD>
\r
432 <TD><CODE><B><A HREF="K5User.html#setPasswordChange(boolean)">setPasswordChange</A></B>(boolean flag)</CODE>
\r
435 K5: Sets attribute to force a password change for this principal, if <CODE>flag</CODE> is true.</TD>
\r
437 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
438 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
439 <CODE> 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> expirationDate)</CODE>
\r
443 K5: Sets the date and time the password expires.</TD>
\r
445 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
446 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
447 <CODE> 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> policy)</CODE>
\r
451 K5: Sets the password policy for this user.</TD>
\r
453 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
454 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
455 <CODE> void</CODE></FONT></TD>
\r
456 <TD><CODE><B><A HREF="K5User.html#setPostDatedTickets(boolean)">setPostDatedTickets</A></B>(boolean flag)</CODE>
\r
459 K5: Sets attribute to allow/deny this principal from obtaining postdated tickets.</TD>
\r
461 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
462 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
463 <CODE> void</CODE></FONT></TD>
\r
464 <TD><CODE><B><A HREF="K5User.html#setPreAuth(boolean)">setPreAuth</A></B>(boolean flag)</CODE>
\r
467 K5: Sets attribute to require this principal to preauthenticate before
\r
468 being allowed to kinit, if <CODE>flag</CODE> is true.</TD>
\r
470 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
471 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
472 <CODE> void</CODE></FONT></TD>
\r
473 <TD><CODE><B><A HREF="K5User.html#setProxiableTickets(boolean)">setProxiableTickets</A></B>(boolean flag)</CODE>
\r
476 K5: Sets attribute to allow/deny this principal from obtaining proxiable tickets.</TD>
\r
478 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
479 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
480 <CODE> void</CODE></FONT></TD>
\r
481 <TD><CODE><B><A HREF="K5User.html#setRenewableTickets(boolean)">setRenewableTickets</A></B>(boolean flag)</CODE>
\r
484 K5: Sets attribute to allow/deny this principal from obtaining renewable tickets.</TD>
\r
486 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
487 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
488 <CODE> void</CODE></FONT></TD>
\r
489 <TD><CODE><B><A HREF="K5User.html#setSaltType(int)">setSaltType</A></B>(int type)</CODE>
\r
492 K5: Sets the specified salt for generating the key.</TD>
\r
494 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
495 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
496 <CODE> void</CODE></FONT></TD>
\r
497 <TD><CODE><B><A HREF="K5User.html#setServiceTickets(boolean)">setServiceTickets</A></B>(boolean flag)</CODE>
\r
500 K5: Sets attribute to allow/deny this principal from obtaining service tickets.</TD>
\r
502 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
503 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
504 <CODE> 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> expirationDate)</CODE>
\r
508 K5: Sets the date and time the user expires.</TD>
\r
510 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
511 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
512 <CODE> <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
516 Returns the name of this <CODE>User</CODE></TD>
\r
518 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
519 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
520 <CODE> boolean</CODE></FONT></TD>
\r
521 <TD><CODE><B><A HREF="K5User.html#willGrantTickets()">willGrantTickets</A></B>()</CODE>
\r
524 K5: Returns whether or not TGS will issue tickets for this user</TD>
\r
527 <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
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
539 <!-- ============ FIELD DETAIL =========== -->
\r
542 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\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
552 <A NAME="K5User(java.lang.String, org.openafs.jafsadm.Cell)"><!-- --></A><H3>
\r
555 public <B>K5User</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> name,
\r
556 <A HREF="Cell.html">Cell</A> cell)
\r
557 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
566 <A NAME="K5User(java.lang.String, org.openafs.jafsadm.Cell, org.openafs.jafsadm.K5PasswordPolicy)"><!-- --></A><H3>
\r
569 public <B>K5User</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> name,
\r
570 <A HREF="Cell.html">Cell</A> cell,
\r
571 <A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A> passwordPolicy)
\r
572 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
581 <!-- ============ METHOD DETAIL ========== -->
\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
591 <A NAME="create(java.lang.String)"><!-- --></A><H3>
\r
594 public void <B>create</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> password)
\r
595 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
605 <A NAME="delete()"><!-- --></A><H3>
\r
608 public void <B>delete</B>()
\r
609 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
620 <A NAME="getName()"><!-- --></A><H3>
\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
625 <DD>Returns the name of this user.<DD><DL>
\r
626 <DT><B>Returns:</B><DD>the name of this user</DL>
\r
631 <A NAME="getCell()"><!-- --></A><H3>
\r
634 public <A HREF="Cell.html">Cell</A> <B>getCell</B>()</PRE>
\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
642 <A NAME="willGrantTickets()"><!-- --></A><H3>
\r
643 willGrantTickets</H3>
\r
645 public boolean <B>willGrantTickets</B>()
\r
646 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
654 <A NAME="canChangePassword()"><!-- --></A><H3>
\r
655 canChangePassword</H3>
\r
657 public boolean <B>canChangePassword</B>()
\r
658 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
666 <A NAME="getUserExpirationDate()"><!-- --></A><H3>
\r
667 getUserExpirationDate</H3>
\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
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
680 <A NAME="getLastModDate()"><!-- --></A><H3>
\r
681 getLastModDate</H3>
\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
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
692 <A NAME="getLastModName()"><!-- --></A><H3>
\r
693 getLastModName</H3>
\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
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
704 <A NAME="getLastChangePasswordDate()"><!-- --></A><H3>
\r
705 getLastChangePasswordDate</H3>
\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
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
716 <A NAME="getMaxTicketLifetime()"><!-- --></A><H3>
\r
717 getMaxTicketLifetime</H3>
\r
719 public int <B>getMaxTicketLifetime</B>()
\r
720 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
728 <A NAME="getPasswordPolicy()"><!-- --></A><H3>
\r
729 getPasswordPolicy</H3>
\r
731 public <A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A> <B>getPasswordPolicy</B>()
\r
732 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
740 <A NAME="getPasswordExpirationDate()"><!-- --></A><H3>
\r
741 getPasswordExpirationDate</H3>
\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
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
754 <A NAME="getFailLoginCount()"><!-- --></A><H3>
\r
755 getFailLoginCount</H3>
\r
757 public int <B>getFailLoginCount</B>()
\r
758 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
767 <A NAME="getMasterKeyVersion()"><!-- --></A><H3>
\r
768 getMasterKeyVersion</H3>
\r
770 public int <B>getMasterKeyVersion</B>()
\r
771 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
779 <A NAME="getKeyVersion()"><!-- --></A><H3>
\r
782 public int <B>getKeyVersion</B>()
\r
783 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
791 <A NAME="getMaxRenewableLife()"><!-- --></A><H3>
\r
792 getMaxRenewableLife</H3>
\r
794 public int <B>getMaxRenewableLife</B>()
\r
795 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
803 <A NAME="getSaltType()"><!-- --></A><H3>
\r
806 public int <B>getSaltType</B>()
\r
807 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
815 <A NAME="allowsPostDatedTickets()"><!-- --></A><H3>
\r
816 allowsPostDatedTickets</H3>
\r
818 public boolean <B>allowsPostDatedTickets</B>()
\r
819 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
827 <A NAME="allowsForwardableTickets()"><!-- --></A><H3>
\r
828 allowsForwardableTickets</H3>
\r
830 public boolean <B>allowsForwardableTickets</B>()
\r
831 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
839 <A NAME="allowsRenewableTickets()"><!-- --></A><H3>
\r
840 allowsRenewableTickets</H3>
\r
842 public boolean <B>allowsRenewableTickets</B>()
\r
843 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
851 <A NAME="allowsProxiableTickets()"><!-- --></A><H3>
\r
852 allowsProxiableTickets</H3>
\r
854 public boolean <B>allowsProxiableTickets</B>()
\r
855 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
863 <A NAME="allowsServiceTickets()"><!-- --></A><H3>
\r
864 allowsServiceTickets</H3>
\r
866 public boolean <B>allowsServiceTickets</B>()
\r
867 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
875 <A NAME="allowsDuplicateSessionKey()"><!-- --></A><H3>
\r
876 allowsDuplicateSessionKey</H3>
\r
878 public boolean <B>allowsDuplicateSessionKey</B>()
\r
879 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
889 <A NAME="requiresPreAuth()"><!-- --></A><H3>
\r
890 requiresPreAuth</H3>
\r
892 public boolean <B>requiresPreAuth</B>()
\r
893 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
901 <A NAME="requiresHardwareAuth()"><!-- --></A><H3>
\r
902 requiresHardwareAuth</H3>
\r
904 public boolean <B>requiresHardwareAuth</B>()
\r
905 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
913 <A NAME="requiresPasswordChange()"><!-- --></A><H3>
\r
914 requiresPasswordChange</H3>
\r
916 public boolean <B>requiresPasswordChange</B>()
\r
917 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
925 <A NAME="setGrantTickets(boolean)"><!-- --></A><H3>
\r
926 setGrantTickets</H3>
\r
928 public void <B>setGrantTickets</B>(boolean setting)</PRE>
\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
936 <A NAME="setFailLoginCount(int)"><!-- --></A><H3>
\r
937 setFailLoginCount</H3>
\r
939 public void <B>setFailLoginCount</B>(int logins)</PRE>
\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
948 <A NAME="setChangePassword(boolean)"><!-- --></A><H3>
\r
949 setChangePassword</H3>
\r
951 public void <B>setChangePassword</B>(boolean setting)</PRE>
\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
959 <A NAME="setUserExpiration(java.util.GregorianCalendar)"><!-- --></A><H3>
\r
960 setUserExpiration</H3>
\r
962 public void <B>setUserExpiration</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> expirationDate)</PRE>
\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
971 <A NAME="setPasswordExpiration(java.util.GregorianCalendar)"><!-- --></A><H3>
\r
972 setPasswordExpiration</H3>
\r
974 public void <B>setPasswordExpiration</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/util/GregorianCalendar.html">GregorianCalendar</A> expirationDate)</PRE>
\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
983 <A NAME="setMaxTicketLifetime(int)"><!-- --></A><H3>
\r
984 setMaxTicketLifetime</H3>
\r
986 public void <B>setMaxTicketLifetime</B>(int seconds)</PRE>
\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
994 <A NAME="setPasswordPolicy(org.openafs.jafsadm.K5PasswordPolicy)"><!-- --></A><H3>
\r
995 setPasswordPolicy</H3>
\r
997 public void <B>setPasswordPolicy</B>(<A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A> policy)</PRE>
\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
1005 <A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
\r
1008 public void <B>setPassword</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> newPassword)
\r
1009 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
1018 <A NAME="setSaltType(int)"><!-- --></A><H3>
\r
1021 public void <B>setSaltType</B>(int type)
\r
1022 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
1030 <A NAME="setPostDatedTickets(boolean)"><!-- --></A><H3>
\r
1031 setPostDatedTickets</H3>
\r
1033 public void <B>setPostDatedTickets</B>(boolean flag)
\r
1034 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\r
1036 <DD>K5: Sets attribute to allow/deny this principal from obtaining postdated tickets.
\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
1045 <A NAME="setForwardableTickets(boolean)"><!-- --></A><H3>
\r
1046 setForwardableTickets</H3>
\r
1048 public void <B>setForwardableTickets</B>(boolean flag)
\r
1049 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\r
1051 <DD>K5: Sets attribute to allow/deny this principal from obtaining forwardable tickets.
\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
1060 <A NAME="setRenewableTickets(boolean)"><!-- --></A><H3>
\r
1061 setRenewableTickets</H3>
\r
1063 public void <B>setRenewableTickets</B>(boolean flag)
\r
1064 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\r
1066 <DD>K5: Sets attribute to allow/deny this principal from obtaining renewable tickets.
\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
1075 <A NAME="setProxiableTickets(boolean)"><!-- --></A><H3>
\r
1076 setProxiableTickets</H3>
\r
1078 public void <B>setProxiableTickets</B>(boolean flag)
\r
1079 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\r
1081 <DD>K5: Sets attribute to allow/deny this principal from obtaining proxiable tickets.
\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
1090 <A NAME="setServiceTickets(boolean)"><!-- --></A><H3>
\r
1091 setServiceTickets</H3>
\r
1093 public void <B>setServiceTickets</B>(boolean flag)
\r
1094 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\r
1096 <DD>K5: Sets attribute to allow/deny this principal from obtaining service tickets.
\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
1105 <A NAME="setDuplicateSessionKey(boolean)"><!-- --></A><H3>
\r
1106 setDuplicateSessionKey</H3>
\r
1108 public void <B>setDuplicateSessionKey</B>(boolean flag)
\r
1109 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\r
1111 <DD>K5: Sets attribute to allow/deny this principal from obtaining a session key for another user.
\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
1120 <A NAME="setPreAuth(boolean)"><!-- --></A><H3>
\r
1123 public void <B>setPreAuth</B>(boolean flag)
\r
1124 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
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
1136 <A NAME="setHardwareAuth(boolean)"><!-- --></A><H3>
\r
1137 setHardwareAuth</H3>
\r
1139 public void <B>setHardwareAuth</B>(boolean flag)
\r
1140 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\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
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
1152 <A NAME="setPasswordChange(boolean)"><!-- --></A><H3>
\r
1153 setPasswordChange</H3>
\r
1155 public void <B>setPasswordChange</B>(boolean flag)
\r
1156 throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>
\r
1158 <DD>K5: Sets attribute to force a password change for this principal, if <CODE>flag</CODE> is true.
\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
1167 <A NAME="compareTo(org.openafs.jafsadm.K5User)"><!-- --></A><H3>
\r
1170 public int <B>compareTo</B>(<A HREF="K5User.html">K5User</A> user)</PRE>
\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
1184 <A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
\r
1187 public int <B>compareTo</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/Object.html">Object</A> obj)</PRE>
\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
1195 <A NAME="equals(org.openafs.jafsadm.K5User)"><!-- --></A><H3>
\r
1198 public boolean <B>equals</B>(<A HREF="K5User.html">K5User</A> otherUser)</PRE>
\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
1206 <A NAME="toString()"><!-- --></A><H3>
\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
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
1215 <DT><B>Returns:</B><DD>the name of this <CODE>User</CODE></DL>
\r
1218 <!-- ========= END OF CLASS DATA ========= -->
\r
1221 <!-- ========== START OF NAVBAR ========== -->
\r
1222 <A NAME="navbar_bottom"><!-- --></A>
\r
1223 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
\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> </TD>
\r
1230 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
1231 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/K5User.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
1232 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
1233 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
1234 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
1235 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
1239 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
1240 Java AFS Admin (jafsadm) API for OpenAFS</EM>
\r
1245 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
1246 <A HREF="K5PasswordPolicy.html"><B>PREV CLASS</B></A>
\r
1247 <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>
\r
1250 <A HREF="K5User.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
\r
1253 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
1254 SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
1255 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
1256 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
1259 <!-- =========== END OF NAVBAR =========== -->
\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