You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2018/08/08 22:06:19 UTC
[directory-server] branch master updated: Fixed some ApacheDS
Javadoc errors and warnings
This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/directory-server.git
The following commit(s) were added to refs/heads/master by this push:
new cfb8673 Fixed some ApacheDS Javadoc errors and warnings
cfb8673 is described below
commit cfb86735aa5893ae3a1b15fe9ebedb8760afef0c
Author: Emmanuel Lécharny <el...@symas.com>
AuthorDate: Thu Aug 9 00:06:15 2018 +0200
Fixed some ApacheDS Javadoc errors and warnings
---
.../server/core/annotations/LoadSchema.java | 8 +-
.../factory/DirectoryServiceAnnotationTest.java | 3 +-
.../directory/server/core/api/AbstractLayout.java | 2 +
.../server/core/api/AttributeTypeProvider.java | 42 ++++----
.../directory/server/core/api/CoreSession.java | 116 ++++++++++++---------
.../server/core/api/DirectoryService.java | 68 ++++++++----
.../server/core/api/ObjectClassProvider.java | 1 +
.../server/core/api/ReferralHandlingMode.java | 2 +
.../directory/server/core/api/ReferralManager.java | 9 +-
.../server/core/api/SearchRequestContainer.java | 7 +-
.../api/administrative/AdministrativePoint.java | 12 +--
.../core/api/authn/ppolicy/CheckQualityEnum.java | 2 +-
.../server/core/api/changelog/ChangeLog.java | 20 ++--
.../server/core/api/changelog/ChangeLogStore.java | 10 +-
.../directory/server/core/api/journal/Journal.java | 8 +-
.../server/core/api/journal/JournalStore.java | 14 +--
.../server/core/jndi/ServerDirStateFactory.java | 2 +-
.../shared/partition/DefaultPartitionNexus.java | 4 +-
.../server/core/DefaultDirectoryService.java | 54 +++++++---
.../core/admin/AdministrativePointInterceptor.java | 7 +-
.../server/core/authn/AnonymousAuthenticator.java | 2 +
.../core/authn/AuthenticationInterceptor.java | 3 +-
.../directory/server/core/authn/Authenticator.java | 15 ++-
.../server/core/authn/DelegatingAuthenticator.java | 14 ++-
.../server/core/authn/PasswordHistory.java | 2 +
.../server/core/authn/SimpleAuthenticator.java | 6 ++
.../server/core/authn/StrongAuthenticator.java | 2 +
.../core/authn/ppolicy/PpolicyConfigContainer.java | 2 +-
.../core/authz/AciAuthorizationInterceptor.java | 2 +-
.../authz/DefaultAuthorizationInterceptor.java | 4 +
.../directory/server/core/authz/GroupCache.java | 4 +-
.../server/core/authz/support/ACDFEngine.java | 9 +-
.../server/core/authz/support/OperationScope.java | 2 +-
.../server/core/authz/support/package-info.java | 2 -
.../server/core/changelog/DefaultChangeLog.java | 6 +-
.../core/changelog/MemoryChangeLogStore.java | 58 +++++++----
.../server/core/changelog/package-info.java | 2 -
.../core/exception/ExceptionInterceptor.java | 4 +-
.../core/hash/PasswordHashingInterceptor.java | 1 +
.../server/core/journal/DefaultJournal.java | 24 ++++-
.../server/core/journal/DefaultJournalStore.java | 12 +--
.../normalization/NormalizationInterceptor.java | 2 +-
.../OperationalAttributeInterceptor.java | 1 +
.../server/core/referral/ReferralInterceptor.java | 6 +-
.../server/core/schema/SchemaInterceptor.java | 6 +-
.../schema/SchemaLdifToPartitionExtractor.java | 1 +
.../server/core/schema/SchemaSubentryManager.java | 16 +--
.../directory/server/core/schema/package-info.java | 6 --
.../server/core/subtree/SubentryInterceptor.java | 1 -
.../server/core/trigger/TriggerInterceptor.java | 2 +-
.../partition/impl/btree/jdbm/DnSerializer.java | 2 +-
.../partition/impl/btree/jdbm/EntrySerializer.java | 2 +-
.../impl/btree/jdbm/ParentIdAndRdnSerializer.java | 2 +-
.../directory/shared/kerberos/KerberosUtils.java | 76 +++++++-------
.../partition/impl/btree/mavibot/DnSerializer.java | 2 +-
.../impl/btree/mavibot/MavibotEntrySerializer.java | 2 +-
.../mavibot/MavibotParentIdAndRdnSerializer.java | 4 +-
.../apache/directory/server/ldap/LdapServer.java | 4 +-
.../ldap/handlers/request/BindRequestHandler.java | 8 +-
.../replication/ReplicaEventMessageSerializer.java | 2 +-
.../ldap/replication/provider/ReplicaEventLog.java | 2 +-
.../server/ntp/protocol/NtpProtocolHandler.java | 2 +-
.../org/apache/directory/server/xdbm/Index.java | 6 +-
63 files changed, 435 insertions(+), 287 deletions(-)
diff --git a/core-annotations/src/main/java/org/apache/directory/server/core/annotations/LoadSchema.java b/core-annotations/src/main/java/org/apache/directory/server/core/annotations/LoadSchema.java
index fac1ab7..70d28e6 100644
--- a/core-annotations/src/main/java/org/apache/directory/server/core/annotations/LoadSchema.java
+++ b/core-annotations/src/main/java/org/apache/directory/server/core/annotations/LoadSchema.java
@@ -27,13 +27,13 @@ import java.lang.annotation.Target;
/**
* An annotation for the schema loading. One can list the schema to be loaded,
- * and if they must be enabled or disabled.<br/>
+ * and if they must be enabled or disabled.<br>
* We can only load new schemas, not unload existing ones.However, we
* can disable a schema that has been previously loaded : loading a
* schema that is already loaded will just apply the enabled flag on
- * this schema<br/>
- * Note that a schema may be loaded and disabled.<br/>
- * Some schema are automatically loaded, and there is no way they can be disabled :<br/>
+ * this schema<br>
+ * Note that a schema may be loaded and disabled.<br>
+ * Some schema are automatically loaded, and there is no way they can be disabled :<br>
* <ul>
* <li> core</li>
* <li>system</li>
diff --git a/core-annotations/src/test/java/org/apache/directory/server/core/factory/DirectoryServiceAnnotationTest.java b/core-annotations/src/test/java/org/apache/directory/server/core/factory/DirectoryServiceAnnotationTest.java
index 50f286a..37bf687 100644
--- a/core-annotations/src/test/java/org/apache/directory/server/core/factory/DirectoryServiceAnnotationTest.java
+++ b/core-annotations/src/test/java/org/apache/directory/server/core/factory/DirectoryServiceAnnotationTest.java
@@ -28,6 +28,7 @@ import java.util.HashSet;
import java.util.Set;
import org.apache.directory.api.ldap.model.constants.AuthenticationLevel;
+import org.apache.directory.api.ldap.model.exception.LdapException;
import org.apache.directory.api.ldap.model.name.Dn;
import org.apache.directory.api.util.FileUtils;
import org.apache.directory.server.core.annotations.ContextEntry;
@@ -228,7 +229,7 @@ public class DirectoryServiceAnnotationTest
@Override
- public LdapPrincipal authenticate( BindOperationContext ctx ) throws Exception
+ public LdapPrincipal authenticate( BindOperationContext ctx ) throws LdapException
{
dummyAuthenticatorCalled = true;
return new LdapPrincipal(
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/AbstractLayout.java b/core-api/src/main/java/org/apache/directory/server/core/api/AbstractLayout.java
index 487fed3..cc87562 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/AbstractLayout.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/AbstractLayout.java
@@ -106,6 +106,8 @@ public abstract class AbstractLayout
/**
* Creates the required directories (if they don't already exist).
+ *
+ * @throws IOException If the directory cannot be created
*/
public void mkdirs() throws IOException
{
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/AttributeTypeProvider.java b/core-api/src/main/java/org/apache/directory/server/core/api/AttributeTypeProvider.java
index aa908c1..eeedc77 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/AttributeTypeProvider.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/AttributeTypeProvider.java
@@ -98,7 +98,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>accessControlSubentries<code> {@link AttributeType}.
+ * @return the <code>accessControlSubentries</code> {@link AttributeType}.
*/
public AttributeType getAccessControlSubentries()
{
@@ -107,7 +107,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>administrativeRole<code> {@link AttributeType}.
+ * @return the <code>administrativeRole</code> {@link AttributeType}.
*/
public AttributeType getAdministrativeRole()
{
@@ -116,7 +116,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>collectiveAttributeSubentries<code> {@link AttributeType}.
+ * @return the <code>collectiveAttributeSubentries</code> {@link AttributeType}.
*/
public AttributeType getCollectiveAttributeSubentries()
{
@@ -125,7 +125,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>collectiveExclusions<code> {@link AttributeType}.
+ * @return the <code>collectiveExclusions</code> {@link AttributeType}.
*/
public AttributeType getCollectiveExclusions()
{
@@ -134,7 +134,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>creatorsName<code> {@link AttributeType}.
+ * @return the <code>creatorsName</code> {@link AttributeType}.
*/
public AttributeType getCreatorsName()
{
@@ -143,7 +143,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>createTimestamp<code> {@link AttributeType}.
+ * @return the <code>createTimestamp</code> {@link AttributeType}.
*/
public AttributeType getCreateTimestamp()
{
@@ -152,7 +152,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>entryACI<code> {@link AttributeType}.
+ * @return the <code>entryACI</code> {@link AttributeType}.
*/
public AttributeType getEntryACI()
{
@@ -161,7 +161,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>entryCSN<code> {@link AttributeType}.
+ * @return the <code>entryCSN</code> {@link AttributeType}.
*/
public AttributeType getEntryCSN()
{
@@ -170,7 +170,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>entryDN<code> {@link AttributeType}.
+ * @return the <code>entryDN</code> {@link AttributeType}.
*/
public AttributeType getEntryDN()
{
@@ -179,7 +179,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>entryUUID<code> {@link AttributeType}.
+ * @return the <code>entryUUID</code> {@link AttributeType}.
*/
public AttributeType getEntryUUID()
{
@@ -188,7 +188,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>member<code> {@link AttributeType}.
+ * @return the <code>member</code> {@link AttributeType}.
*/
public AttributeType getMember()
{
@@ -197,7 +197,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>modifiersName<code> {@link AttributeType}.
+ * @return the <code>modifiersName</code> {@link AttributeType}.
*/
public AttributeType getModifiersName()
{
@@ -206,7 +206,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>modifyTimestamp<code> {@link AttributeType}.
+ * @return the <code>modifyTimestamp</code> {@link AttributeType}.
*/
public AttributeType getModifyTimestamp()
{
@@ -215,7 +215,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>objectClass<code> {@link AttributeType}.
+ * @return the <code>objectClass</code> {@link AttributeType}.
*/
public AttributeType getObjectClass()
{
@@ -224,7 +224,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>prescriptiveACI<code> {@link AttributeType}.
+ * @return the <code>prescriptiveACI</code> {@link AttributeType}.
*/
public AttributeType getPrescriptiveACI()
{
@@ -233,7 +233,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>subentryACI<code> {@link AttributeType}.
+ * @return the <code>subentryACI</code> {@link AttributeType}.
*/
public AttributeType getSubentryACI()
{
@@ -242,7 +242,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>subschemaSubentry<code> {@link AttributeType}.
+ * @return the <code>subschemaSubentry</code> {@link AttributeType}.
*/
public AttributeType getSubschemaSubentry()
{
@@ -251,7 +251,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>subtreeSpecification<code> {@link AttributeType}.
+ * @return the <code>subtreeSpecification</code> {@link AttributeType}.
*/
public AttributeType getSubtreeSpecification()
{
@@ -260,7 +260,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>triggerExecutionSubentries<code> {@link AttributeType}.
+ * @return the <code>triggerExecutionSubentries</code> {@link AttributeType}.
*/
public AttributeType getTriggerExecutionSubentries()
{
@@ -269,7 +269,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>uniqueMember<code> {@link AttributeType}.
+ * @return the <code>uniqueMember</code> {@link AttributeType}.
*/
public AttributeType getUniqueMember()
{
@@ -296,7 +296,7 @@ public class AttributeTypeProvider
/**
- * @return the <code>userPassword<code> {@link AttributeType}.
+ * @return the <code>userPassword</code> {@link AttributeType}.
*/
public AttributeType getUserPassword()
{
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/CoreSession.java b/core-api/src/main/java/org/apache/directory/server/core/api/CoreSession.java
index 4dd8cde..e9bc149 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/CoreSession.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/CoreSession.java
@@ -42,6 +42,7 @@ import org.apache.directory.api.ldap.model.message.SearchScope;
import org.apache.directory.api.ldap.model.message.UnbindRequest;
import org.apache.directory.api.ldap.model.name.Dn;
import org.apache.directory.api.ldap.model.name.Rdn;
+import org.apache.directory.server.constants.ServerDNConstants;
import org.apache.directory.server.core.api.changelog.LogChange;
import org.apache.directory.server.core.api.interceptor.context.OperationContext;
@@ -209,7 +210,7 @@ public interface CoreSession
* Adds an entry into the DirectoryService associated with this CoreSession.
*
* @param entry the entry to add
- * @exception Exception on failures to add the entry
+ * @exception LdapException on failures to add the entry
*/
void add( Entry entry ) throws LdapException;
@@ -219,7 +220,7 @@ public interface CoreSession
*
* @param entry the entry to add
* @param log a flag set if the added entry should be stored in the changeLog
- * @exception Exception on failures to add the entry
+ * @exception LdapException on failures to add the entry
*/
void add( Entry entry, LogChange log ) throws LdapException;
@@ -231,7 +232,7 @@ public interface CoreSession
*
* @param entry the entry to add
* @param ignoreReferral a flag to tell the server to ignore referrals
- * @exception Exception on failures to add the entry
+ * @exception LdapException on failures to add the entry
*/
void add( Entry entry, boolean ignoreReferral ) throws LdapException;
@@ -244,7 +245,7 @@ public interface CoreSession
* @param entry the entry to add
* @param ignoreReferral a flag to tell the server to ignore referrals
* @param log a flag set if the added entry should be stored in the changeLog
- * @exception Exception on failures to add the entry
+ * @exception LdapException on failures to add the entry
*/
void add( Entry entry, boolean ignoreReferral, LogChange log ) throws LdapException;
@@ -254,7 +255,7 @@ public interface CoreSession
* The entry is built using the received AddRequest.
*
* @param addRequest the request to execute
- * @exception Exception on failures to add the entry
+ * @exception LdapException on failures to add the entry
*/
void add( AddRequest addRequest ) throws LdapException;
@@ -265,7 +266,7 @@ public interface CoreSession
*
* @param addRequest the request to execute
* @param log a flag set if the added entry should be stored in the changeLog
- * @exception Exception on failures to add the entry
+ * @exception LdapException on failures to add the entry
*/
void add( AddRequest addRequest, LogChange log ) throws LdapException;
@@ -276,7 +277,8 @@ public interface CoreSession
* @param dn the distinguished name of the entry to check
* @param oid the OID of the attribute to check for the value
* @param value the value to check for
- * @throws Exception if there are failures while comparing
+ * @return <tt>true</tt> if the value exists in the entry
+ * @throws LdapException if there are failures while comparing
*/
boolean compare( Dn dn, String oid, Object value ) throws LdapException;
@@ -290,7 +292,8 @@ public interface CoreSession
* @param oid the OID of the attribute to check for the value
* @param value the value to check for
* @param ignoreReferral a flag to tell the server to ignore referrals
- * @throws Exception if there are failures while comparing
+ * @return <tt>true</tt> if the value exists in the entry
+ * @throws LdapException if there are failures while comparing
*/
boolean compare( Dn dn, String oid, Object value, boolean ignoreReferral ) throws LdapException;
@@ -299,7 +302,8 @@ public interface CoreSession
* Checks to see if an attribute in an entry contains a value.
*
* @param compareRequest the received request
- * @throws Exception if there are failures while comparing
+ * @return <tt>true</tt> if the value exists in the entry
+ * @throws LdapException if there are failures while comparing
*/
boolean compare( CompareRequest compareRequest ) throws LdapException;
@@ -308,7 +312,7 @@ public interface CoreSession
* Deletes an entry in the server.
*
* @param dn the distinguished name of the entry to delete
- * @throws Exception if there are failures while deleting the entry
+ * @throws LdapException if there are failures while deleting the entry
*/
void delete( Dn dn ) throws LdapException;
@@ -318,7 +322,7 @@ public interface CoreSession
*
* @param dn the distinguished name of the entry to delete
* @param log a flag set if the added entry should be stored in the changeLog
- * @throws Exception if there are failures while deleting the entry
+ * @throws LdapException if there are failures while deleting the entry
*/
void delete( Dn dn, LogChange log ) throws LdapException;
@@ -328,7 +332,7 @@ public interface CoreSession
*
* @param deleteRequest the delete request containing all the informations
* necessary to delete the entry
- * @throws Exception if there are failures while deleting the entry
+ * @throws LdapException if there are failures while deleting the entry
*/
void delete( DeleteRequest deleteRequest ) throws LdapException;
@@ -339,7 +343,7 @@ public interface CoreSession
* @param deleteRequest the delete request containing all the informations
* necessary to delete the entry
* @param log Tells if we should log the deletion in the ChangeLog interceptor
- * @throws Exception if there are failures while deleting the entry
+ * @throws LdapException if there are failures while deleting the entry
*/
void delete( DeleteRequest deleteRequest, LogChange log ) throws LdapException;
@@ -351,7 +355,7 @@ public interface CoreSession
*
* @param dn the distinguished name of the entry to delete
* @param ignoreReferral a flag to tell the server to ignore referrals
- * @throws Exception if there are failures while deleting the entry
+ * @throws LdapException if there are failures while deleting the entry
*/
void delete( Dn dn, boolean ignoreReferral ) throws LdapException;
@@ -364,19 +368,27 @@ public interface CoreSession
* @param dn the distinguished name of the entry to delete
* @param ignoreReferral a flag to tell the server to ignore referrals
* @param log a flag set if the added entry should be stored in the changeLog
- * @throws Exception if there are failures while deleting the entry
+ * @throws LdapException if there are failures while deleting the entry
*/
void delete( Dn dn, boolean ignoreReferral, LogChange log ) throws LdapException;
/**
- * Checks to see if an entry exists.
+ * Checks to see if an entry exists.
+ *
+ * @param dn The Dn for the entry to find
+ * @return <tt>true</tt> if the entry exists
+ * @throws LdapException If we weren't able to fetch the entry
*/
boolean exists( String dn ) throws LdapException;
/**
- * Checks to see if an entry exists.
+ * Checks to see if an entry exists.
+ *
+ * @param dn The Dn for the entry to find
+ * @return <tt>true</tt> if the entry exists
+ * @throws LdapException If we weren't able to fetch the entry
*/
boolean exists( Dn dn ) throws LdapException;
@@ -387,7 +399,8 @@ public interface CoreSession
*
* @param dn the name of the entry to lookup
* @param atIds The list of attributes to return
- * @throws Exception if there are failures while looking up the entry
+ * @return The found Entry
+ * @throws LdapException if there are failures while looking up the entry
*/
Entry lookup( Dn dn, String... atIds ) throws LdapException;
@@ -399,7 +412,8 @@ public interface CoreSession
* @param dn the name of the entry to lookup
* @param controls the Controls to use
* @param atIds The list of attributes to return
- * @throws Exception if there are failures while looking up the entry
+ * @return The found Entry
+ * @throws LdapException if there are failures while looking up the entry
*/
Entry lookup( Dn dn, Control[] controls, String... atIds ) throws LdapException;
@@ -410,7 +424,7 @@ public interface CoreSession
*
* @param dn the distinguished name of the entry to modify
* @param mods the list of modifications to apply
- * @throws Exception if there are failures while modifying the entry
+ * @throws LdapException if there are failures while modifying the entry
*/
void modify( Dn dn, List<Modification> mods ) throws LdapException;
@@ -421,7 +435,7 @@ public interface CoreSession
*
* @param dn the distinguished name of the entry to modify
* @param mods the list of modifications to apply
- * @throws Exception if there are failures while modifying the entry
+ * @throws LdapException if there are failures while modifying the entry
*/
void modify( Dn dn, Modification... mods ) throws LdapException;
@@ -433,7 +447,7 @@ public interface CoreSession
* @param dn the distinguished name of the entry to modify
* @param mods the list of modifications to apply
* @param log a flag set if the added entry should be stored in the changeLog
- * @throws Exception if there are failures while modifying the entry
+ * @throws LdapException if there are failures while modifying the entry
*/
void modify( Dn dn, List<Modification> mods, LogChange log ) throws LdapException;
@@ -447,7 +461,7 @@ public interface CoreSession
* @param dn the distinguished name of the entry to modify
* @param ignoreReferral a flag to tell the server to ignore referrals
* @param mods the list of modifications to apply
- * @throws Exception if there are failures while modifying the entry
+ * @throws LdapException if there are failures while modifying the entry
*/
void modify( Dn dn, List<Modification> mods, boolean ignoreReferral ) throws LdapException;
@@ -462,7 +476,7 @@ public interface CoreSession
* @param ignoreReferral a flag to tell the server to ignore referrals
* @param mods the list of modifications to apply
* @param log a flag set if the added entry should be stored in the changeLog
- * @throws Exception if there are failures while modifying the entry
+ * @throws LdapException if there are failures while modifying the entry
*/
void modify( Dn dn, List<Modification> mods, boolean ignoreReferral, LogChange log ) throws LdapException;
@@ -479,7 +493,7 @@ public interface CoreSession
*
* @param dn the distinguished name of the entry/branch to move
* @param newParent the new parent under which the entry/branch is moved
- * @exception if there are failures while moving the entry/branch
+ * @exception LdapException if there are failures while moving the entry/branch
*/
void move( Dn dn, Dn newParent ) throws LdapException;
@@ -491,7 +505,7 @@ public interface CoreSession
* @param dn the distinguished name of the entry/branch to move
* @param newParent the new parent under which the entry/branch is moved
* @param log a flag set if the added entry should be stored in the changeLog
- * @exception if there are failures while moving the entry/branch
+ * @exception LdapException if there are failures while moving the entry/branch
*/
void move( Dn dn, Dn newParent, LogChange log ) throws LdapException;
@@ -503,7 +517,7 @@ public interface CoreSession
* @param dn the distinguished name of the entry/branch to move
* @param newParent the new parent under which the entry/branch is moved
* @param ignoreReferral a flag to tell the server to ignore referrals
- * @exception if there are failures while moving the entry/branch
+ * @exception LdapException if there are failures while moving the entry/branch
*/
void move( Dn dn, Dn newParent, boolean ignoreReferral ) throws Exception;
@@ -516,7 +530,7 @@ public interface CoreSession
* @param newParent the new parent under which the entry/branch is moved
* @param ignoreReferral a flag to tell the server to ignore referrals
* @param log a flag set if the added entry should be stored in the changeLog
- * @exception if there are failures while moving the entry/branch
+ * @exception LdapException if there are failures while moving the entry/branch
*/
void move( Dn dn, Dn newParent, boolean ignoreReferral, LogChange log ) throws LdapException;
@@ -525,7 +539,7 @@ public interface CoreSession
* Move an entry by changing its superior.
*
* @param modifyDnRequest The ModifyDN request
- * @throws Exception if there are failures while moving the entry/branch
+ * @throws LdapException if there are failures while moving the entry/branch
*/
void move( ModifyDnRequest modifyDnRequest ) throws LdapException;
@@ -535,7 +549,7 @@ public interface CoreSession
*
* @param modifyDnRequest The ModifyDN request
* @param log a flag set if the added entry should be stored in the changeLog
- * @throws Exception if there are failures while moving the entry/branch
+ * @throws LdapException if there are failures while moving the entry/branch
*/
void move( ModifyDnRequest modifyDnRequest, LogChange log ) throws LdapException;
@@ -549,7 +563,8 @@ public interface CoreSession
* @param newParent the new parent under which the entry/branch is moved
* @param newRdn the new relative distinguished name of the entry at the
* root of the branch
- * @exception if there are failures while moving and renaming the entry
+ * @param deleteOldRdn If the old Rdn must be deleted
+ * @exception LdapException if there are failures while moving and renaming the entry
* or branch
*/
void moveAndRename( Dn dn, Dn newParent, Rdn newRdn, boolean deleteOldRdn ) throws LdapException;
@@ -564,8 +579,9 @@ public interface CoreSession
* @param newParent the new parent under which the entry/branch is moved
* @param newRdn the new relative distinguished name of the entry at the
* root of the branch
+ * @param deleteOldRdn If the old Rdn must be deleted
* @param log a flag set if the added entry should be stored in the changeLog
- * @exception if there are failures while moving and renaming the entry
+ * @exception LdapException if there are failures while moving and renaming the entry
* or branch
*/
void moveAndRename( Dn dn, Dn newParent, Rdn newRdn, boolean deleteOldRdn, LogChange log ) throws LdapException;
@@ -580,8 +596,9 @@ public interface CoreSession
* @param newParent the new parent under which the entry/branch is moved
* @param newRdn the new relative distinguished name of the entry at the
* root of the branch
+ * @param deleteOldRdn If the old Rdn must be deleted
* @param ignoreReferral a flag to tell the server to ignore referrals
- * @exception if there are failures while moving and renaming the entry
+ * @exception LdapException if there are failures while moving and renaming the entry
* or branch
*/
void moveAndRename( Dn dn, Dn newParent, Rdn newRdn, boolean deleteOldRdn, boolean ignoreReferral )
@@ -597,9 +614,10 @@ public interface CoreSession
* @param newParent the new parent under which the entry/branch is moved
* @param newRdn the new relative distinguished name of the entry at the
* root of the branch
+ * @param deleteOldRdn If the old Rdn must be deleted
* @param ignoreReferral a flag to tell the server to ignore referrals
* @param log a flag set if the added entry should be stored in the changeLog
- * @exception if there are failures while moving and renaming the entry
+ * @exception LdapException if there are failures while moving and renaming the entry
* or branch
*/
void moveAndRename( Dn dn, Dn newParent, Rdn newRdn, boolean deleteOldRdn, boolean ignoreReferral, LogChange log )
@@ -610,7 +628,7 @@ public interface CoreSession
* Move and rename an entry. We change the Rdn and the superior.
*
* @param modifyDnRequest The move and rename request
- * @throws Exception if there are failures while moving and renaming the entry
+ * @throws LdapException if there are failures while moving and renaming the entry
* or branch
*/
void moveAndRename( ModifyDnRequest modifyDnRequest ) throws LdapException;
@@ -621,7 +639,7 @@ public interface CoreSession
*
* @param modifyDnRequest The move and rename request
* @param log a flag set if the added entry should be stored in the changeLog
- * @throws Exception if there are failures while moving and renaming the entry
+ * @throws LdapException if there are failures while moving and renaming the entry
* or branch
*/
void moveAndRename( ModifyDnRequest modifyDnRequest, LogChange log ) throws LdapException;
@@ -637,7 +655,7 @@ public interface CoreSession
* @param newRdn the new relative distinguished name for the entry
* @param deleteOldRdn whether or not the old value for the relative
* distinguished name is to be deleted from the entry
- * @throws Exception if there are failures while renaming the entry
+ * @throws LdapException if there are failures while renaming the entry
*/
void rename( Dn dn, Rdn newRdn, boolean deleteOldRdn ) throws LdapException;
@@ -653,7 +671,7 @@ public interface CoreSession
* @param deleteOldRdn whether or not the old value for the relative
* distinguished name is to be deleted from the entry
* @param log a flag set if the added entry should be stored in the changeLog
- * @throws Exception if there are failures while renaming the entry
+ * @throws LdapException if there are failures while renaming the entry
*/
void rename( Dn dn, Rdn newRdn, boolean deleteOldRdn, LogChange log ) throws LdapException;
@@ -669,7 +687,7 @@ public interface CoreSession
* @param deleteOldRdn whether or not the old value for the relative
* distinguished name is to be deleted from the entry
* @param ignoreReferral a flag to tell the server to ignore referrals
- * @throws Exception if there are failures while renaming the entry
+ * @throws LdapException if there are failures while renaming the entry
*/
void rename( Dn dn, Rdn newRdn, boolean deleteOldRdn, boolean ignoreReferral ) throws LdapException;
@@ -686,7 +704,7 @@ public interface CoreSession
* distinguished name is to be deleted from the entry
* @param ignoreReferral a flag to tell the server to ignore referrals
* @param log a flag set if the added entry should be stored in the changeLog
- * @throws Exception if there are failures while renaming the entry
+ * @throws LdapException if there are failures while renaming the entry
*/
void rename( Dn dn, Rdn newRdn, boolean deleteOldRdn, boolean ignoreReferral, LogChange log ) throws LdapException;
@@ -695,7 +713,7 @@ public interface CoreSession
* Rename an entry applying the ModifyDN request
*
* @param modifyDnRequest The requested modification
- * @throws Exception if there are failures while renaming the entry
+ * @throws LdapException if there are failures while renaming the entry
*/
void rename( ModifyDnRequest modifyDnRequest ) throws LdapException;
@@ -705,7 +723,7 @@ public interface CoreSession
*
* @param modifyDnRequest The requested modification
* @param log a flag set if the added entry should be stored in the changeLog
- * @throws Exception if there are failures while renaming the entry
+ * @throws LdapException if there are failures while renaming the entry
*/
void rename( ModifyDnRequest modifyDnRequest, LogChange log ) throws LdapException;
@@ -719,7 +737,8 @@ public interface CoreSession
* @param dn the distinguished name of the entry to list the children of
* @param aliasDerefMode the alias dereferencing mode used
* @param returningAttributes the attributes to return
- * @throws Exception if there are failures while listing children
+ * @return A cursor to brows the search results
+ * @throws LdapException if there are failures while listing children
*/
Cursor<Entry> list( Dn dn, AliasDerefMode aliasDerefMode,
String... returningAttributes ) throws LdapException;
@@ -732,7 +751,8 @@ public interface CoreSession
*
* @param dn the distinguished name of the entry to list the children of
* @param filter the search filter
- * @throws Exception if there are failures while listing children
+ * @return A cursor to brows the search results
+ * @throws LdapException if there are failures while listing children
*/
Cursor<Entry> search( Dn dn, String filter ) throws LdapException;
@@ -745,7 +765,8 @@ public interface CoreSession
* @param dn the distinguished name of the entry to list the children of
* @param filter the search filter
* @param ignoreReferrals a flag to tell the server to ignore referrals
- * @throws Exception if there are failures while listing children
+ * @return A cursor to brows the search results
+ * @throws LdapException if there are failures while listing children
*/
Cursor<Entry> search( Dn dn, String filter, boolean ignoreReferrals ) throws LdapException;
@@ -758,7 +779,8 @@ public interface CoreSession
* @param filter the search filter
* @param aliasDerefMode the alias dereferencing mode used
* @param returningAttributes the attributes to return
- * @throws Exception if there are failures while listing children
+ * @return A cursor to brows the search results
+ * @throws LdapException if there are failures while listing children
*/
Cursor<Entry> search( Dn dn, SearchScope scope, ExprNode filter, AliasDerefMode aliasDerefMode,
String... returningAttributes ) throws LdapException;
@@ -796,7 +818,7 @@ public interface CoreSession
* extended operation only as specified in section #8.1.2.2 of the password policy
* <a href="http://tools.ietf.org/id/draft-behera-ldap-password-policy-10.txt">spec</a>
*
- * @param pwdMustChange
+ * @param pwdMustChange If the password must change or not
*/
void setPwdMustChange( boolean pwdMustChange );
}
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/DirectoryService.java b/core-api/src/main/java/org/apache/directory/server/core/api/DirectoryService.java
index 209c00e..e7eafd9 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/DirectoryService.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/DirectoryService.java
@@ -49,10 +49,10 @@ import org.apache.directory.server.core.api.subtree.SubtreeEvaluator;
/**
- * Provides JNDI service to {@link AbstractContextFactory}.
+ * All the features a DirectroyService instance must implement. This gives a control
+ * of the Directory based server.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
- * @param <PasswordPolicyConfiguration>
*/
public interface DirectoryService extends ServerEntryFactory
{
@@ -68,11 +68,7 @@ public interface DirectoryService extends ServerEntryFactory
* @param revision the revision number to revert to
* @return the new revision reached by applying all changes needed to revert to the
* original state
- * @throws Exception if there are problems reverting back to the earlier state
- * @throws IllegalArgumentException if the revision provided is greater than the current
- * revision or less than 0
- * @throws UnsupportedOperationException if this feature is not supported by the
- * change log
+ * @throws LdapException if there are problems reverting back to the earlier state
*/
long revert( long revision ) throws LdapException;
@@ -87,9 +83,7 @@ public interface DirectoryService extends ServerEntryFactory
* @return the new revision reached by applying all changes needed to revert
* to the new state or the same version before this call if no revert actually
* took place
- * @throws Exception if there are problems reverting back to the earlier state
- * @throws UnsupportedOperationException if this feature is not supported by the
- * change log
+ * @throws LdapException if there are problems reverting back to the earlier state
*/
long revert() throws LdapException;
@@ -97,10 +91,10 @@ public interface DirectoryService extends ServerEntryFactory
PartitionNexus getPartitionNexus();
- void addPartition( Partition partition ) throws Exception;
+ void addPartition( Partition partition ) throws LdapException;
- void removePartition( Partition partition ) throws Exception;
+ void removePartition( Partition partition ) throws LdapException;
/**
@@ -146,6 +140,7 @@ public interface DirectoryService extends ServerEntryFactory
/**
+ * @param eventService The {@link EventService} instance
*/
void setEventService( EventService eventService );
@@ -153,24 +148,24 @@ public interface DirectoryService extends ServerEntryFactory
/**
* Starts up this service.
*
- * @throws Exception if failed to start up
+ * @throws LdapException if failed to start up
*/
- void startup() throws Exception;
+ void startup() throws LdapException;
/**
* Shuts down this service.
*
- * @throws Exception if failed to shut down
+ * @throws LdapException if failed to shut down
*/
- void shutdown() throws Exception;
+ void shutdown() throws LdapException;
/**
* Calls {@link Partition#sync()} for all registered {@link Partition}s.
- * @throws Exception if synchronization failed
+ * @throws LdapException if synchronization failed
*/
- void sync() throws Exception;
+ void sync() throws LdapException;
/**
@@ -204,8 +199,9 @@ public interface DirectoryService extends ServerEntryFactory
* propagating a bind operation into the core.
*
* @return a logical session as the anonymous user
+ * @throws LdapException If we weren't able to get the session
*/
- CoreSession getSession() throws Exception;
+ CoreSession getSession() throws LdapException;
/**
@@ -213,9 +209,11 @@ public interface DirectoryService extends ServerEntryFactory
* as a specific user. This bypasses authentication without propagating
* a bind operation into the core.
*
+ * @param principal The Principal
* @return a logical session as a specific user
+ * @throws LdapException If we weren't able to get the session
*/
- CoreSession getSession( LdapPrincipal principal ) throws Exception;
+ CoreSession getSession( LdapPrincipal principal ) throws LdapException;
/**
@@ -224,7 +222,10 @@ public interface DirectoryService extends ServerEntryFactory
* bypasses authentication without propagating a bind operation into the
* core.
*
+ * @param principalDn The principal Dn
+ * @param credentials The principal credentials
* @return a logical session as a specific user
+ * @throws LdapException If we weren't able to get the session
*/
CoreSession getSession( Dn principalDn, byte[] credentials ) throws LdapException;
@@ -235,17 +236,28 @@ public interface DirectoryService extends ServerEntryFactory
* bypasses authentication without propagating a bind operation into the
* core.
*
+ * @param principalDn The principal Dn
+ * @param credentials The principal credentials
+ * @param saslMechanism The SASL mechanisms
+ * @param saslAuthId The SASL authorization ID
* @return a logical session as a specific user
+ * @throws LdapException If we weren't able to get the session
*/
CoreSession getSession( Dn principalDn, byte[] credentials, String saslMechanism, String saslAuthId )
- throws Exception;
+ throws LdapException;
/**
+ * Set the instance Identifier
+ *
+ * @param instanceId The instance identifier
*/
void setInstanceId( String instanceId );
+ /**
+ * @return The instance identifier
+ */
String getInstanceId();
@@ -330,6 +342,7 @@ public interface DirectoryService extends ServerEntryFactory
/**
* Returns interceptors in the server.
*
+ * @param operation The operation that the interceptors must implement
* @return the interceptors in the server.
*/
List<String> getInterceptors( OperationEnum operation );
@@ -345,20 +358,25 @@ public interface DirectoryService extends ServerEntryFactory
/**
* Add an interceptor in the first position in the interceptor list.
+ *
* @param interceptor The added interceptor
+ * @throws LdapException If the interceptor can't be added
*/
void addFirst( Interceptor interceptor ) throws LdapException;
/**
* Add an interceptor in the last position in the interceptor list.
+ *
* @param interceptor The added interceptor
+ * @throws LdapException If the interceptor can't be added
*/
void addLast( Interceptor interceptor ) throws LdapException;
/**
* Add an interceptor after a given interceptor in the interceptor list.
+ *
* @param interceptorName The interceptor name to find
* @param interceptor The added interceptor
*/
@@ -390,8 +408,7 @@ public interface DirectoryService extends ServerEntryFactory
/**
- * Sets test directory entries({@link Attributes}) to be loaded while
- * bootstrapping.
+ * Sets test directory entries to be loaded while bootstrapping.
*
* @param testEntries the test entries to load while bootstrapping
*/
@@ -485,12 +502,15 @@ public interface DirectoryService extends ServerEntryFactory
*
* @param ldif the String representing the attributes, in LDIF format
* @param dn the Dn for this new entry
+ * @return The new Entry instance
*/
Entry newEntry( String ldif, String dn );
/**
* Gets the operation manager.
+ *
+ * @return the OperationManager instance
*/
OperationManager getOperationManager();
@@ -604,6 +624,8 @@ public interface DirectoryService extends ServerEntryFactory
/**
* Sets the Dn factory.
+ *
+ * @param dnFactory The Dn factory to use
*/
void setDnFactory( DnFactory dnFactory );
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/ObjectClassProvider.java b/core-api/src/main/java/org/apache/directory/server/core/api/ObjectClassProvider.java
index 30457a1..5203e7a 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/ObjectClassProvider.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/ObjectClassProvider.java
@@ -19,6 +19,7 @@
package org.apache.directory.server.core.api;
+import org.apache.directory.api.ldap.model.schema.ObjectClass;
import org.apache.directory.api.ldap.model.schema.SchemaManager;
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/ReferralHandlingMode.java b/core-api/src/main/java/org/apache/directory/server/core/api/ReferralHandlingMode.java
index 1f2f698..52f71e0 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/ReferralHandlingMode.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/ReferralHandlingMode.java
@@ -20,6 +20,8 @@
package org.apache.directory.server.core.api;
+import javax.naming.Context;
+
import org.apache.directory.api.util.Strings;
import org.apache.directory.server.i18n.I18n;
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/ReferralManager.java b/core-api/src/main/java/org/apache/directory/server/core/api/ReferralManager.java
index 765dc4c..5aad840 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/ReferralManager.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/ReferralManager.java
@@ -91,7 +91,7 @@ public interface ReferralManager
/**
* Add a referral to the manager.
*
- * @param dn The referral to add
+ * @param entry The referral to add
*/
void addReferral( Entry entry );
@@ -99,7 +99,8 @@ public interface ReferralManager
/**
* Remove a referral from the manager.
*
- * @param dn The referral to remove
+ * @param entry The referral to remove
+ * @throws LdapException If the referal can't be removed
*/
void removeReferral( Entry entry ) throws LdapException;
@@ -110,7 +111,7 @@ public interface ReferralManager
*
* @param directoryService The associated LDAP service
* @param suffixes The partition list
- * @exception If the initialization failed
+ * @exception Exception If the initialization failed
*/
void init( DirectoryService directoryService, String... suffixes ) throws Exception;
@@ -122,7 +123,7 @@ public interface ReferralManager
*
* @param directoryService The associated LDAP service
* @param suffixes The partition Dn to remove
- * @exception If the removal failed
+ * @exception Exception If the removal failed
*/
void remove( DirectoryService directoryService, Dn suffixes ) throws Exception;
}
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/SearchRequestContainer.java b/core-api/src/main/java/org/apache/directory/server/core/api/SearchRequestContainer.java
index 40b4054..8519488 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/SearchRequestContainer.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/SearchRequestContainer.java
@@ -26,7 +26,7 @@ import org.apache.directory.api.ldap.model.message.SearchRequest;
/**
* A container storing a SearchRequest being processed, and the associated
* size and time limit.
- * <br/>
+ * <br>
* We use an instance of this class for each new searchRequest, and we discard
* it when the SearchRequest is completed or abandonned.
*
@@ -57,8 +57,7 @@ public class SearchRequestContainer
* Create an instance of the container with the SearchRequest and its limit.
*
* @param searchRequest The SearchRequest instance
- * @param sizeLimit The size limit
- * @param timeLimit The time limit
+ * @param cursor The cursor to process
*/
public SearchRequestContainer( SearchRequest searchRequest, Cursor<Entry> cursor )
{
@@ -112,7 +111,7 @@ public class SearchRequestContainer
/**
- * @param count the count to set
+ * Increment the count
*/
public void increment()
{
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/administrative/AdministrativePoint.java b/core-api/src/main/java/org/apache/directory/server/core/api/administrative/AdministrativePoint.java
index 24d9213..1da17e9 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/administrative/AdministrativePoint.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/administrative/AdministrativePoint.java
@@ -27,12 +27,12 @@ import org.apache.directory.api.ldap.model.subtree.AdministrativeRole;
/**
* An interface used to describe an AdministrativePoint. An AdministrativePoint
* holds some elements useful to navigate through the administrative model :
- * <li>
- * <ul>The Dn : the AP position in the DIT</ul>
- * <ul>The UUID : The AP unique identifier used when an entry point to the AP it depends on</ul>
- * <ul>The role : the AP role</ul>
- * <ul>The parent : the AP this AP is the direct descendant of</ul>
- * </li>
+ * <ul>
+ * <li>The Dn : the AP position in the DIT</li>
+ * <li>The UUID : The AP unique identifier used when an entry point to the AP it depends on</li>
+ * <li>The role : the AP role</li>
+ * <li>The parent : the AP this AP is the direct descendant of</li>
+ * </ul>
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public interface AdministrativePoint
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/authn/ppolicy/CheckQualityEnum.java b/core-api/src/main/java/org/apache/directory/server/core/api/authn/ppolicy/CheckQualityEnum.java
index 9fd2de4..3dbbdb6 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/authn/ppolicy/CheckQualityEnum.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/authn/ppolicy/CheckQualityEnum.java
@@ -22,7 +22,7 @@ package org.apache.directory.server.core.api.authn.ppolicy;
/**
- * The 3 possible values for the password check quality : </br>
+ * The 3 possible values for the password check quality : <br>
* <ul>
* <li>NO_CHECK (0) : No check will be done</li>
* <li>CHECK_ACCEPT (1) : Check the password and accept hashed passwords</li>
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLog.java b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLog.java
index d8a81eb..93ad827 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLog.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLog.java
@@ -69,7 +69,7 @@ public interface ChangeLog
* Gets the current revision for the server.
*
* @return the current revision
- * @throws Exception if there is a problem accessing this information
+ * @throws LdapException if there is a problem accessing this information
*/
long getCurrentRevision() throws LdapException;
@@ -82,7 +82,7 @@ public interface ChangeLog
* @param forward LDIF of the change going to the next state
* @param reverse LDIF (anti-operation): the change required to revert this change
* @return the new revision reached after having applied the forward LDIF
- * @throws Exception if there are problems logging the change
+ * @throws LdapException if there are problems logging the change
*/
ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, LdifEntry reverse ) throws LdapException;
@@ -95,7 +95,7 @@ public interface ChangeLog
* @param forward LDIF of the change going to the next state
* @param reverses LDIF (anti-operation): the changes required to revert this change
* @return the new revision reached after having applied the forward LDIF
- * @throws Exception if there are problems logging the change
+ * @throws LdapException if there are problems logging the change
*/
ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, List<LdifEntry> reverses ) throws LdapException;
@@ -199,7 +199,7 @@ public interface ChangeLog
/**
* @return The latest tag
- * @throws Exception if there is a problem taking the latest tag
+ * @throws LdapException if there is a problem taking the latest tag
*/
Tag getLatest() throws LdapException;
@@ -208,23 +208,23 @@ public interface ChangeLog
* Initialize the ChangeLog system.
*
* @param service The associated DirectoryService
- * @throws Exception
+ * @throws LdapException If the initialization failed
*/
- void init( DirectoryService service ) throws Exception;
+ void init( DirectoryService service ) throws LdapException;
/**
* Flush the changes to disk
- * @throws Exception If the flush failed
+ * @throws LdapException If the flush failed
*/
- void sync() throws Exception;
+ void sync() throws LdapException;
/**
* Destroy the changeLog
- * @throws Exception
+ * @throws LdapException
*/
- void destroy() throws Exception;
+ void destroy() throws LdapException;
/**
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogStore.java b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogStore.java
index 1ffc342..8153727 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogStore.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogStore.java
@@ -41,9 +41,9 @@ public interface ChangeLogStore
* Initialize the store.
*
* @param service The associated DirectoryService
- * @throws Exception If the initialization failed
+ * @throws LdapException If the initialization failed
*/
- void init( DirectoryService service ) throws Exception;
+ void init( DirectoryService service ) throws LdapException;
/**
@@ -51,15 +51,15 @@ public interface ChangeLogStore
*
* @throws Exception If the write failed
*/
- void sync() throws Exception;
+ void sync() throws LdapException;
/**
* Destroy the logs.
*
- * @throws Exception If we can't destroy the logs
+ * @throws LdapException If we can't destroy the logs
*/
- void destroy() throws Exception;
+ void destroy() throws LdapException;
/**
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/journal/Journal.java b/core-api/src/main/java/org/apache/directory/server/core/api/journal/Journal.java
index 5f3b135..9e131ce 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/journal/Journal.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/journal/Journal.java
@@ -92,16 +92,16 @@ public interface Journal
* Initialize the Journal.
*
* @param service The associated DirectoryService
- * @throws Exception If something went wrong
+ * @throws LdapException If something went wrong
*/
- void init( DirectoryService service ) throws Exception;
+ void init( DirectoryService service ) throws LdapException;
/**
* Destroy the journal service
- * @throws Exception If something went wrong
+ * @throws LdapException If something went wrong
*/
- void destroy() throws Exception;
+ void destroy() throws LdapException;
/**
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/journal/JournalStore.java b/core-api/src/main/java/org/apache/directory/server/core/api/journal/JournalStore.java
index 90de90f..692c3d5 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/journal/JournalStore.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/journal/JournalStore.java
@@ -20,6 +20,8 @@
package org.apache.directory.server.core.api.journal;
+import java.io.IOException;
+
import org.apache.directory.api.ldap.model.ldif.LdifEntry;
import org.apache.directory.server.core.api.DirectoryService;
import org.apache.directory.server.core.api.LdapPrincipal;
@@ -37,25 +39,25 @@ public interface JournalStore
* Initialize the store.
*
* @param service The associated DirectoryService
- * @throws Exception If the initialization failed
+ * @throws IOException If the initialization failed
*/
- void init( DirectoryService service ) throws Exception;
+ void init( DirectoryService service ) throws IOException;
/**
* Write the changes on disk
*
- * @throws Exception If the write failed
+ * @throws IOException If the write failed
*/
- void sync() throws Exception;
+ void sync() throws IOException;
/**
* Destroy the logs.
*
- * @throws Exception If we can't destroy the logs
+ * @throws IOException If we can't destroy the logs
*/
- void destroy() throws Exception;
+ void destroy() throws IOException;
/**
diff --git a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirStateFactory.java b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirStateFactory.java
index dec5c1c..d74b93b 100644
--- a/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirStateFactory.java
+++ b/core-jndi/src/main/java/org/apache/directory/server/core/jndi/ServerDirStateFactory.java
@@ -32,7 +32,7 @@ import javax.naming.spi.DirStateFactory;
* to try all state factories to produce an object. Our provider looks up
* the most specific state factories based on additional information. This
* makes a huge difference when the number of StateFactories becomes large.
- * <br/>
+ * <br>
* Eventually, it is highly feasible for generated schemas, to also include
* state and object factories for various objectClasses. This means the number
* of factories will increase. By associating object and state factories with
diff --git a/core-shared/src/main/java/org/apache/directory/server/core/shared/partition/DefaultPartitionNexus.java b/core-shared/src/main/java/org/apache/directory/server/core/shared/partition/DefaultPartitionNexus.java
index f179f48..6b2db0f 100644
--- a/core-shared/src/main/java/org/apache/directory/server/core/shared/partition/DefaultPartitionNexus.java
+++ b/core-shared/src/main/java/org/apache/directory/server/core/shared/partition/DefaultPartitionNexus.java
@@ -137,9 +137,9 @@ public class DefaultPartitionNexus extends AbstractPartition implements Partitio
*
* @see <a href="http://www.faqs.org/rfcs/rfc3045.html">Vendor Information</a>
* @param rootDse the root entry for the DSA
- * @throws javax.naming.Exception on failure to initialize
+ * @throws LdapException on failure to initialize
*/
- public DefaultPartitionNexus( Entry rootDse ) throws Exception
+ public DefaultPartitionNexus( Entry rootDse ) throws LdapException
{
id = NEXUS_ID;
suffixDn = null;
diff --git a/core/src/main/java/org/apache/directory/server/core/DefaultDirectoryService.java b/core/src/main/java/org/apache/directory/server/core/DefaultDirectoryService.java
index d45ba60..6388e9c 100644
--- a/core/src/main/java/org/apache/directory/server/core/DefaultDirectoryService.java
+++ b/core/src/main/java/org/apache/directory/server/core/DefaultDirectoryService.java
@@ -880,7 +880,10 @@ public class DefaultDirectoryService implements DirectoryService
}
- public void addPartition( Partition partition ) throws Exception
+ /**
+ * {@inheritDoc}
+ */
+ public void addPartition( Partition partition ) throws LdapException
{
partition.setSchemaManager( schemaManager );
@@ -903,7 +906,10 @@ public class DefaultDirectoryService implements DirectoryService
}
- public void removePartition( Partition partition ) throws Exception
+ /**
+ * {@inheritDoc}
+ */
+ public void removePartition( Partition partition ) throws LdapException
{
// Do the backend cleanup first
try
@@ -1018,7 +1024,7 @@ public class DefaultDirectoryService implements DirectoryService
* Get back a session for a given user bound with SASL Bind
*/
public CoreSession getSession( Dn principalDn, byte[] credentials, String saslMechanism, String saslAuthId )
- throws Exception
+ throws LdapException
{
synchronized ( this )
{
@@ -1233,7 +1239,7 @@ public class DefaultDirectoryService implements DirectoryService
/**
* @throws Exception if the LDAP server cannot be started
*/
- public synchronized void startup() throws Exception
+ public synchronized void startup() throws LdapException
{
if ( started )
{
@@ -1280,7 +1286,7 @@ public class DefaultDirectoryService implements DirectoryService
}
- public synchronized void sync() throws Exception
+ public synchronized void sync() throws LdapException
{
if ( !started )
{
@@ -1292,7 +1298,7 @@ public class DefaultDirectoryService implements DirectoryService
}
- public synchronized void shutdown() throws Exception
+ public synchronized void shutdown() throws LdapException
{
LOG.debug( "+++ DirectoryService Shutdown required" );
@@ -1510,9 +1516,9 @@ public class DefaultDirectoryService implements DirectoryService
* had to be created, then we are not starting for the first time.
*
* @return true if the bootstrap entries had to be created, false otherwise
- * @throws Exception if entries cannot be created
+ * @throws LdapException if entries cannot be created
*/
- private boolean createBootstrapEntries() throws Exception
+ private boolean createBootstrapEntries() throws LdapException, IOException
{
boolean firstStart = false;
@@ -1822,10 +1828,10 @@ public class DefaultDirectoryService implements DirectoryService
/**
* Displays security warning messages if any possible secutiry issue is found.
- * @throws Exception if there are failures parsing and accessing internal structures
+ * @throws LdapException if there are failures parsing and accessing internal structures
*/
// made protected as per the request in DIRSERVER-1920
- protected void showSecurityWarnings() throws Exception
+ protected void showSecurityWarnings() throws LdapException
{
// Warn if the default password is not changed.
boolean needToChangeAdminPassword;
@@ -1863,9 +1869,9 @@ public class DefaultDirectoryService implements DirectoryService
*
* @todo this may no longer be needed when JNDI is not used for bootstrapping
*
- * @throws Exception if the creation of test entries fails.
+ * @throws LdapException if the creation of test entries fails.
*/
- private void createTestEntries() throws Exception
+ private void createTestEntries() throws LdapException
{
for ( LdifEntry testEntry : testEntries )
{
@@ -1892,7 +1898,7 @@ public class DefaultDirectoryService implements DirectoryService
}
- private void initializeSystemPartition() throws Exception
+ private void initializeSystemPartition() throws LdapException, IOException
{
Partition system = getSystemPartition();
@@ -1971,9 +1977,9 @@ public class DefaultDirectoryService implements DirectoryService
/**
* Kicks off the initialization of the entire system.
*
- * @throws Exception if there are problems along the way
+ * @throws LdapException if there are problems along the way
*/
- private void initialize() throws Exception
+ private void initialize() throws LdapException
{
if ( LOG.isDebugEnabled() )
{
@@ -2027,13 +2033,27 @@ public class DefaultDirectoryService implements DirectoryService
partitionNexus.setDirectoryService( this );
partitionNexus.initialize();
- initializeSystemPartition();
+ try
+ {
+ initializeSystemPartition();
+ }
+ catch ( IOException ioe )
+ {
+ throw new LdapException( ioe.getMessage(), ioe );
+ }
// --------------------------------------------------------------------
// Create all the bootstrap entries before initializing chain
// --------------------------------------------------------------------
- firstStart = createBootstrapEntries();
+ try
+ {
+ firstStart = createBootstrapEntries();
+ }
+ catch ( IOException ioe )
+ {
+ throw new LdapException( ioe.getMessage(), ioe );
+ }
// initialize schema providers
atProvider = new AttributeTypeProvider( schemaManager );
diff --git a/interceptors/admin/src/main/java/org/apache/directory/server/core/admin/AdministrativePointInterceptor.java b/interceptors/admin/src/main/java/org/apache/directory/server/core/admin/AdministrativePointInterceptor.java
index b0b5f08..b6d459d 100644
--- a/interceptors/admin/src/main/java/org/apache/directory/server/core/admin/AdministrativePointInterceptor.java
+++ b/interceptors/admin/src/main/java/org/apache/directory/server/core/admin/AdministrativePointInterceptor.java
@@ -1129,7 +1129,7 @@ public class AdministrativePointInterceptor extends BaseInterceptor
// Interceptor initialization
//-------------------------------------------------------------------------------------------
/**
- * Registers and initializes all {@link Authenticator}s to this service.
+ * Registers and initializes all AdministrativePoints to this service.
*/
@Override
public void init( DirectoryService directoryService ) throws LdapException
@@ -1174,8 +1174,9 @@ public class AdministrativePointInterceptor extends BaseInterceptor
* <ul>
* <li>If it's an AA, then the added role should be the only one</li>
* <li>It's not possible to add IA and SA at the same time</li>
- * @param addContext The {@link AddOperationContext} instance
+ * </ul>
*
+ * @param addContext The {@link AddOperationContext} instance
* @throws LdapException If we had some error while processing the Add operation
*/
@Override
@@ -1232,7 +1233,7 @@ public class AdministrativePointInterceptor extends BaseInterceptor
/**
- * We have to check that we can remove the associated AdministrativePoint : <br/>
+ * We have to check that we can remove the associated AdministrativePoint : <br>
* <ul>
* <li> if we remove an AAP, no descendant IAP should remain orphan</li>
* <li> If we remove a SAP, no descendant IAP should remain orphan</li>
diff --git a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/AnonymousAuthenticator.java b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/AnonymousAuthenticator.java
index bca1752..a681412 100644
--- a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/AnonymousAuthenticator.java
+++ b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/AnonymousAuthenticator.java
@@ -50,6 +50,8 @@ public class AnonymousAuthenticator extends AbstractAuthenticator
/**
* Creates a new instance.
+ *
+ * @param baseDn The base Dn
*/
public AnonymousAuthenticator( Dn baseDn )
{
diff --git a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/AuthenticationInterceptor.java b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/AuthenticationInterceptor.java
index 3f17125..d9290bf 100644
--- a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/AuthenticationInterceptor.java
+++ b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/AuthenticationInterceptor.java
@@ -85,6 +85,7 @@ import org.apache.directory.server.core.api.authn.ppolicy.PasswordPolicyExceptio
import org.apache.directory.server.core.api.authn.ppolicy.PasswordValidator;
import org.apache.directory.server.core.api.filtering.EntryFilteringCursor;
import org.apache.directory.server.core.api.interceptor.BaseInterceptor;
+import org.apache.directory.server.core.api.interceptor.Interceptor;
import org.apache.directory.server.core.api.interceptor.context.AddOperationContext;
import org.apache.directory.server.core.api.interceptor.context.BindOperationContext;
import org.apache.directory.server.core.api.interceptor.context.CompareOperationContext;
@@ -1804,7 +1805,7 @@ public class AuthenticationInterceptor extends BaseInterceptor
*
* @param userEntry the user's entry
* @return the associated password policy
- * @throws LdapException
+ * @throws LdapException If we weren't able to ftech the password policy
*/
public PasswordPolicyConfiguration getPwdPolicy( Entry userEntry ) throws LdapException
{
diff --git a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/Authenticator.java b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/Authenticator.java
index 0d04ef2..6f28bc7 100644
--- a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/Authenticator.java
+++ b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/Authenticator.java
@@ -20,6 +20,8 @@
package org.apache.directory.server.core.authn;
+import javax.naming.Context;
+
import org.apache.directory.api.ldap.model.constants.AuthenticationLevel;
import org.apache.directory.api.ldap.model.entry.Entry;
import org.apache.directory.api.ldap.model.exception.LdapException;
@@ -27,6 +29,7 @@ import org.apache.directory.api.ldap.model.name.Dn;
import org.apache.directory.server.core.api.DirectoryService;
import org.apache.directory.server.core.api.LdapPrincipal;
import org.apache.directory.server.core.api.interceptor.context.BindOperationContext;
+import org.apache.directory.server.core.shared.partition.DefaultPartitionNexus;
/**
@@ -49,6 +52,8 @@ public interface Authenticator
/**
* Returns the type of this authenticator (e.g. <tt>'simple'</tt>,
* <tt>'none'</tt>,...).
+ *
+ * @return The authentication level
*/
AuthenticationLevel getAuthenticatorType();
@@ -56,6 +61,9 @@ public interface Authenticator
/**
* Called by {@link AuthenticationInterceptor} to indicate that this
* authenticator is being placed into service.
+ *
+ * @param directoryService The DirectoryService instance
+ * @throws LdapException If the initialization failed
*/
void init( DirectoryService directoryService ) throws LdapException;
@@ -82,16 +90,17 @@ public interface Authenticator
* Performs authentication and returns the principal if succeeded.
*
* @param bindContext The Bind context
- * @exception If the authentication failed
+ * @return The authenticated LdaapPrincipal
+ * @exception LdapException If the authentication failed
*/
- LdapPrincipal authenticate( BindOperationContext bindContext ) throws Exception;
+ LdapPrincipal authenticate( BindOperationContext bindContext ) throws LdapException;
/**
* performs checks on the given entry based on the specified password policy configuration
*
* @param userEntry the user entry to be checked for authentication
- * @throws PasswordPolicyException
+ * @throws LdapException If the password policy is incorrect
*/
void checkPwdPolicy( Entry userEntry ) throws LdapException;
diff --git a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/DelegatingAuthenticator.java b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/DelegatingAuthenticator.java
index ba9f123..4cb9b6b 100644
--- a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/DelegatingAuthenticator.java
+++ b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/DelegatingAuthenticator.java
@@ -20,6 +20,7 @@
package org.apache.directory.server.core.authn;
+import java.io.IOException;
import java.net.SocketAddress;
import org.apache.directory.api.ldap.model.constants.AuthenticationLevel;
@@ -78,6 +79,7 @@ public class DelegatingAuthenticator extends AbstractAuthenticator
/**
* Creates a new instance.
* @see AbstractAuthenticator
+ * @param baseDn The base Dn
*/
public DelegatingAuthenticator( Dn baseDn )
{
@@ -89,6 +91,7 @@ public class DelegatingAuthenticator extends AbstractAuthenticator
* Creates a new instance, for a specific authentication level.
* @see AbstractAuthenticator
* @param type The relevant AuthenticationLevel
+ * @param baseDn The base Dn
*/
protected DelegatingAuthenticator( AuthenticationLevel type, Dn baseDn )
{
@@ -218,7 +221,7 @@ public class DelegatingAuthenticator extends AbstractAuthenticator
*/
@Override
public LdapPrincipal authenticate( BindOperationContext bindContext )
- throws Exception
+ throws LdapException
{
LdapPrincipal principal = null;
@@ -319,7 +322,14 @@ public class DelegatingAuthenticator extends AbstractAuthenticator
}
finally
{
- ldapConnection.close();
+ try
+ {
+ ldapConnection.close();
+ }
+ catch ( IOException ioe )
+ {
+ throw new LdapException( ioe.getMessage(), ioe );
+ }
}
}
diff --git a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/PasswordHistory.java b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/PasswordHistory.java
index 8042b49..ed11d9d 100644
--- a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/PasswordHistory.java
+++ b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/PasswordHistory.java
@@ -77,6 +77,8 @@ public class PasswordHistory implements Comparable<PasswordHistory>
/**
* Create a new instance of PasswordHistory
*
+ * @param time The time we changed the password
+ * @param password The password to store
*/
public PasswordHistory( String time, byte[] password )
{
diff --git a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/SimpleAuthenticator.java b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/SimpleAuthenticator.java
index d6d0db5..d7f1e07 100644
--- a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/SimpleAuthenticator.java
+++ b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/SimpleAuthenticator.java
@@ -22,6 +22,8 @@ package org.apache.directory.server.core.authn;
import java.net.SocketAddress;
+import javax.naming.Context;
+
import org.apache.commons.collections.map.LRUMap;
import org.apache.directory.api.ldap.model.constants.AuthenticationLevel;
import org.apache.directory.api.ldap.model.constants.SchemaConstants;
@@ -94,6 +96,8 @@ public class SimpleAuthenticator extends AbstractAuthenticator
/**
* Creates a new instance.
* @see AbstractAuthenticator
+ *
+ * @param baseDn The base Dn
*/
public SimpleAuthenticator( Dn baseDn )
{
@@ -116,7 +120,9 @@ public class SimpleAuthenticator extends AbstractAuthenticator
/**
* Creates a new instance, with an initial cache size
+ *
* @param cacheSize the size of the credential cache
+ * @param baseDn The base Dn
*/
public SimpleAuthenticator( int cacheSize, Dn baseDn )
{
diff --git a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/StrongAuthenticator.java b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/StrongAuthenticator.java
index 2fa4b1b..324fc99 100644
--- a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/StrongAuthenticator.java
+++ b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/StrongAuthenticator.java
@@ -51,6 +51,8 @@ public class StrongAuthenticator extends AbstractAuthenticator
/**
* Creates a new instance of SaslAuthenticator.
+ *
+ * @param baseDn The base Dn
*/
public StrongAuthenticator( Dn baseDn )
{
diff --git a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/ppolicy/PpolicyConfigContainer.java b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/ppolicy/PpolicyConfigContainer.java
index b87638b..6b2396c 100644
--- a/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/ppolicy/PpolicyConfigContainer.java
+++ b/interceptors/authn/src/main/java/org/apache/directory/server/core/authn/ppolicy/PpolicyConfigContainer.java
@@ -73,7 +73,7 @@ public class PpolicyConfigContainer
* Get the password policy configuration defined at a given Dn
*
* @param configDn the Dn where password policy was configured
- * @return
+ * @return The found PasswordPolicyConfiguration instance
*/
public PasswordPolicyConfiguration getPolicyConfig( Dn configDn )
{
diff --git a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/AciAuthorizationInterceptor.java b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/AciAuthorizationInterceptor.java
index b676c76..344453b 100644
--- a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/AciAuthorizationInterceptor.java
+++ b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/AciAuthorizationInterceptor.java
@@ -280,7 +280,7 @@ public class AciAuthorizationInterceptor extends BaseInterceptor
* the tuple and group membership caches, the ACIItem parser and the ACDF engine.
*
* @param directoryService the directory service core
- * @throws Exception if there are problems during initialization
+ * @throws LdapException if there are problems during initialization
*/
@Override
public void init( DirectoryService directoryService ) throws LdapException
diff --git a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/DefaultAuthorizationInterceptor.java b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/DefaultAuthorizationInterceptor.java
index b47faeb..0f133f1 100644
--- a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/DefaultAuthorizationInterceptor.java
+++ b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/DefaultAuthorizationInterceptor.java
@@ -24,6 +24,8 @@ import java.io.IOException;
import java.util.HashSet;
import java.util.Set;
+import javax.naming.NoPermissionException;
+
import org.apache.directory.api.ldap.model.entry.Attribute;
import org.apache.directory.api.ldap.model.entry.Entry;
import org.apache.directory.api.ldap.model.entry.Value;
@@ -38,6 +40,7 @@ import org.apache.directory.server.core.api.InterceptorEnum;
import org.apache.directory.server.core.api.filtering.EntryFilter;
import org.apache.directory.server.core.api.filtering.EntryFilteringCursor;
import org.apache.directory.server.core.api.interceptor.BaseInterceptor;
+import org.apache.directory.server.core.api.interceptor.Interceptor;
import org.apache.directory.server.core.api.interceptor.context.DeleteOperationContext;
import org.apache.directory.server.core.api.interceptor.context.LookupOperationContext;
import org.apache.directory.server.core.api.interceptor.context.ModifyOperationContext;
@@ -49,6 +52,7 @@ import org.apache.directory.server.core.api.interceptor.context.SearchOperationC
import org.apache.directory.server.core.api.partition.Partition;
import org.apache.directory.server.core.api.partition.PartitionNexus;
import org.apache.directory.server.core.api.partition.PartitionTxn;
+import org.apache.directory.server.core.shared.partition.DefaultPartitionNexus;
import org.apache.directory.server.i18n.I18n;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
diff --git a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/GroupCache.java b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/GroupCache.java
index 540252e..615f82a 100644
--- a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/GroupCache.java
+++ b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/GroupCache.java
@@ -328,6 +328,7 @@ public class GroupCache
*
* @param name the normalized Dn of the group entry
* @param entry the attributes of entry being deleted
+ * @throws LdapException If we wasn't able to delete the entry from the cache
*/
public void groupDeleted( Dn name, Entry entry ) throws LdapException
{
@@ -393,6 +394,7 @@ public class GroupCache
* @param name the normalized name of the group entry modified
* @param mods the modification operations being performed
* @param entry the group entry being modified
+ * @param schemaManager The SchemaManager instance
* @throws LdapException if there are problems accessing attribute values
*/
public void groupModified( Dn name, List<Modification> mods, Entry entry, SchemaManager schemaManager )
@@ -511,7 +513,7 @@ public class GroupCache
* Gets the set of groups a user is a member of. The groups are returned
* as normalized Name objects within the set.
*
- * @param member the member (user) to get the groups for
+ * @param memberDn the member (user) to get the groups for
* @return a Set of Name objects representing the groups
* @throws LdapException if there are problems accessing attribute values
*/
diff --git a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/ACDFEngine.java b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/ACDFEngine.java
index fa6a572..da90a2a 100644
--- a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/ACDFEngine.java
+++ b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/ACDFEngine.java
@@ -40,7 +40,7 @@ import org.apache.directory.server.core.api.subtree.RefinementLeafEvaluator;
/**
* An implementation of Access Control Decision Function (18.8, X.501).
- * <br/>
+ * <br>
* This engine simply filters the collection of tuples using the following
* {@link ACITupleFilter}s sequentially:
* <ol>
@@ -54,7 +54,7 @@ import org.apache.directory.server.core.api.subtree.RefinementLeafEvaluator;
* <li>{@link MostSpecificUserClassFilter}</li>
* <li>{@link MostSpecificProtectedItemFilter}</li>
* </ol>
- * <br/>
+ * <br>
* Operation is determined to be permitted if and only if there is at least one
* tuple left and all of them grants the access. (18.8.4. X.501)
*
@@ -69,8 +69,6 @@ public class ACDFEngine
* Creates a new instance.
*
* @param schemaManager The server schemaManager
- *
- * @throws LdapException if failed to initialize internal components
*/
public ACDFEngine( SchemaManager schemaManager )
{
@@ -115,7 +113,8 @@ public class ACDFEngine
* if the user doesn't have any permission to perform the specified grants.
*
* @param aciContext the container for ACI items
- * @throws org.apache.directory.api.ldap.model.exception.LdapException if failed to evaluate ACI items
+ * @return <tt>true</tt> if the user has permission to access the resource
+ * @throws LdapException if failed to evaluate ACI items
*/
public boolean hasPermission( AciContext aciContext ) throws LdapException
{
diff --git a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/OperationScope.java b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/OperationScope.java
index b18b315..9d47f4b 100644
--- a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/OperationScope.java
+++ b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/OperationScope.java
@@ -52,7 +52,7 @@ public final class OperationScope
/**
- * Return the name of this scope.
+ * @return the name of this scope.
*/
public String getName()
{
diff --git a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/package-info.java b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/package-info.java
index 25c0e65..5a68e91 100644
--- a/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/package-info.java
+++ b/interceptors/authz/src/main/java/org/apache/directory/server/core/authz/support/package-info.java
@@ -20,9 +20,7 @@
/**
* <pre>
- * <p>
* ACDF (Access Control Decision Function) and its support classes.
- * </p>
* </pre>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
diff --git a/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/DefaultChangeLog.java b/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/DefaultChangeLog.java
index f354a6a..a6a7280 100644
--- a/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/DefaultChangeLog.java
+++ b/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/DefaultChangeLog.java
@@ -339,7 +339,7 @@ public long getCurrentRevision() throws LdapException
* Initialize the ChangeLog system. We will initialize the associated store.
*/
@Override
- public void init( DirectoryService service ) throws Exception
+ public void init( DirectoryService service ) throws LdapException
{
if ( enabled )
{
@@ -373,7 +373,7 @@ public long getCurrentRevision() throws LdapException
* {@inheritDoc}
*/
@Override
- public void sync() throws Exception
+ public void sync() throws LdapException
{
if ( enabled )
{
@@ -386,7 +386,7 @@ public long getCurrentRevision() throws LdapException
* {@inheritDoc}
*/
@Override
- public void destroy() throws Exception
+ public void destroy() throws LdapException
{
if ( enabled )
{
diff --git a/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/MemoryChangeLogStore.java b/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/MemoryChangeLogStore.java
index d9b0aed..d3e560c 100644
--- a/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/MemoryChangeLogStore.java
+++ b/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/MemoryChangeLogStore.java
@@ -128,19 +128,27 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
@Override
- public void init( DirectoryService service ) throws Exception
+ public void init( DirectoryService service ) throws LdapException
{
workingDirectory = service.getInstanceLayout().getLogDirectory();
this.directoryService = service;
- loadRevision();
- loadTags();
- loadChangeLog();
+
+ try
+ {
+ loadRevision();
+ loadTags();
+ loadChangeLog();
+ }
+ catch ( IOException ioe )
+ {
+ throw new LdapException( ioe.getMessage(), ioe );
+ }
}
// This will suppress PMD.EmptyCatchBlock warnings in this method
@SuppressWarnings("PMD.EmptyCatchBlock")
- private void loadRevision() throws Exception
+ private void loadRevision() throws IOException
{
File revFile = new File( workingDirectory, REV_FILE );
@@ -176,7 +184,7 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
}
- private void saveRevision() throws Exception
+ private void saveRevision() throws IOException
{
File revFile = new File( workingDirectory, REV_FILE );
@@ -199,7 +207,7 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
// This will suppress PMD.EmptyCatchBlock warnings in this method
@SuppressWarnings("PMD.EmptyCatchBlock")
- private void saveTags() throws Exception
+ private void saveTags() throws IOException
{
File tagFile = new File( workingDirectory, TAG_FILE );
@@ -256,7 +264,7 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
// This will suppress PMD.EmptyCatchBlock warnings in this method
@SuppressWarnings("PMD.EmptyCatchBlock")
- private void loadTags() throws Exception
+ private void loadTags() throws IOException
{
File revFile = new File( workingDirectory, REV_FILE );
@@ -325,7 +333,7 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
// This will suppress PMD.EmptyCatchBlock warnings in this method
@SuppressWarnings("PMD.EmptyCatchBlock")
- private void loadChangeLog() throws Exception
+ private void loadChangeLog() throws IOException, LdapException
{
File file = new File( workingDirectory, CHANGELOG_FILE );
@@ -376,7 +384,7 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
// This will suppress PMD.EmptyCatchBlock warnings in this method
@SuppressWarnings("PMD.EmptyCatchBlock")
- private void saveChangeLog() throws Exception
+ private void saveChangeLog() throws IOException
{
File file = new File( workingDirectory, CHANGELOG_FILE );
@@ -431,11 +439,18 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
@Override
- public void sync() throws Exception
+ public void sync() throws LdapException
{
- saveRevision();
- saveTags();
- saveChangeLog();
+ try
+ {
+ saveRevision();
+ saveTags();
+ saveChangeLog();
+ }
+ catch ( IOException ioe )
+ {
+ throw new LdapException( ioe.getMessage(), ioe );
+ }
}
@@ -443,11 +458,18 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
* Save logs, tags and revision on disk, and clean everything in memory
*/
@Override
- public void destroy() throws Exception
+ public void destroy() throws LdapException
{
- saveRevision();
- saveTags();
- saveChangeLog();
+ try
+ {
+ saveRevision();
+ saveTags();
+ saveChangeLog();
+ }
+ catch ( IOException ioe )
+ {
+ throw new LdapException( ioe.getMessage(), ioe );
+ }
}
diff --git a/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/package-info.java b/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/package-info.java
index c84de40..b2734e8 100644
--- a/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/package-info.java
+++ b/interceptors/changelog/src/main/java/org/apache/directory/server/core/changelog/package-info.java
@@ -19,7 +19,6 @@
*/
/**
- * <pre>
* <h1>Ideas</h1>
* <p>
* Use AdminModel to control what goes into the changelog ? Or use admin model to identify
@@ -47,7 +46,6 @@
* an incredible capability when storing the configurations of systems in LDAP. Being able to rollback
* to a previous configuration or just inquire about a previous state is a powerful feature to have.
* </p>
- * </pre>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
diff --git a/interceptors/exception/src/main/java/org/apache/directory/server/core/exception/ExceptionInterceptor.java b/interceptors/exception/src/main/java/org/apache/directory/server/core/exception/ExceptionInterceptor.java
index b4d9f22..c779483 100644
--- a/interceptors/exception/src/main/java/org/apache/directory/server/core/exception/ExceptionInterceptor.java
+++ b/interceptors/exception/src/main/java/org/apache/directory/server/core/exception/ExceptionInterceptor.java
@@ -37,6 +37,7 @@ import org.apache.directory.server.core.api.DirectoryService;
import org.apache.directory.server.core.api.InterceptorEnum;
import org.apache.directory.server.core.api.entry.ClonedServerEntry;
import org.apache.directory.server.core.api.interceptor.BaseInterceptor;
+import org.apache.directory.server.core.api.interceptor.Interceptor;
import org.apache.directory.server.core.api.interceptor.context.AddOperationContext;
import org.apache.directory.server.core.api.interceptor.context.DeleteOperationContext;
import org.apache.directory.server.core.api.interceptor.context.HasEntryOperationContext;
@@ -46,12 +47,13 @@ import org.apache.directory.server.core.api.interceptor.context.MoveAndRenameOpe
import org.apache.directory.server.core.api.interceptor.context.MoveOperationContext;
import org.apache.directory.server.core.api.interceptor.context.OperationContext;
import org.apache.directory.server.core.api.interceptor.context.RenameOperationContext;
+import org.apache.directory.server.core.api.partition.Partition;
import org.apache.directory.server.core.api.partition.PartitionNexus;
import org.apache.directory.server.i18n.I18n;
/**
- * An {@link org.apache.directory.server.core.api.interceptor.Interceptor} that detects any operations that breaks integrity
+ * An {@link Interceptor} that detects any operations that breaks integrity
* of {@link Partition} and terminates the current invocation chain by
* throwing a {@link Exception}. Those operations include when an entry
* already exists at a Dn and is added once again to the same Dn.
diff --git a/interceptors/hash/src/main/java/org/apache/directory/server/core/hash/PasswordHashingInterceptor.java b/interceptors/hash/src/main/java/org/apache/directory/server/core/hash/PasswordHashingInterceptor.java
index c499b2b..17994d5 100644
--- a/interceptors/hash/src/main/java/org/apache/directory/server/core/hash/PasswordHashingInterceptor.java
+++ b/interceptors/hash/src/main/java/org/apache/directory/server/core/hash/PasswordHashingInterceptor.java
@@ -58,6 +58,7 @@ public abstract class PasswordHashingInterceptor extends BaseInterceptor
* incoming non-hashed password using the given algorithm.
* If the password is found already hashed then it will skip hashing it.
*
+ * @param name The instance's name
* @param algorithm the name of the algorithm to be used
*/
protected PasswordHashingInterceptor( String name, LdapSecurityConstants algorithm )
diff --git a/interceptors/journal/src/main/java/org/apache/directory/server/core/journal/DefaultJournal.java b/interceptors/journal/src/main/java/org/apache/directory/server/core/journal/DefaultJournal.java
index 26330ed..a2de4cd 100644
--- a/interceptors/journal/src/main/java/org/apache/directory/server/core/journal/DefaultJournal.java
+++ b/interceptors/journal/src/main/java/org/apache/directory/server/core/journal/DefaultJournal.java
@@ -19,6 +19,8 @@
package org.apache.directory.server.core.journal;
+import java.io.IOException;
+
import org.apache.directory.api.ldap.model.exception.LdapException;
import org.apache.directory.api.ldap.model.ldif.LdifEntry;
import org.apache.directory.server.core.api.DirectoryService;
@@ -58,7 +60,7 @@ public class DefaultJournal implements Journal
* {@inheritDoc}
*/
@Override
- public void destroy() throws Exception
+ public void destroy() throws LdapException
{
LOG.debug( "Stopping the journal" );
@@ -66,7 +68,14 @@ public class DefaultJournal implements Journal
// to stop the server
if ( store != null )
{
- store.destroy();
+ try
+ {
+ store.destroy();
+ }
+ catch ( IOException ioe )
+ {
+ throw new LdapException( ioe.getMessage(), ioe );
+ }
}
}
@@ -85,7 +94,7 @@ public class DefaultJournal implements Journal
* {@inheritDoc}
*/
@Override
- public void init( DirectoryService directoryService ) throws Exception
+ public void init( DirectoryService directoryService ) throws LdapException
{
LOG.debug( "Starting the journal" );
@@ -94,7 +103,14 @@ public class DefaultJournal implements Journal
store = new DefaultJournalStore();
}
- store.init( directoryService );
+ try
+ {
+ store.init( directoryService );
+ }
+ catch ( IOException ioe )
+ {
+ throw new LdapException( ioe.getMessage(), ioe );
+ }
LOG.debug( "The Journal service has been initialized" );
}
diff --git a/interceptors/journal/src/main/java/org/apache/directory/server/core/journal/DefaultJournalStore.java b/interceptors/journal/src/main/java/org/apache/directory/server/core/journal/DefaultJournalStore.java
index 04a6366..b57fd37 100644
--- a/interceptors/journal/src/main/java/org/apache/directory/server/core/journal/DefaultJournalStore.java
+++ b/interceptors/journal/src/main/java/org/apache/directory/server/core/journal/DefaultJournalStore.java
@@ -37,7 +37,9 @@ import org.apache.directory.server.core.api.journal.JournalStore;
/**
- * @todo : Missing Javadoc
+ * The default Journal Store implementation. It creates a file on disk in which
+ * the logs will be appended.
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class DefaultJournalStore implements JournalStore
@@ -59,7 +61,7 @@ public class DefaultJournalStore implements JournalStore
* {@inheritDoc}
*/
@Override
- public void destroy() throws Exception
+ public void destroy() throws IOException
{
if ( writer != null )
{
@@ -72,7 +74,7 @@ public class DefaultJournalStore implements JournalStore
* Initialize the interceptor
*/
@Override
- public void init( DirectoryService service ) throws Exception
+ public void init( DirectoryService service ) throws IOException
{
if ( workingDirectory == null )
{
@@ -146,7 +148,6 @@ public class DefaultJournalStore implements JournalStore
*
* @param revision The change revision which is acked
* @return <code>true</code> if the ack has been written
- * @throws Exception if there are problems logging the ack
*/
@Override
public boolean ack( long revision )
@@ -177,7 +178,6 @@ public class DefaultJournalStore implements JournalStore
*
* @param revision The change revision which is nacked
* @return <code>true</code> if the nack has been written
- * @throws Exception if there are problems logging the nack
*/
@Override
public boolean nack( long revision )
@@ -204,7 +204,7 @@ public class DefaultJournalStore implements JournalStore
@Override
- public void sync() throws Exception
+ public void sync() throws IOException
{
// TODO Auto-generated method stub
diff --git a/interceptors/normalization/src/main/java/org/apache/directory/server/core/normalization/NormalizationInterceptor.java b/interceptors/normalization/src/main/java/org/apache/directory/server/core/normalization/NormalizationInterceptor.java
index 07e2708..2180a15 100644
--- a/interceptors/normalization/src/main/java/org/apache/directory/server/core/normalization/NormalizationInterceptor.java
+++ b/interceptors/normalization/src/main/java/org/apache/directory/server/core/normalization/NormalizationInterceptor.java
@@ -67,7 +67,7 @@ import org.slf4j.LoggerFactory;
/**
* A name normalization service. This service makes sure all relative and distinguished
* names are normalized before calls are made against the respective interface methods
- * on {@link DefaultPartitionNexus}.
+ * on DefaultPartitionNexus.
*
* The Filters are also normalized.
*
diff --git a/interceptors/operational/src/main/java/org/apache/directory/server/core/operational/OperationalAttributeInterceptor.java b/interceptors/operational/src/main/java/org/apache/directory/server/core/operational/OperationalAttributeInterceptor.java
index d9c6ab7..5f4562d 100644
--- a/interceptors/operational/src/main/java/org/apache/directory/server/core/operational/OperationalAttributeInterceptor.java
+++ b/interceptors/operational/src/main/java/org/apache/directory/server/core/operational/OperationalAttributeInterceptor.java
@@ -50,6 +50,7 @@ import org.apache.directory.server.core.api.entry.ClonedServerEntry;
import org.apache.directory.server.core.api.filtering.EntryFilter;
import org.apache.directory.server.core.api.filtering.EntryFilteringCursor;
import org.apache.directory.server.core.api.interceptor.BaseInterceptor;
+import org.apache.directory.server.core.api.interceptor.Interceptor;
import org.apache.directory.server.core.api.interceptor.context.AddOperationContext;
import org.apache.directory.server.core.api.interceptor.context.DeleteOperationContext;
import org.apache.directory.server.core.api.interceptor.context.LookupOperationContext;
diff --git a/interceptors/referral/src/main/java/org/apache/directory/server/core/referral/ReferralInterceptor.java b/interceptors/referral/src/main/java/org/apache/directory/server/core/referral/ReferralInterceptor.java
index 8415d38..8f7e6e1 100644
--- a/interceptors/referral/src/main/java/org/apache/directory/server/core/referral/ReferralInterceptor.java
+++ b/interceptors/referral/src/main/java/org/apache/directory/server/core/referral/ReferralInterceptor.java
@@ -20,6 +20,8 @@
package org.apache.directory.server.core.referral;
+import javax.naming.Context;
+
import org.apache.directory.api.ldap.model.constants.SchemaConstants;
import org.apache.directory.api.ldap.model.entry.Attribute;
import org.apache.directory.api.ldap.model.entry.Entry;
@@ -50,8 +52,8 @@ import org.slf4j.LoggerFactory;
/**
- * An service which is responsible referral handling behavoirs. It manages
- * referral handling behavoir when the {@link Context#REFERRAL} is implicitly
+ * An service which is responsible referral handling behaviors. It manages
+ * referral handling behavior when the {@link Context#REFERRAL} is implicitly
* or explicitly set to "ignore", when set to "throw" and when set to "follow".
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
diff --git a/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaInterceptor.java b/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaInterceptor.java
index dae412e..a0a06f2 100644
--- a/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaInterceptor.java
+++ b/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaInterceptor.java
@@ -96,8 +96,8 @@ import org.slf4j.LoggerFactory;
/**
* An {@link org.apache.directory.server.core.api.interceptor.Interceptor} that manages and enforces schemas.
*
- * @todo Better interceptor description required.
-
+ * TODO Better interceptor description required.
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class SchemaInterceptor extends BaseInterceptor
@@ -152,7 +152,7 @@ public class SchemaInterceptor extends BaseInterceptor
* Initialize the Schema Service
*
* @param directoryService the directory service core
- * @throws Exception if there are problems during initialization
+ * @throws LdapException if there are problems during initialization
*/
@Override
public void init( DirectoryService directoryService ) throws LdapException
diff --git a/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaLdifToPartitionExtractor.java b/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaLdifToPartitionExtractor.java
index 20d8bfe..092e968 100644
--- a/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaLdifToPartitionExtractor.java
+++ b/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaLdifToPartitionExtractor.java
@@ -85,6 +85,7 @@ public class SchemaLdifToPartitionExtractor implements SchemaLdifExtractor
*
* @param schemaManager the bootstrap schema manager
* @param partition the destination partition
+ * @throws LdapException If the instance can't be created
*/
public SchemaLdifToPartitionExtractor( SchemaManager schemaManager, Partition partition ) throws LdapException
{
diff --git a/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaSubentryManager.java b/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaSubentryManager.java
index 893138e..ed8a67d 100644
--- a/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaSubentryManager.java
+++ b/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/SchemaSubentryManager.java
@@ -166,12 +166,12 @@ public class SchemaSubentryManager
/**
* Find the next interceptor in an operation's list of interceptors, assuming that
* we are already processing an operation, and we have stopped in a specific
- * interceptor.<br/>
- * For instance, if the list of all the interceptors is : <br/>
- * [A, B, C, D, E, F]<br/>
- * and we ave two operations op1 and op2 with the following interceptors list : <br/>
- * op1 -> [A, D, F]<br/>
- * op2 -> [B, C, E]<br/>
+ * interceptor.<br>
+ * For instance, if the list of all the interceptors is : <br>
+ * [A, B, C, D, E, F]<br>
+ * and we ave two operations op1 and op2 with the following interceptors list : <br>
+ * op1 -> [A, D, F]<br>
+ * op2 -> [B, C, E]<br>
* then assuming that we have stopped at D, then op1.next -> F and op2.next -> E.
*/
private Interceptor findNextInterceptor( OperationEnum operation, DirectoryService directoryService )
@@ -238,6 +238,10 @@ public class SchemaSubentryManager
/**
* Update the SubschemaSubentry with all the modifications
+ *
+ * @param modifyContext The Modification context
+ * @param doCascadeModify If we should recursively apply the modification
+ * @throws LdapException If the schema modification failed
*/
public void modifySchemaSubentry( ModifyOperationContext modifyContext, boolean doCascadeModify )
throws LdapException
diff --git a/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/package-info.java b/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/package-info.java
index effff18..74daa6b 100644
--- a/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/package-info.java
+++ b/interceptors/schema/src/main/java/org/apache/directory/server/core/schema/package-info.java
@@ -19,12 +19,9 @@
*/
/**
- * <pre>
- * <p>
* Contains interfaces for schema object registry services and simple POJO
* implementations of these services. Other helper interfaces and classes are
* included for handling monitoring of these services.
- * </p>
* <p>
* These services and their POJO implementations are purposefully kept really
* simple here for a reason. When one looks at these interfaces they stop and
@@ -36,7 +33,6 @@
* instances of these components are required by the system. So these simple
* watered down interfaces and their POJO's have been pruned from previously
* complex environment specific versions of them.
- * </p>
* <p>
* Some key points to apply to services and their POJO impls in this package:
* <ul>
@@ -46,8 +42,6 @@
* <li>don't worry who or what does the populating</li>
* <li>don't worry about where the information comes from</li>
* </ul>
- * </p>
- * </pre>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
diff --git a/interceptors/subtree/src/main/java/org/apache/directory/server/core/subtree/SubentryInterceptor.java b/interceptors/subtree/src/main/java/org/apache/directory/server/core/subtree/SubentryInterceptor.java
index 49245b0..b2a8ab0 100644
--- a/interceptors/subtree/src/main/java/org/apache/directory/server/core/subtree/SubentryInterceptor.java
+++ b/interceptors/subtree/src/main/java/org/apache/directory/server/core/subtree/SubentryInterceptor.java
@@ -1290,7 +1290,6 @@ public class SubentryInterceptor extends BaseInterceptor
* <u>Case 3 :</u><br>
*
*
- * @param next The next interceptor in the chain
* @param moveContext The context containing all the needed informations to proceed
* @throws LdapException If the move failed
*/
diff --git a/interceptors/trigger/src/main/java/org/apache/directory/server/core/trigger/TriggerInterceptor.java b/interceptors/trigger/src/main/java/org/apache/directory/server/core/trigger/TriggerInterceptor.java
index 911b711..9ce12b7 100644
--- a/interceptors/trigger/src/main/java/org/apache/directory/server/core/trigger/TriggerInterceptor.java
+++ b/interceptors/trigger/src/main/java/org/apache/directory/server/core/trigger/TriggerInterceptor.java
@@ -205,7 +205,7 @@ public class TriggerInterceptor extends BaseInterceptor
/**
* Return a selection of trigger specifications for a certain type of trigger action time.
*
- * @note This method serves as an extion point for new Action Time types.
+ * This method serves as an extension point for new Action Time types.
*
* @param triggerSpecs the trigger specifications
* @param ldapOperation the ldap operation being performed
diff --git a/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/DnSerializer.java b/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/DnSerializer.java
index 5261c98..5875087 100644
--- a/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/DnSerializer.java
+++ b/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/DnSerializer.java
@@ -38,7 +38,7 @@ import org.slf4j.LoggerFactory;
/**
* Serialize and deserialize a Dn.
- * </br></br>
+ * <br><br>
* <b>This class must *not* be used outside of the server.</b>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
diff --git a/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/EntrySerializer.java b/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/EntrySerializer.java
index 68989e9..2007161 100644
--- a/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/EntrySerializer.java
+++ b/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/EntrySerializer.java
@@ -47,7 +47,7 @@ import org.slf4j.LoggerFactory;
/**
* Serialize and deserialize a ServerEntry. There is a big difference with the standard
* Entry serialization : we don't serialize the entry's Dn, we just serialize it's Rdn.
- * </br></br>
+ * <br><br>
* <b>This class must *not* be used outside of the server.</b>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
diff --git a/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/ParentIdAndRdnSerializer.java b/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/ParentIdAndRdnSerializer.java
index 46b8925..01003e8 100644
--- a/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/ParentIdAndRdnSerializer.java
+++ b/jdbm-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/jdbm/ParentIdAndRdnSerializer.java
@@ -39,7 +39,7 @@ import org.slf4j.LoggerFactory;
/**
* Serialize and deserialize a ParentidAndRdn.
- * </br></br>
+ * <br><br>
* <b>This class must *not* be used outside of the server.</b>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
diff --git a/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/KerberosUtils.java b/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/KerberosUtils.java
index a7d9380..cfd07e1 100644
--- a/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/KerberosUtils.java
+++ b/kerberos-codec/src/main/java/org/apache/directory/shared/kerberos/KerberosUtils.java
@@ -125,44 +125,44 @@ public class KerberosUtils
/**
* Parse a KerberosPrincipal instance and return the names. The Principal name
- * is described in RFC 1964 : <br/>
- * <br/>
- * This name type corresponds to the single-string representation of a<br/>
- * Kerberos name. (Within the MIT Kerberos V5 implementation, such<br/>
- * names are parseable with the krb5_parse_name() function.) The<br/>
- * elements included within this name representation are as follows,<br/>
- * proceeding from the beginning of the string:<br/>
- * <br/>
- * (1) One or more principal name components; if more than one<br/>
- * principal name component is included, the components are<br/>
- * separated by `/`. Arbitrary octets may be included within<br/>
- * principal name components, with the following constraints and<br/>
- * special considerations:<br/>
- * <br/>
- * (1a) Any occurrence of the characters `@` or `/` within a<br/>
- * name component must be immediately preceded by the `\`<br/>
- * quoting character, to prevent interpretation as a component<br/>
- * or realm separator.<br/>
- * <br/>
- * (1b) The ASCII newline, tab, backspace, and null characters<br/>
- * may occur directly within the component or may be<br/>
- * represented, respectively, by `\n`, `\t`, `\b`, or `\0`.<br/>
- * <br/>
- * (1c) If the `\` quoting character occurs outside the contexts<br/>
- * described in (1a) and (1b) above, the following character is<br/>
- * interpreted literally. As a special case, this allows the<br/>
- * doubled representation `\\` to represent a single occurrence<br/>
- * of the quoting character.<br/>
- * <br/>
- * (1d) An occurrence of the `\` quoting character as the last<br/>
- * character of a component is illegal.<br/>
- * <br/>
- * (2) Optionally, a `@` character, signifying that a realm name<br/>
- * immediately follows. If no realm name element is included, the<br/>
- * local realm name is assumed. The `/` , `:`, and null characters<br/>
- * may not occur within a realm name; the `@`, newline, tab, and<br/>
- * backspace characters may be included using the quoting<br/>
- * conventions described in (1a), (1b), and (1c) above.<br/>
+ * is described in RFC 1964 : <br>
+ * <br>
+ * This name type corresponds to the single-string representation of a<br>
+ * Kerberos name. (Within the MIT Kerberos V5 implementation, such<br>
+ * names are parseable with the krb5_parse_name() function.) The<br>
+ * elements included within this name representation are as follows,<br>
+ * proceeding from the beginning of the string:<br>
+ * <br>
+ * (1) One or more principal name components; if more than one<br>
+ * principal name component is included, the components are<br>
+ * separated by `/`. Arbitrary octets may be included within<br>
+ * principal name components, with the following constraints and<br>
+ * special considerations:<br>
+ * <br>
+ * (1a) Any occurrence of the characters `@` or `/` within a<br>
+ * name component must be immediately preceded by the `\`<br>
+ * quoting character, to prevent interpretation as a component<br>
+ * or realm separator.<br>
+ * <br>
+ * (1b) The ASCII newline, tab, backspace, and null characters<br>
+ * may occur directly within the component or may be<br>
+ * represented, respectively, by `\n`, `\t`, `\b`, or `\0`.<br>
+ * <br>
+ * (1c) If the `\` quoting character occurs outside the contexts<br>
+ * described in (1a) and (1b) above, the following character is<br>
+ * interpreted literally. As a special case, this allows the<br>
+ * doubled representation `\\` to represent a single occurrence<br>
+ * of the quoting character.<br>
+ * <br>
+ * (1d) An occurrence of the `\` quoting character as the last<br>
+ * character of a component is illegal.<br>
+ * <br>
+ * (2) Optionally, a `@` character, signifying that a realm name<br>
+ * immediately follows. If no realm name element is included, the<br>
+ * local realm name is assumed. The `/` , `:`, and null characters<br>
+ * may not occur within a realm name; the `@`, newline, tab, and<br>
+ * backspace characters may be included using the quoting<br>
+ * conventions described in (1a), (1b), and (1c) above.<br>
*
* @param principal The principal to be parsed
* @return The names as a List of nameComponent
diff --git a/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/DnSerializer.java b/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/DnSerializer.java
index 5261bf1..3fa1e32 100644
--- a/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/DnSerializer.java
+++ b/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/DnSerializer.java
@@ -40,7 +40,7 @@ import org.slf4j.LoggerFactory;
/**
* Serialize and deserialize a Dn.
- * </br></br>
+ * <br><br>
* <b>This class must *not* be used outside of the server.</b>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
diff --git a/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/MavibotEntrySerializer.java b/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/MavibotEntrySerializer.java
index 96fdf00..5320a17 100644
--- a/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/MavibotEntrySerializer.java
+++ b/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/MavibotEntrySerializer.java
@@ -49,7 +49,7 @@ import org.slf4j.LoggerFactory;
/**
* Serialize and deserialize a ServerEntry. There is a big difference with the standard
* Entry serialization : we don't serialize the entry's Dn, we just serialize it's Rdn.
- * </br></br>
+ * <br><br>
* <b>This class must *not* be used outside of the server.</b>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
diff --git a/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/MavibotParentIdAndRdnSerializer.java b/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/MavibotParentIdAndRdnSerializer.java
index dd18529..e698432 100644
--- a/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/MavibotParentIdAndRdnSerializer.java
+++ b/mavibot-partition/src/main/java/org/apache/directory/server/core/partition/impl/btree/mavibot/MavibotParentIdAndRdnSerializer.java
@@ -39,7 +39,7 @@ import org.slf4j.LoggerFactory;
/**
* Serialize and deserialize a ParentidAndRdn.
- * </br></br>
+ * <br><br>
* <b>This class must *not* be used outside of the server.</b>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
@@ -83,7 +83,7 @@ public class MavibotParentIdAndRdnSerializer extends AbstractElementSerializer<P
/**
- * This is the place where we serialize ParentIdAndRdn. The format is the following :<br/>
+ * This is the place where we serialize ParentIdAndRdn. The format is the following :<br>
* <ul>
* <li>length</li>
* <li>the RDN</li>
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapServer.java b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapServer.java
index 98412d0..54c8620 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapServer.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/LdapServer.java
@@ -1766,7 +1766,7 @@ public class LdapServer extends DirectoryBackedService
* Gives the list of enabled cipher suites
* <br>
* This method has been deprecated, please set this list in the TcpTransport class
- * </br>
+ * <br>
*
* @return The list of ciphers that can be used
*/
@@ -1781,7 +1781,7 @@ public class LdapServer extends DirectoryBackedService
* Sets the list of cipher suites to be used in LDAPS and StartTLS
* <br>
* This method has been deprecated, please set this list in the TcpTransport class
- * </br>
+ * <br>
*
* @param enabledCipherSuites if null the default cipher suites will be used
*/
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/BindRequestHandler.java b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/BindRequestHandler.java
index 47e5276..5cb9aa5 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/BindRequestHandler.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/handlers/request/BindRequestHandler.java
@@ -536,12 +536,12 @@ public class BindRequestHandler extends LdapRequestHandler<BindRequest>
* <li>The user does not has a session yet</li>
* <li>The user already has a session</li>
* <li>The user has started a SASL negotiation</li>
- * </lu><br/>
+ * </lu><br>
*
* In the first case, we initiate a SaslBind session, which will be used all
- * along the negotiation.<br/>
+ * along the negotiation.<br>
* In the second case, we first have to unbind the user, and initiate a new
- * SaslBind session.<br/>
+ * SaslBind session.<br>
* In the third case, we have sub cases :
* <ul>
* <li>The mechanism is not provided : that means the user want to reset the
@@ -549,7 +549,7 @@ public class BindRequestHandler extends LdapRequestHandler<BindRequest>
* <li>The mechanism is provided : the user is initializing a new negotiation
* with another mechanism. The current SaslBind session is reinitialized</li>
* <li></li>
- * </ul><br/>
+ * </ul><br>
*
* @param ldapSession The associated Session
* @param bindRequest The BindRequest received
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/ReplicaEventMessageSerializer.java b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/ReplicaEventMessageSerializer.java
index a912c33..aa08854 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/ReplicaEventMessageSerializer.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/ReplicaEventMessageSerializer.java
@@ -39,7 +39,7 @@ import org.apache.directory.api.ldap.model.schema.SchemaManager;
/**
* A ReplicaEventMessage serializer/deserializer.
*
- * A modification is serialized following this format : <br/>
+ * A modification is serialized following this format : <br>
* <ul>
* <li>byte : EventType</li>
* <li>byte[] : the serialized DN</li>
diff --git a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaEventLog.java b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaEventLog.java
index f5a578b..4310011 100644
--- a/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaEventLog.java
+++ b/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/provider/ReplicaEventLog.java
@@ -57,7 +57,7 @@ import org.slf4j.LoggerFactory;
* <li>refreshNPersist : a flag indicating that the consumer is processing in Refresh and persist mode</li>
* <li></li>
* </ul>
- * A separate log is maintained for each syncrepl consumer.<br/>
+ * A separate log is maintained for each syncrepl consumer.<br>
* We also associate a Queue with each structure, which will store the messages to send to the consumer.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
diff --git a/protocol-ntp/src/main/java/org/apache/directory/server/ntp/protocol/NtpProtocolHandler.java b/protocol-ntp/src/main/java/org/apache/directory/server/ntp/protocol/NtpProtocolHandler.java
index f47f485..2b5e6ea 100644
--- a/protocol-ntp/src/main/java/org/apache/directory/server/ntp/protocol/NtpProtocolHandler.java
+++ b/protocol-ntp/src/main/java/org/apache/directory/server/ntp/protocol/NtpProtocolHandler.java
@@ -33,7 +33,7 @@ import org.slf4j.LoggerFactory;
/**
* The NTP protocol handler. It implements the {@link org.apache.mina.core.service.IoHandler#messageReceived} method,
* which returns the NTP reply. The {@link org.apache.mina.core.service.IoHandler#exceptionCaught} is also implemented,
- * all the other methods are handled by the {@link IoHandlerAdapter} class.<br/>
+ * all the other methods are handled by the {@link IoHandlerAdapter} class.<br>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
diff --git a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Index.java b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Index.java
index 9d0be41..675f43f 100644
--- a/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Index.java
+++ b/xdbm-partition/src/main/java/org/apache/directory/server/xdbm/Index.java
@@ -32,7 +32,7 @@ import org.apache.directory.server.core.api.partition.PartitionTxn;
/**
* An index used to retrieve elements into the master table. Each stored element that is
* indexed has a unique identifier (ID). We may have more than one element associated with
- * a value (K). We may cache the retrieved element (O). <br/>
+ * a value (K). We may cache the retrieved element (O). <br>
* Cursors over indices can also be gotten to traverse the
* values of the index.
*
@@ -158,11 +158,11 @@ public interface Index<K, E>
/**
* Remove all the reference to an entry from the index.
- * <br/>
+ * <br>
* As an entry might be referenced more than once in the forward index,
* depending on which index we are dealing with, we need to iterate
* over all the values contained into the reverse index for this entryId.
- * <br/>
+ * <br>
* For instance, considering the ObjectClass index for an entry having
* three ObjectClasses (top, person, inetOrgPerson), then the reverse
* index will contain :