Skip to content

Commit 4ff4fe5

Browse files
author
Vladimir Kotal
committed
ldap -> LDAP
1 parent a8aaadc commit 4ff4fe5

File tree

5 files changed

+43
-43
lines changed

5 files changed

+43
-43
lines changed

‎plugins/LdapPlugin/src/opengrok/auth/plugin/AbstractLdapPlugin.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ abstract public class AbstractLdapPlugin implements IAuthorizationPlugin {
6868
protected String SESSION_VERSION = "opengrok-group-plugin-session-version";
6969

7070
/**
71-
* Configuration for the ldap servers.
71+
* Configuration for the LDAP servers.
7272
*/
7373
private Configuration cfg;
7474

@@ -79,7 +79,7 @@ abstract public class AbstractLdapPlugin implements IAuthorizationPlugin {
7979
private static final Map<String, Configuration> LOADED_CONFIGURATIONS = new ConcurrentHashMap<>();
8080

8181
/**
82-
* Ldap lookup facade.
82+
* LDAP lookup facade.
8383
*/
8484
private AbstractLdapProvider ldap;
8585

@@ -159,7 +159,7 @@ protected Configuration getConfiguration(String configurationPath) throws IOExce
159159
}
160160

161161
/**
162-
* Closes the ldap connections.
162+
* Closes the LDAP connections.
163163
*/
164164
@Override
165165
public void unload() {
@@ -182,7 +182,7 @@ public Configuration getConfiguration() {
182182
/**
183183
* Return the LDAP provider.
184184
*
185-
* @return the ldap provider
185+
* @return the LDAP provider
186186
*/
187187
public AbstractLdapProvider getLdapProvider() {
188188
return ldap;
@@ -207,7 +207,7 @@ protected boolean isSameUser(String sessionUsername, String authUser) {
207207
* Check if the session exists and contains all necessary fields required by
208208
* this plugin.
209209
*
210-
* @param req the http request
210+
* @param req the HTTP request
211211
* @return true if it does; false otherwise
212212
*/
213213
protected boolean sessionExists(HttpServletRequest req) {
@@ -222,7 +222,7 @@ protected boolean sessionExists(HttpServletRequest req) {
222222
* appropriate fields. If any error occurs during the call which might be:
223223
* <ul>
224224
* <li>The user has not been authenticated</li>
225-
* <li>The user can not be retrieved from ldap</li>
225+
* <li>The user can not be retrieved from LDAP</li>
226226
* <li>There are no records for authorization for the user</li>
227227
* </ul>
228228
* the session is established as an empty session to avoid any exception in

‎plugins/LdapPlugin/src/opengrok/auth/plugin/LdapUserPlugin.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public class LdapUserPlugin extends AbstractLdapPlugin {
3838
* Check if the session exists and contains all necessary fields required by
3939
* this plugin.
4040
*
41-
* @param req the http request
41+
* @param req the HTTP request
4242
* @return true if it does; false otherwise
4343
*/
4444
@Override

‎plugins/LdapPlugin/src/opengrok/auth/plugin/ldap/AbstractLdapProvider.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public abstract class AbstractLdapProvider {
3131
/**
3232
* Lookups user's records - mail address - ou records - uid
3333
*
34-
* @param user find ldap information about this user
34+
* @param user find LDAP information about this user
3535
* @return set of important attributes for the user
3636
*
3737
* @see #lookupLdapContent(opengrok.auth.plugin.entity.User,
@@ -45,8 +45,8 @@ public Map<String, Set<String>> lookupLdapContent(User user) {
4545
/**
4646
* Lookups user's records - mail address - ou records - uid
4747
*
48-
* @param user find ldap information about this user
49-
* @param filter the ldap filter
48+
* @param user find LDAP information about this user
49+
* @param filter the LDAP filter
5050
* @return set of important attributes for the user
5151
*
5252
* @see #lookupLdapContent(opengrok.auth.plugin.entity.User,
@@ -59,8 +59,8 @@ public Map<String, Set<String>> lookupLdapContent(User user, String filter) {
5959
/**
6060
* Lookups user's records - mail address - ou records - uid
6161
*
62-
* @param user find ldap information about this user
63-
* @param values match these ldap value
62+
* @param user find LDAP information about this user
63+
* @param values match these LDAP value
6464
* @return set of important attributes for the user
6565
*
6666
* @see #lookupLdapContent(opengrok.auth.plugin.entity.User,
@@ -73,9 +73,9 @@ public Map<String, Set<String>> lookupLdapContent(User user, String[] values) {
7373
/**
7474
* Lookups user's records - mail address - ou records - uid
7575
*
76-
* @param user find ldap information about this user
77-
* @param filter the ldap filter
78-
* @param values match these ldap value
76+
* @param user find LDAP information about this user
77+
* @param filter the LDAP filter
78+
* @param values match these LDAP value
7979
* @return set of important attributes for the user
8080
*/
8181
abstract public Map<String, Set<String>> lookupLdapContent(User user, String filter, String[] values);
@@ -86,7 +86,7 @@ public Map<String, Set<String>> lookupLdapContent(User user, String[] values) {
8686
abstract public boolean isConfigured();
8787

8888
/**
89-
* Closes the ldap provider.
89+
* Closes the LDAP provider.
9090
*/
9191
abstract public void close();
9292

‎plugins/LdapPlugin/src/opengrok/auth/plugin/ldap/LdapFacade.java

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public class LdapFacade extends AbstractLdapProvider {
4848
private static final Logger LOGGER = Logger.getLogger(LdapFacade.class.getName());
4949

5050
/**
51-
* Ldap filter.
51+
* LDAP filter.
5252
*/
5353
private static final String LDAP_FILTER = "objectclass=*";
5454

@@ -71,7 +71,7 @@ public class LdapFacade extends AbstractLdapProvider {
7171
* When there is no active server in the pool, the facade waits this time
7272
* interval (since the last failure) until it tries the servers again.
7373
*
74-
* This should avoid heavy load to the ldap servers when they are all
74+
* This should avoid heavy load to the LDAP servers when they are all
7575
* broken/not responding/down - pool waiting.
7676
*
7777
* Also each server uses this same interval since its last failure - per
@@ -95,7 +95,7 @@ public class LdapFacade extends AbstractLdapProvider {
9595
private boolean reported = false;
9696

9797
/**
98-
* Interface for converting ldap results into user defined types.
98+
* Interface for converting LDAP results into user defined types.
9999
*
100100
* @param <T> the type of the result
101101
*/
@@ -240,8 +240,8 @@ public boolean isConfigured() {
240240
*
241241
*
242242
* @param user the osso headers
243-
* @param filter ldap filter to use
244-
* @param values match these ldap value
243+
* @param filter LDAP filter to use
244+
* @param values match these LDAP value
245245
*
246246
* @return set of strings describing the user's attributes
247247
* @see #LDAP_VALUES
@@ -265,12 +265,12 @@ private SearchControls prepareSearchControls() {
265265
}
266266

267267
/**
268-
* Lookups the ldap server for content
268+
* Lookups the LDAP server for content
269269
*
270270
* @param <T> return type
271271
* @param dn search base for the query
272-
* @param filter ldap filter for the query
273-
* @param attributes returning ldap attributes
272+
* @param filter LDAP filter for the query
273+
* @param attributes returning LDAP attributes
274274
* @param mapper mapper class implementing @code{AttributeMapper} closed
275275
*
276276
* @return results transformed with mapper
@@ -280,12 +280,12 @@ private <T> T lookup(String dn, String filter, String[] attributes, AttributeMap
280280
}
281281

282282
/**
283-
* Lookups the ldap server for content
283+
* Lookups the LDAP server for content
284284
*
285285
* @param <T> return type
286286
* @param dn search base for the query
287-
* @param filter ldap filter for the query
288-
* @param attributes returning ldap attributes
287+
* @param filter LDAP filter for the query
288+
* @param attributes returning LDAP attributes
289289
* @param mapper mapper class implementing @code{AttributeMapper} closed
290290
* @param fail current count of failures
291291
*
@@ -324,15 +324,15 @@ private <T> T lookup(String dn, String filter, String[] attributes, AttributeMap
324324
return processResult(sr, mapper);
325325
}
326326
} catch (NameNotFoundException ex) {
327-
LOGGER.log(Level.SEVERE, "The ldap name was not found.", ex);
327+
LOGGER.log(Level.SEVERE, "The LDAP name was not found.", ex);
328328
return null;
329329
} catch (SizeLimitExceededException ex) {
330-
LOGGER.log(Level.SEVERE, "The maximum size of the ldap result has exceeded.", ex);
330+
LOGGER.log(Level.SEVERE, "The maximum size of the LDAP result has exceeded.", ex);
331331
closeActualServer();
332332
actualServer = getNextServer();
333333
return lookup(dn, filter, attributes, mapper, fail + 1);
334334
} catch (TimeLimitExceededException ex) {
335-
LOGGER.log(Level.SEVERE, "Time limit for ldap operation has exceeded.", ex);
335+
LOGGER.log(Level.SEVERE, "Time limit for LDAP operation has exceeded.", ex);
336336
closeActualServer();
337337
actualServer = getNextServer();
338338
return lookup(dn, filter, attributes, mapper, fail + 1);
@@ -342,7 +342,7 @@ private <T> T lookup(String dn, String filter, String[] attributes, AttributeMap
342342
actualServer = getNextServer();
343343
return lookup(dn, filter, attributes, mapper, fail + 1);
344344
} catch (NamingException ex) {
345-
LOGGER.log(Level.SEVERE, "An arbitrary ldap error occured.", ex);
345+
LOGGER.log(Level.SEVERE, "An arbitrary LDAP error occured.", ex);
346346
closeActualServer();
347347
actualServer = getNextServer();
348348
return lookup(dn, filter, attributes, mapper, fail + 1);
@@ -373,10 +373,10 @@ private int getNextServer() {
373373
}
374374

375375
/**
376-
* Process the incoming ldap result.
376+
* Process the incoming LDAP result.
377377
*
378378
* @param <T> type of the result
379-
* @param result ldap result
379+
* @param result LDAP result
380380
* @param mapper mapper to transform the result into the result type
381381
* @return transformed result
382382
*

‎plugins/LdapPlugin/src/opengrok/auth/plugin/ldap/LdapServer.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ public void setInterval(int interval) {
113113
}
114114

115115
/**
116-
* The ldap server is working only when its connection is not null. This
116+
* The LDAP server is working only when its connection is not null. This
117117
* tries to establish the connection if it is not established already.
118118
*
119119
* @return true if it is working
@@ -126,7 +126,7 @@ public synchronized boolean isWorking() {
126126
}
127127

128128
/**
129-
* Connects to the ldap server.
129+
* Connects to the LDAP server.
130130
*
131131
* @return the new connection or null
132132
*/
@@ -169,12 +169,12 @@ private synchronized LdapContext connect() {
169169
}
170170

171171
/**
172-
* Lookups the ldap server.
172+
* Lookups the LDAP server.
173173
*
174174
* @param name base dn for the search
175-
* @param filter ldap filter
176-
* @param cons controls for the ldap request
177-
* @return ldap enumeration with the results
175+
* @param filter LDAP filter
176+
* @param cons controls for the LDAP request
177+
* @return LDAP enumeration with the results
178178
*
179179
* @throws NamingException
180180
*/
@@ -183,13 +183,13 @@ public NamingEnumeration<SearchResult> search(String name, String filter, Search
183183
}
184184

185185
/**
186-
* Lookups the ldap server.
186+
* Lookups the LDAP server.
187187
*
188188
* @param name base dn for the search
189-
* @param filter ldap filter
190-
* @param controls controls for the ldap request
189+
* @param filter LDAP filter
190+
* @param controls controls for the LDAP request
191191
* @param reconnected flag if the request has failed previously
192-
* @return ldap enumeration with the results
192+
* @return LDAP enumeration with the results
193193
*
194194
* @throws NamingException
195195
*/

0 commit comments

Comments
 (0)