KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > config > AuthRealmConfig


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24
25 package com.sun.appserv.management.config;
26
27 import com.sun.appserv.management.base.XTypes;
28
29
30
31
32 /**
33      Configuration for the <auth-realm> element.
34 */
35
36 public interface AuthRealmConfig extends PropertiesAccess, NamedConfigElement
37 {
38 /** The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}. */
39     public static final String JavaDoc J2EE_TYPE = XTypes.AUTH_REALM_CONFIG;
40     
41     
42     /**
43         Classname of the default implementing class.
44      */
45     public static final String JavaDoc DEFAULT_REALM_CLASSNAME =
46         "com.sun.enterprise.security.auth.realm.file.FileRealm";
47         
48     public static final String JavaDoc KEY_FILE_PROPERTY_KEY = PropertiesAccess.PROPERTY_PREFIX + "file";
49     
50     public static final String JavaDoc JAAS_CONTEXT_PROPERTY_KEY = PropertiesAccess.PROPERTY_PREFIX + "jaas-context";
51     
52     /**
53         When using {@link #DEFAULT_REALM_CLASSNAME} implementation, append
54         a file name to this prefix and specify it via {@link #KEY_FILE_PROPERTY_KEY}.
55      */
56     public static final String JavaDoc KEY_FILE_PREFIX = "${com.sun.aas.instanceRoot}/config/";
57     
58     
59     public String JavaDoc getClassname();
60     public void setClassname( String JavaDoc value );
61
62     /**
63         <b>Supported only for the default implementation ({@link #DEFAULT_REALM_CLASSNAME})</b>.
64      */
65     public void addUser( String JavaDoc user, String JavaDoc password, String JavaDoc[] groupList );
66     
67     /**
68         <b>Supported only for the default implementation ({@link #DEFAULT_REALM_CLASSNAME})</b>.
69      */
70     public String JavaDoc[] getGroupNames();
71     
72     /**
73         <b>Supported only for the default implementation ({@link #DEFAULT_REALM_CLASSNAME})</b>.
74      */
75     public String JavaDoc[] getUserGroupNames( String JavaDoc user );
76     
77     /**
78         <b>Supported only for the default implementation ({@link #DEFAULT_REALM_CLASSNAME})</b>.
79      */
80     public String JavaDoc[] getUserNames();
81     
82     /**
83         <b>Supported only for the default implementation ({@link #DEFAULT_REALM_CLASSNAME})</b>.
84      */
85     public void removeUser( String JavaDoc user );
86     
87     /**
88         <b>Supported only for the default implementation ({@link #DEFAULT_REALM_CLASSNAME})</b>.
89      */
90     public void updateUser( String JavaDoc user, String JavaDoc password, String JavaDoc[] groupList );
91
92
93
94
95
96 }
97
Popular Tags