KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > catalina > startup > UserDatabase


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */

17
18
19 package org.apache.catalina.startup;
20
21
22 import java.util.Enumeration JavaDoc;
23
24
25 /**
26  * Abstraction of the set of users defined by the operating system on the
27  * current server platform.
28  *
29  * @author Craig R. McClanahan
30  * @version $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
31  */

32
33 public interface UserDatabase {
34
35
36     // ----------------------------------------------------------- Properties
37

38
39     /**
40      * Return the UserConfig listener with which we are associated.
41      */

42     public UserConfig getUserConfig();
43
44
45     /**
46      * Set the UserConfig listener with which we are associated.
47      *
48      * @param userConfig The new UserConfig listener
49      */

50     public void setUserConfig(UserConfig userConfig);
51
52
53     // ------------------------------------------------------- Public Methods
54

55
56     /**
57      * Return an absolute pathname to the home directory for the specified user.
58      *
59      * @param user User for which a home directory should be retrieved
60      */

61     public String JavaDoc getHome(String JavaDoc user);
62
63
64     /**
65      * Return an enumeration of the usernames defined on this server.
66      */

67     public Enumeration JavaDoc getUsers();
68
69
70 }
71
Popular Tags