JResourceLDAPMBean


1   /**
2    * JOnAS: Java(TM) Open Application Server
3    * Copyright (C) 1999-2004 Bull S.A.
4    * Contact: jonas-team@objectweb.org
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public
8    * License as published by the Free Software Foundation; either
9    * version 2.1 of the License, or 1any later version.
10   *
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   *
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
19   * USA
20   *
21   * Initial developer: Florent Benoit
22   * --------------------------------------------------------------------------
23   * $Id: JResourceLDAPMBean.java,v 1.3 2004/05/25 15:13:28 benoitf Exp $
24   * --------------------------------------------------------------------------
25   */
26  
27  package org.objectweb.jonas.security.realm.factory;
28  
29  /**
30   * Define the methods for the MBean
31   * @author Florent Benoit
32   */
33  public interface JResourceLDAPMBean extends JResourceMBean {
34  
35      /**
36       * Clear the cache
37       */
38      void clearCache();
39  
40      // Getters
41  
42      /**
43       * Return the initial context factory of this LDAP realm
44       * @return the initial context factory
45       */
46      String   getInitialContextFactory();
47  
48      /**
49       * Get the Url of the ldap server of this LDAP realm
50       * @return Url of the ldap server
51       */
52      String   getProviderUrl();
53  
54      /**
55       * Get the authentication used during the authentication to the LDAP server
56       * of this LDAP realm
57       * @return authentication used during the authentication to the LDAP server
58       */
59      String   getSecurityAuthentication();
60  
61      /**
62       * Get the DN of the Principal(username) of this LDAP realm
63       * @return DN of the Principal(username)
64       */
65      String   getSecurityPrincipal();
66  
67      /**
68       * Get the Credential(password) of the principal of this LDAP realm
69       * @return Credential(password) of the principal
70       */
71      String   getSecurityCredentials();
72  
73      /**
74       * Get the security protocol to use of this LDAP realm
75       * @return security protocol to use
76       */
77      String   getSecurityProtocol();
78  
79      /**
80       * Get the preferred language to use with the service of this LDAP realm
81       * @return language preferred language to use with the service
82       */
83      String   getLanguage();
84  
85      /**
86       * Get how referrals encountered by the service provider are to be processed
87       * @return how referrals encountered by the service provider are to be
88       *         processed
89       */
90      String   getReferral();
91  
92      /**
93       * Get the the list of state factories of this LDAP realm
94       * @return list of state factories
95       */
96      String   getStateFactories();
97  
98      /**
99       * Get the mode for validate the authentication of this LDAP realm
100      * @return BIND_AUTHENTICATION_MODE or COMPARE_AUTHENTICATION_MODE
101      */
102     String   getAuthenticationMode();
103 
104     /**
105      * Get the attribute in order to get the password of this LDAP realm
106      * @return attribute in order to get the password of this LDAP realm
107      */
108     String   getUserPasswordAttribute();
109 
110     /**
111      * Get the attribute in order to get the user role from the ldap server
112      * @return attribute in order to get the user role from the ldap server
113      */
114     String   getUserRolesAttribute();
115 
116     /**
117      * Get the role name when performing a lookup on a role
118      * @return role name when performing a lookup on a role
119      */
120     String   getRoleNameAttribute();
121 
122     /**
123      * Get the DN used for the lookup of this LDAP realm
124      * @return baseDN DN used for the lookup
125      */
126     String   getBaseDN();
127 
128     /**
129      * Get the DN used when searching the user DN. Override the baseDN if it is
130      * defined
131      * @return userDN DN used when searching the user DN
132      */
133     String   getUserDN();
134 
135     /**
136      * Get the filter used when searching the user
137      * @return userSearchFilter filter used when searching the user
138      */
139     String   getUserSearchFilter();
140 
141     /**
142      * Get the DN used when searching the role DN. Override the baseDN if it is
143      * defined
144      * @return roleDN DN used when searching the role DN. Override the baseDN if
145      *         it is defined
146      */
147     String   getRoleDN();
148 
149     /**
150      * Get the filter used when searching the role
151      * @return roleSearchFilter filter used when searching the role
152      */
153     String   getRoleSearchFilter();
154 
155     /**
156      * Get the default algorithm
157      * @return the default algorithm
158      */
159     String   getAlgorithm();
160 
161     // Setters
162 
163     /**
164      * Set the initial context factory of this LDAP realm
165      * @param initialContextFactory the initial context factory
166      */
167     void setInitialContextFactory(String   initialContextFactory);
168 
169     /**
170      * Set the Url of the ldap server of this LDAP realm
171      * @param providerUrl Url of the ldap server
172      */
173     void setProviderUrl(String   providerUrl);
174 
175     /**
176      * Set the authentication used during the authentication to the LDAP server
177      * of this LDAP realm
178      * @param securityAuthentication authentication used during the
179      *        authentication to the LDAP server
180      */
181     void setSecurityAuthentication(String   securityAuthentication);
182 
183     /**
184      * Set the DN of the Principal(username) of this LDAP realm
185      * @param securityPrincipal DN of the Principal(username)
186      */
187     void setSecurityPrincipal(String   securityPrincipal);
188 
189     /**
190      * Set the Credential(password) of the principal of this LDAP realm
191      * @param securityCredentials Credential(password) of the principal
192      */
193     void setSecurityCredentials(String   securityCredentials);
194 
195     /**
196      * Set the security protocol to use of this LDAP realm
197      * @param securityProtocol security protocol to use
198      */
199     void setSecurityProtocol(String   securityProtocol);
200 
201     /**
202      * Set the preferred language to use with the service of this LDAP realm
203      * @param language preferred language to use with the service
204      */
205     void setLanguage(String   language);
206 
207     /**
208      * Set how referrals encountered by the service provider are to be processed
209      * @param referral how referrals encountered by the service provider are to
210      *        be processed
211      */
212     void setReferral(String   referral);
213 
214     /**
215      * Set the the list of state factories of this LDAP realm
216      * @param stateFactories list of state factories
217      */
218     void setStateFactories(String   stateFactories);
219 
220     /**
221      * Set the mode for validate the authentication of this LDAP realm
222      * @param authenticationMode BIND_AUTHENTICATION_MODE or
223      *        COMPARE_AUTHENTICATION_MODE
224      */
225     void setAuthenticationMode(String   authenticationMode);
226 
227     /**
228      * Set the attribute in order to get the password of this LDAP realm
229      * @param userPasswordAttribute attribute in order to get the password of
230      *        this LDAP realm
231      */
232     void setUserPasswordAttribute(String   userPasswordAttribute);
233 
234     /**
235      * Set the attribute in order to get the user role from the ldap server
236      * @param userRolesAttribute attribute in order to get the user role from
237      *        the ldap server
238      */
239     void setUserRolesAttribute(String   userRolesAttribute);
240 
241     /**
242      * Set the role name when performing a lookup on a role
243      * @param roleNameAttribute role name when performing a lookup on a role
244      */
245     void setRoleNameAttribute(String   roleNameAttribute);
246 
247     /**
248      * Set the DN used for the lookup of this LDAP realm
249      * @param baseDN DN used for the lookup
250      */
251     void setBaseDN(String   baseDN);
252 
253     /**
254      * Set the DN used when searching the user DN. Override the baseDN if it is
255      * defined
256      * @param userDN DN used when searching the user DN
257      */
258     void setUserDN(String   userDN);
259 
260     /**
261      * Set the filter used when searching the user
262      * @param userSearchFilter filter used when searching the user
263      */
264     void setUserSearchFilter(String   userSearchFilter);
265 
266     /**
267      * Set the DN used when searching the role DN. Override the baseDN if it is
268      * defined
269      * @param roleDN DN used when searching the role DN. Override the baseDN if
270      *        it is defined
271      */
272     void setRoleDN(String   roleDN);
273 
274     /**
275      * Set the filter used when searching the role
276      * @param roleSearchFilter filter used when searching the role
277      */
278     void setRoleSearchFilter(String   roleSearchFilter);
279 
280     /**
281      * Set the default algorithm to use
282      * @param algorithm algorithm to be used
283      */
284     void setAlgorithm(String   algorithm);
285 
286 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags