Remove broken link
[openafs-wiki.git] / archive / JavaAdminAPI / K5PasswordPolicy.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  K5PasswordPolicy\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/K5PasswordPolicy.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="Group.html"><B>PREV CLASS</B></A>&nbsp;\r
39 &nbsp;<A HREF="K5User.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="K5PasswordPolicy.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  K5PasswordPolicy</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.K5PasswordPolicy</B>\r
64 </PRE>\r
65 <HR>\r
66 <DL>\r
67 <DT>public class <B>K5PasswordPolicy</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 a Kerberos 5 Password Policy.\r
71  <BR><BR>\r
72 \r
73  <!--Information on how member values are set-->\r
74 <P>\r
75 <DL>\r
76 <DT><B>Version: </B><DD>1.0, 4/02/02</DD>\r
77 </DL>\r
78 <HR>\r
79 \r
80 <P>\r
81 <!-- ======== INNER CLASS SUMMARY ======== -->\r
82 \r
83 \r
84 <!-- =========== FIELD SUMMARY =========== -->\r
85 \r
86 \r
87 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
88 \r
89 <A NAME="constructor_summary"><!-- --></A>\r
90 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
91 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
92 <TD COLSPAN=2><FONT SIZE="+2">\r
93 <B>Constructor Summary</B></FONT></TD>\r
94 </TR>\r
95 <TR BGCOLOR="white" CLASS="TableRowColor">\r
96 <TD><CODE><B><A HREF="K5PasswordPolicy.html#K5PasswordPolicy(java.lang.String)">K5PasswordPolicy</A></B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>\r
97 \r
98 <BR>\r
99 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a new <CODE>K5PasswordPolicy</CODE> object instance given the name of \r
100  Kerberos 5 Password Policy it will represent.</TD>\r
101 </TR>\r
102 </TABLE>\r
103 &nbsp;\r
104 <!-- ========== METHOD SUMMARY =========== -->\r
105 \r
106 <A NAME="method_summary"><!-- --></A>\r
107 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
108 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
109 <TD COLSPAN=2><FONT SIZE="+2">\r
110 <B>Method Summary</B></FONT></TD>\r
111 </TR>\r
112 <TR BGCOLOR="white" CLASS="TableRowColor">\r
113 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
114 <CODE>&nbsp;int</CODE></FONT></TD>\r
115 <TD><CODE><B><A HREF="K5PasswordPolicy.html#compareTo(org.openafs.jafsadm.K5PasswordPolicy)">compareTo</A></B>(<A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A>&nbsp;user)</CODE>\r
116 \r
117 <BR>\r
118 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares two K5PasswordPolicy objects respective to their names and does not\r
119  factor any other attribute.</TD>\r
120 </TR>\r
121 <TR BGCOLOR="white" CLASS="TableRowColor">\r
122 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
123 <CODE>&nbsp;void</CODE></FONT></TD>\r
124 <TD><CODE><B><A HREF="K5PasswordPolicy.html#create()">create</A></B>()</CODE>\r
125 \r
126 <BR>\r
127 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a Kerberos 5 Password Policy that corresponds to this abstract representation.</TD>\r
128 </TR>\r
129 <TR BGCOLOR="white" CLASS="TableRowColor">\r
130 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
131 <CODE>&nbsp;void</CODE></FONT></TD>\r
132 <TD><CODE><B><A HREF="K5PasswordPolicy.html#delete()">delete</A></B>()</CODE>\r
133 \r
134 <BR>\r
135 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the K5 Password Policy.</TD>\r
136 </TR>\r
137 <TR BGCOLOR="white" CLASS="TableRowColor">\r
138 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
139 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
140 <TD><CODE><B><A HREF="K5PasswordPolicy.html#equals(org.openafs.jafsadm.K5PasswordPolicy)">equals</A></B>(<A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A>&nbsp;policy)</CODE>\r
141 \r
142 <BR>\r
143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tests whether two <code>K5PasswordPolicy</code> objects are equal, \r
144  based on their names.</TD>\r
145 </TR>\r
146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
148 <CODE>&nbsp;int</CODE></FONT></TD>\r
149 <TD><CODE><B><A HREF="K5PasswordPolicy.html#getMaxPasswordLifetime()">getMaxPasswordLifetime</A></B>()</CODE>\r
150 \r
151 <BR>\r
152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the maximum lifetime of a password.</TD>\r
153 </TR>\r
154 <TR BGCOLOR="white" CLASS="TableRowColor">\r
155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
156 <CODE>&nbsp;short</CODE></FONT></TD>\r
157 <TD><CODE><B><A HREF="K5PasswordPolicy.html#getMinCharacterClasses()">getMinCharacterClasses</A></B>()</CODE>\r
158 \r
159 <BR>\r
160 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the minimum number of character classes required.</TD>\r
161 </TR>\r
162 <TR BGCOLOR="white" CLASS="TableRowColor">\r
163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
164 <CODE>&nbsp;short</CODE></FONT></TD>\r
165 <TD><CODE><B><A HREF="K5PasswordPolicy.html#getMinPasswordLength()">getMinPasswordLength</A></B>()</CODE>\r
166 \r
167 <BR>\r
168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the minimum length a password is allowed to have.</TD>\r
169 </TR>\r
170 <TR BGCOLOR="white" CLASS="TableRowColor">\r
171 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
172 <CODE>&nbsp;int</CODE></FONT></TD>\r
173 <TD><CODE><B><A HREF="K5PasswordPolicy.html#getMinPasswordLifetime()">getMinPasswordLifetime</A></B>()</CODE>\r
174 \r
175 <BR>\r
176 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the minimum lifetime of a password (in seconds).</TD>\r
177 </TR>\r
178 <TR BGCOLOR="white" CLASS="TableRowColor">\r
179 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
180 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>\r
181 <TD><CODE><B><A HREF="K5PasswordPolicy.html#getName()">getName</A></B>()</CODE>\r
182 \r
183 <BR>\r
184 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this password policy.</TD>\r
185 </TR>\r
186 <TR BGCOLOR="white" CLASS="TableRowColor">\r
187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
188 <CODE>&nbsp;int</CODE></FONT></TD>\r
189 <TD><CODE><B><A HREF="K5PasswordPolicy.html#getPastKeyCount()">getPastKeyCount</A></B>()</CODE>\r
190 \r
191 <BR>\r
192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of past keys kept.</TD>\r
193 </TR>\r
194 <TR BGCOLOR="white" CLASS="TableRowColor">\r
195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
196 <CODE>&nbsp;int</CODE></FONT></TD>\r
197 <TD><CODE><B><A HREF="K5PasswordPolicy.html#getReferenceCount()">getReferenceCount</A></B>()</CODE>\r
198 \r
199 <BR>\r
200 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of principals using this policy.</TD>\r
201 </TR>\r
202 <TR BGCOLOR="white" CLASS="TableRowColor">\r
203 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
204 <CODE>&nbsp;void</CODE></FONT></TD>\r
205 <TD><CODE><B><A HREF="K5PasswordPolicy.html#setMaxPasswordLifetime(int)">setMaxPasswordLifetime</A></B>(int&nbsp;seconds)</CODE>\r
206 \r
207 <BR>\r
208 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the maximum lifetime of a password (in seconds).</TD>\r
209 </TR>\r
210 <TR BGCOLOR="white" CLASS="TableRowColor">\r
211 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
212 <CODE>&nbsp;void</CODE></FONT></TD>\r
213 <TD><CODE><B><A HREF="K5PasswordPolicy.html#setMinCharacterClasses(int)">setMinCharacterClasses</A></B>(int&nbsp;number)</CODE>\r
214 \r
215 <BR>\r
216 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Requires at least <CODE>number</CODE> of character classes in a password.</TD>\r
217 </TR>\r
218 <TR BGCOLOR="white" CLASS="TableRowColor">\r
219 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
220 <CODE>&nbsp;void</CODE></FONT></TD>\r
221 <TD><CODE><B><A HREF="K5PasswordPolicy.html#setMinPasswordLength(int)">setMinPasswordLength</A></B>(int&nbsp;characters)</CODE>\r
222 \r
223 <BR>\r
224 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the minimum password length (character length).</TD>\r
225 </TR>\r
226 <TR BGCOLOR="white" CLASS="TableRowColor">\r
227 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
228 <CODE>&nbsp;void</CODE></FONT></TD>\r
229 <TD><CODE><B><A HREF="K5PasswordPolicy.html#setMinPasswordLifetime(int)">setMinPasswordLifetime</A></B>(int&nbsp;seconds)</CODE>\r
230 \r
231 <BR>\r
232 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the minimum lifetime of a password (in seconds).</TD>\r
233 </TR>\r
234 <TR BGCOLOR="white" CLASS="TableRowColor">\r
235 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
236 <CODE>&nbsp;void</CODE></FONT></TD>\r
237 <TD><CODE><B><A HREF="K5PasswordPolicy.html#setPastKeyCount(int)">setPastKeyCount</A></B>(int&nbsp;number)</CODE>\r
238 \r
239 <BR>\r
240 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the number of past keys kept for a principal to <CODE>number</CODE>.</TD>\r
241 </TR>\r
242 <TR BGCOLOR="white" CLASS="TableRowColor">\r
243 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
244 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>\r
245 <TD><CODE><B><A HREF="K5PasswordPolicy.html#toString()">toString</A></B>()</CODE>\r
246 \r
247 <BR>\r
248 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this <CODE>K5PasswordPolicy</CODE></TD>\r
249 </TR>\r
250 </TABLE>\r
251 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
252 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
253 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
254 <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
255 </TR>\r
256 <TR BGCOLOR="white" CLASS="TableRowColor">\r
257 <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
258 </TR>\r
259 </TABLE>\r
260 &nbsp;\r
261 <P>\r
262 \r
263 <!-- ============ FIELD DETAIL =========== -->\r
264 \r
265 \r
266 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
267 \r
268 <A NAME="constructor_detail"><!-- --></A>\r
269 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
270 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
271 <TD COLSPAN=1><FONT SIZE="+2">\r
272 <B>Constructor Detail</B></FONT></TD>\r
273 </TR>\r
274 </TABLE>\r
275 \r
276 <A NAME="K5PasswordPolicy(java.lang.String)"><!-- --></A><H3>\r
277 K5PasswordPolicy</H3>\r
278 <PRE>\r
279 public <B>K5PasswordPolicy</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)\r
280                  throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
281 <DL>\r
282 <DD>Constructs a new <CODE>K5PasswordPolicy</CODE> object instance given the name of \r
283  Kerberos 5 Password Policy it will represent.<DD><DL>\r
284 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the user to represent<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
285 </DD>\r
286 </DL>\r
287 \r
288 <!-- ============ METHOD DETAIL ========== -->\r
289 \r
290 <A NAME="method_detail"><!-- --></A>\r
291 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">\r
292 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
293 <TD COLSPAN=1><FONT SIZE="+2">\r
294 <B>Method Detail</B></FONT></TD>\r
295 </TR>\r
296 </TABLE>\r
297 \r
298 <A NAME="create()"><!-- --></A><H3>\r
299 create</H3>\r
300 <PRE>\r
301 public void <B>create</B>()\r
302             throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
303 <DL>\r
304 <DD>Creates a Kerberos 5 Password Policy that corresponds to this abstract representation.<DD><DL>\r
305 <DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
306 </DD>\r
307 </DL>\r
308 <HR>\r
309 \r
310 <A NAME="delete()"><!-- --></A><H3>\r
311 delete</H3>\r
312 <PRE>\r
313 public void <B>delete</B>()\r
314             throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
315 <DL>\r
316 <DD>Deletes the K5 Password Policy. \r
317 \r
318  <P>Note that you must cancel the policy from all principals before deleting it. \r
319  The delete_policy command will fail if it is in use by any principals.<DD><DL>\r
320 <DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
321 </DD>\r
322 </DL>\r
323 <HR>\r
324 \r
325 <A NAME="getName()"><!-- --></A><H3>\r
326 getName</H3>\r
327 <PRE>\r
328 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>getName</B>()</PRE>\r
329 <DL>\r
330 <DD>Returns the name of this password policy.<DD><DL>\r
331 <DT><B>Returns:</B><DD>the name of this password policy</DL>\r
332 </DD>\r
333 </DL>\r
334 <HR>\r
335 \r
336 <A NAME="getMinPasswordLifetime()"><!-- --></A><H3>\r
337 getMinPasswordLifetime</H3>\r
338 <PRE>\r
339 public int <B>getMinPasswordLifetime</B>()\r
340                            throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
341 <DL>\r
342 <DD>Returns the minimum lifetime of a password (in seconds).<DD><DL>\r
343 <DT><B>Returns:</B><DD>the minimum lifetime of a password (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
344 </DD>\r
345 </DL>\r
346 <HR>\r
347 \r
348 <A NAME="getMaxPasswordLifetime()"><!-- --></A><H3>\r
349 getMaxPasswordLifetime</H3>\r
350 <PRE>\r
351 public int <B>getMaxPasswordLifetime</B>()\r
352                            throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
353 <DL>\r
354 <DD>Returns the maximum lifetime of a password.<DD><DL>\r
355 <DT><B>Returns:</B><DD>the maximum lifetime of a password (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
356 </DD>\r
357 </DL>\r
358 <HR>\r
359 \r
360 <A NAME="getMinPasswordLength()"><!-- --></A><H3>\r
361 getMinPasswordLength</H3>\r
362 <PRE>\r
363 public short <B>getMinPasswordLength</B>()\r
364                            throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
365 <DL>\r
366 <DD>Returns the minimum length a password is allowed to have.<DD><DL>\r
367 <DT><B>Returns:</B><DD>the minimum length a password is allowed to have.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
368 </DD>\r
369 </DL>\r
370 <HR>\r
371 \r
372 <A NAME="getMinCharacterClasses()"><!-- --></A><H3>\r
373 getMinCharacterClasses</H3>\r
374 <PRE>\r
375 public short <B>getMinCharacterClasses</B>()\r
376                              throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
377 <DL>\r
378 <DD>Returns the minimum number of character classes required.<DD><DL>\r
379 <DT><B>Returns:</B><DD>the minimum number of character classes required.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
380 </DD>\r
381 </DL>\r
382 <HR>\r
383 \r
384 <A NAME="getPastKeyCount()"><!-- --></A><H3>\r
385 getPastKeyCount</H3>\r
386 <PRE>\r
387 public int <B>getPastKeyCount</B>()\r
388                     throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
389 <DL>\r
390 <DD>Returns the number of past keys kept.<DD><DL>\r
391 <DT><B>Returns:</B><DD>the number of past keys kept.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
392 </DD>\r
393 </DL>\r
394 <HR>\r
395 \r
396 <A NAME="getReferenceCount()"><!-- --></A><H3>\r
397 getReferenceCount</H3>\r
398 <PRE>\r
399 public int <B>getReferenceCount</B>()\r
400                       throws <A HREF="AFSAdminException.html">AFSAdminException</A></PRE>\r
401 <DL>\r
402 <DD>Returns the number of principals using this policy.<DD><DL>\r
403 <DT><B>Returns:</B><DD>the number of principals using this policy.<DT><B>Throws:</B><DD><CODE><A HREF="AFSAdminException.html">AFSAdminException</A></CODE> - If an error occurs in the native code</DL>\r
404 </DD>\r
405 </DL>\r
406 <HR>\r
407 \r
408 <A NAME="setMaxPasswordLifetime(int)"><!-- --></A><H3>\r
409 setMaxPasswordLifetime</H3>\r
410 <PRE>\r
411 public void <B>setMaxPasswordLifetime</B>(int&nbsp;seconds)</PRE>\r
412 <DL>\r
413 <DD>Sets the maximum lifetime of a password (in seconds).<DD><DL>\r
414 <DT><B>Parameters:</B><DD><CODE>seconds</CODE> - the maximum lifetime of a password (in seconds).</DL>\r
415 </DD>\r
416 </DL>\r
417 <HR>\r
418 \r
419 <A NAME="setMinPasswordLifetime(int)"><!-- --></A><H3>\r
420 setMinPasswordLifetime</H3>\r
421 <PRE>\r
422 public void <B>setMinPasswordLifetime</B>(int&nbsp;seconds)</PRE>\r
423 <DL>\r
424 <DD>Sets the minimum lifetime of a password (in seconds).<DD><DL>\r
425 <DT><B>Parameters:</B><DD><CODE>seconds</CODE> - the minimum lifetime of a password (in seconds).</DL>\r
426 </DD>\r
427 </DL>\r
428 <HR>\r
429 \r
430 <A NAME="setMinPasswordLength(int)"><!-- --></A><H3>\r
431 setMinPasswordLength</H3>\r
432 <PRE>\r
433 public void <B>setMinPasswordLength</B>(int&nbsp;characters)</PRE>\r
434 <DL>\r
435 <DD>Sets the minimum password length (character length).<DD><DL>\r
436 <DT><B>Parameters:</B><DD><CODE>characters</CODE> - the minimum password length (character length).</DL>\r
437 </DD>\r
438 </DL>\r
439 <HR>\r
440 \r
441 <A NAME="setMinCharacterClasses(int)"><!-- --></A><H3>\r
442 setMinCharacterClasses</H3>\r
443 <PRE>\r
444 public void <B>setMinCharacterClasses</B>(int&nbsp;number)</PRE>\r
445 <DL>\r
446 <DD>Requires at least <CODE>number</CODE> of character classes in a password.<DD><DL>\r
447 <DT><B>Parameters:</B><DD><CODE>seconds</CODE> - of character classes in a password.</DL>\r
448 </DD>\r
449 </DL>\r
450 <HR>\r
451 \r
452 <A NAME="setPastKeyCount(int)"><!-- --></A><H3>\r
453 setPastKeyCount</H3>\r
454 <PRE>\r
455 public void <B>setPastKeyCount</B>(int&nbsp;number)</PRE>\r
456 <DL>\r
457 <DD>Sets the number of past keys kept for a principal to <CODE>number</CODE>.<DD><DL>\r
458 <DT><B>Parameters:</B><DD><CODE>number</CODE> - of past keys kept for a principal</DL>\r
459 </DD>\r
460 </DL>\r
461 <HR>\r
462 \r
463 <A NAME="compareTo(org.openafs.jafsadm.K5PasswordPolicy)"><!-- --></A><H3>\r
464 compareTo</H3>\r
465 <PRE>\r
466 public int <B>compareTo</B>(<A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A>&nbsp;user)</PRE>\r
467 <DL>\r
468 <DD>Compares two K5PasswordPolicy objects respective to their names and does not\r
469  factor any other attribute.    Alphabetic case is significant in \r
470  comparing names.<DD><DL>\r
471 <DT><B>Parameters:</B><DD><CODE>policy</CODE> - The K5PasswordPolicy object to be compared to this K5PasswordPolicy instance<DT><B>Returns:</B><DD>Zero if the argument is equal to this policy's name, a\r
472                 value less than zero if this policy's name is\r
473                 lexicographically less than the argument, or a value greater\r
474                 than zero if this policy's name is lexicographically\r
475                 greater than the argument</DL>\r
476 </DD>\r
477 </DL>\r
478 <HR>\r
479 \r
480 <A NAME="equals(org.openafs.jafsadm.K5PasswordPolicy)"><!-- --></A><H3>\r
481 equals</H3>\r
482 <PRE>\r
483 public boolean <B>equals</B>(<A HREF="K5PasswordPolicy.html">K5PasswordPolicy</A>&nbsp;policy)</PRE>\r
484 <DL>\r
485 <DD>Tests whether two <code>K5PasswordPolicy</code> objects are equal, \r
486  based on their names.<DD><DL>\r
487 <DT><B>Parameters:</B><DD><CODE>policy</CODE> - the user to test<DT><B>Returns:</B><DD>whether the specifed user is the same as this user</DL>\r
488 </DD>\r
489 </DL>\r
490 <HR>\r
491 \r
492 <A NAME="toString()"><!-- --></A><H3>\r
493 toString</H3>\r
494 <PRE>\r
495 public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html">String</A> <B>toString</B>()</PRE>\r
496 <DL>\r
497 <DD>Returns the name of this <CODE>K5PasswordPolicy</CODE><DD><DL>\r
498 <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
499 </DD>\r
500 <DD><DL>\r
501 <DT><B>Returns:</B><DD>the name of this <CODE>K5PasswordPolicy</CODE></DL>\r
502 </DD>\r
503 </DL>\r
504 <!-- ========= END OF CLASS DATA ========= -->\r
505 <HR>\r
506 \r
507 <!-- ========== START OF NAVBAR ========== -->\r
508 <A NAME="navbar_bottom"><!-- --></A>\r
509 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">\r
510 <TR>\r
511 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
512 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
513 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">\r
514   <TR ALIGN="center" VALIGN="top">\r
515   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
516   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
517   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/K5PasswordPolicy.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
518   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
519   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
520   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
521   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
522   </TR>\r
523 </TABLE>\r
524 </TD>\r
525 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
526 Java AFS Admin (jafsadm) API for OpenAFS</EM>\r
527 </TD>\r
528 </TR>\r
529 \r
530 <TR>\r
531 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
532 &nbsp;<A HREF="Group.html"><B>PREV CLASS</B></A>&nbsp;\r
533 &nbsp;<A HREF="K5User.html"><B>NEXT CLASS</B></A></FONT></TD>\r
534 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
535   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;\r
536 &nbsp;<A HREF="K5PasswordPolicy.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>\r
537 </TR>\r
538 <TR>\r
539 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
540   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
541 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
542 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
543 </TR>\r
544 </TABLE>\r
545 <!-- =========== END OF NAVBAR =========== -->\r
546 \r
547 <HR>\r
548 <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
549 </BODY>\r
550 </HTML>\r
551 \r
552 \r