001: /**
002: * JOnAS: Java(TM) Open Application Server
003: * Copyright (C) 1999-2004 Bull S.A.
004: * Contact: jonas-team@objectweb.org
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2.1 of the License, or 1any later version.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
019: * USA
020: *
021: * Initial developer: Florent Benoit
022: * --------------------------------------------------------------------------
023: * $Id: JResourceLDAPMBean.java 4804 2004-05-25 15:13:29Z benoitf $
024: * --------------------------------------------------------------------------
025: */package org.objectweb.jonas.security.realm.factory;
026:
027: /**
028: * Define the methods for the MBean
029: * @author Florent Benoit
030: */
031: public interface JResourceLDAPMBean extends JResourceMBean {
032:
033: /**
034: * Clear the cache
035: */
036: void clearCache();
037:
038: // Getters
039:
040: /**
041: * Return the initial context factory of this LDAP realm
042: * @return the initial context factory
043: */
044: String getInitialContextFactory();
045:
046: /**
047: * Get the Url of the ldap server of this LDAP realm
048: * @return Url of the ldap server
049: */
050: String getProviderUrl();
051:
052: /**
053: * Get the authentication used during the authentication to the LDAP server
054: * of this LDAP realm
055: * @return authentication used during the authentication to the LDAP server
056: */
057: String getSecurityAuthentication();
058:
059: /**
060: * Get the DN of the Principal(username) of this LDAP realm
061: * @return DN of the Principal(username)
062: */
063: String getSecurityPrincipal();
064:
065: /**
066: * Get the Credential(password) of the principal of this LDAP realm
067: * @return Credential(password) of the principal
068: */
069: String getSecurityCredentials();
070:
071: /**
072: * Get the security protocol to use of this LDAP realm
073: * @return security protocol to use
074: */
075: String getSecurityProtocol();
076:
077: /**
078: * Get the preferred language to use with the service of this LDAP realm
079: * @return language preferred language to use with the service
080: */
081: String getLanguage();
082:
083: /**
084: * Get how referrals encountered by the service provider are to be processed
085: * @return how referrals encountered by the service provider are to be
086: * processed
087: */
088: String getReferral();
089:
090: /**
091: * Get the the list of state factories of this LDAP realm
092: * @return list of state factories
093: */
094: String getStateFactories();
095:
096: /**
097: * Get the mode for validate the authentication of this LDAP realm
098: * @return BIND_AUTHENTICATION_MODE or COMPARE_AUTHENTICATION_MODE
099: */
100: String getAuthenticationMode();
101:
102: /**
103: * Get the attribute in order to get the password of this LDAP realm
104: * @return attribute in order to get the password of this LDAP realm
105: */
106: String getUserPasswordAttribute();
107:
108: /**
109: * Get the attribute in order to get the user role from the ldap server
110: * @return attribute in order to get the user role from the ldap server
111: */
112: String getUserRolesAttribute();
113:
114: /**
115: * Get the role name when performing a lookup on a role
116: * @return role name when performing a lookup on a role
117: */
118: String getRoleNameAttribute();
119:
120: /**
121: * Get the DN used for the lookup of this LDAP realm
122: * @return baseDN DN used for the lookup
123: */
124: String getBaseDN();
125:
126: /**
127: * Get the DN used when searching the user DN. Override the baseDN if it is
128: * defined
129: * @return userDN DN used when searching the user DN
130: */
131: String getUserDN();
132:
133: /**
134: * Get the filter used when searching the user
135: * @return userSearchFilter filter used when searching the user
136: */
137: String getUserSearchFilter();
138:
139: /**
140: * Get the DN used when searching the role DN. Override the baseDN if it is
141: * defined
142: * @return roleDN DN used when searching the role DN. Override the baseDN if
143: * it is defined
144: */
145: String getRoleDN();
146:
147: /**
148: * Get the filter used when searching the role
149: * @return roleSearchFilter filter used when searching the role
150: */
151: String getRoleSearchFilter();
152:
153: /**
154: * Get the default algorithm
155: * @return the default algorithm
156: */
157: String getAlgorithm();
158:
159: // Setters
160:
161: /**
162: * Set the initial context factory of this LDAP realm
163: * @param initialContextFactory the initial context factory
164: */
165: void setInitialContextFactory(String initialContextFactory);
166:
167: /**
168: * Set the Url of the ldap server of this LDAP realm
169: * @param providerUrl Url of the ldap server
170: */
171: void setProviderUrl(String providerUrl);
172:
173: /**
174: * Set the authentication used during the authentication to the LDAP server
175: * of this LDAP realm
176: * @param securityAuthentication authentication used during the
177: * authentication to the LDAP server
178: */
179: void setSecurityAuthentication(String securityAuthentication);
180:
181: /**
182: * Set the DN of the Principal(username) of this LDAP realm
183: * @param securityPrincipal DN of the Principal(username)
184: */
185: void setSecurityPrincipal(String securityPrincipal);
186:
187: /**
188: * Set the Credential(password) of the principal of this LDAP realm
189: * @param securityCredentials Credential(password) of the principal
190: */
191: void setSecurityCredentials(String securityCredentials);
192:
193: /**
194: * Set the security protocol to use of this LDAP realm
195: * @param securityProtocol security protocol to use
196: */
197: void setSecurityProtocol(String securityProtocol);
198:
199: /**
200: * Set the preferred language to use with the service of this LDAP realm
201: * @param language preferred language to use with the service
202: */
203: void setLanguage(String language);
204:
205: /**
206: * Set how referrals encountered by the service provider are to be processed
207: * @param referral how referrals encountered by the service provider are to
208: * be processed
209: */
210: void setReferral(String referral);
211:
212: /**
213: * Set the the list of state factories of this LDAP realm
214: * @param stateFactories list of state factories
215: */
216: void setStateFactories(String stateFactories);
217:
218: /**
219: * Set the mode for validate the authentication of this LDAP realm
220: * @param authenticationMode BIND_AUTHENTICATION_MODE or
221: * COMPARE_AUTHENTICATION_MODE
222: */
223: void setAuthenticationMode(String authenticationMode);
224:
225: /**
226: * Set the attribute in order to get the password of this LDAP realm
227: * @param userPasswordAttribute attribute in order to get the password of
228: * this LDAP realm
229: */
230: void setUserPasswordAttribute(String userPasswordAttribute);
231:
232: /**
233: * Set the attribute in order to get the user role from the ldap server
234: * @param userRolesAttribute attribute in order to get the user role from
235: * the ldap server
236: */
237: void setUserRolesAttribute(String userRolesAttribute);
238:
239: /**
240: * Set the role name when performing a lookup on a role
241: * @param roleNameAttribute role name when performing a lookup on a role
242: */
243: void setRoleNameAttribute(String roleNameAttribute);
244:
245: /**
246: * Set the DN used for the lookup of this LDAP realm
247: * @param baseDN DN used for the lookup
248: */
249: void setBaseDN(String baseDN);
250:
251: /**
252: * Set the DN used when searching the user DN. Override the baseDN if it is
253: * defined
254: * @param userDN DN used when searching the user DN
255: */
256: void setUserDN(String userDN);
257:
258: /**
259: * Set the filter used when searching the user
260: * @param userSearchFilter filter used when searching the user
261: */
262: void setUserSearchFilter(String userSearchFilter);
263:
264: /**
265: * Set the DN used when searching the role DN. Override the baseDN if it is
266: * defined
267: * @param roleDN DN used when searching the role DN. Override the baseDN if
268: * it is defined
269: */
270: void setRoleDN(String roleDN);
271:
272: /**
273: * Set the filter used when searching the role
274: * @param roleSearchFilter filter used when searching the role
275: */
276: void setRoleSearchFilter(String roleSearchFilter);
277:
278: /**
279: * Set the default algorithm to use
280: * @param algorithm algorithm to be used
281: */
282: void setAlgorithm(String algorithm);
283:
284: }
|