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/11 21:34:26 UTC
[directory-server] branch master updated: Some more ApacheDS
javadoc errors/warnings fixes
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 28fd771 Some more ApacheDS javadoc errors/warnings fixes
28fd771 is described below
commit 28fd7717e21d344d76bbb89fe517ae58847dc229
Author: Emmanuel Lécharny <el...@symas.com>
AuthorDate: Sat Aug 11 23:34:23 2018 +0200
Some more ApacheDS javadoc errors/warnings fixes
---
.../api/changelog/ChangeLogEventSerializer.java | 2 +-
.../core/api/changelog/ChangeLogSearchEngine.java | 6 +-
.../server/core/api/changelog/ChangeLogStore.java | 25 +++-----
.../core/api/changelog/TaggableChangeLogStore.java | 22 ++-----
.../TaggableSearchableChangeLogStore.java | 8 ++-
.../server/core/api/entry/ClonedServerEntry.java | 2 +-
.../server/core/api/entry/ServerEntryUtils.java | 40 +++++++++---
.../directory/server/core/api/event/Evaluator.java | 4 +-
.../directory/server/core/api/event/EventType.java | 19 +++++-
.../server/core/api/event/LeafEvaluator.java | 2 +-
.../server/core/api/filtering/CursorList.java | 3 +
.../server/core/api/filtering/EntryFilter.java | 6 +-
.../api/filtering/EntryFilteringCursorImpl.java | 11 ++--
.../server/core/api/interceptor/Interceptor.java | 72 +++++++++++++++++-----
.../interceptor/context/BindOperationContext.java | 2 +
.../normalization/FilterNormalizingVisitor.java | 4 +-
.../server/core/api/partition/Partition.java | 62 +++++++++++--------
.../server/core/api/partition/PartitionNexus.java | 13 ++--
.../synchronizers/RegistrySynchronizer.java | 8 +--
.../synchronizers/RegistrySynchronizerAdaptor.java | 6 +-
.../synchronizers/SchemaSynchronizer.java | 10 +--
.../server/core/api/subtree/SubentryCache.java | 2 +-
.../server/core/api/subtree/SubentryUtils.java | 2 +-
.../core/changelog/MemoryChangeLogStore.java | 63 ++++++++++++++-----
.../dns/io/decoder/MailExchangeRecordDecoder.java | 4 +-
.../dns/io/decoder/NameServerRecordDecoder.java | 4 +-
.../dns/io/encoder/CanonicalNameRecordEncoder.java | 2 +-
.../server/dns/io/encoder/DnameRecordEncoder.java | 6 +-
.../io/encoder/HostInformationRecordEncoder.java | 4 +-
.../dns/io/encoder/KeyExchangeRecordEncoder.java | 2 +-
.../dns/io/encoder/LocationRecordEncoder.java | 2 +-
.../dns/io/encoder/MailExchangeRecordEncoder.java | 2 +-
.../io/encoder/MailInformationRecordEncoder.java | 4 +-
.../io/encoder/NameAuthorityPointerEncoder.java | 10 +--
.../dns/io/encoder/NameServerRecordEncoder.java | 2 +-
.../dns/io/encoder/PointerRecordEncoder.java | 2 +-
.../dns/io/encoder/ResourceRecordEncoder.java | 6 +-
.../io/encoder/StartOfAuthorityRecordEncoder.java | 4 +-
.../server/dns/io/encoder/TextRecordEncoder.java | 2 +-
.../io/encoder/WellKnownServicesRecordEncoder.java | 4 +-
.../server/dns/store/jndi/DnsOperation.java | 2 +-
.../server/dns/store/jndi/SearchStrategy.java | 4 +-
.../protocol/shared/DirectoryBackedService.java | 3 +
.../server/protocol/shared/MapAdapter.java | 2 +-
.../server/protocol/shared/ProtocolService.java | 2 +
.../shared/ServiceConfigurationException.java | 10 +--
.../server/protocol/shared/StandardThreadPool.java | 6 +-
.../server/protocol/shared/catalog/Catalog.java | 2 +-
.../protocol/shared/kerberos/GetPrincipal.java | 5 ++
.../protocol/shared/store/LdifFileLoader.java | 16 ++---
.../protocol/shared/store/LdifLoadFilter.java | 2 +-
.../protocol/shared/transport/TcpTransport.java | 5 +-
.../protocol/shared/transport/UdpTransport.java | 2 +-
53 files changed, 323 insertions(+), 192 deletions(-)
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogEventSerializer.java b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogEventSerializer.java
index 5e1f187..d0fc6d0 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogEventSerializer.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogEventSerializer.java
@@ -57,7 +57,7 @@ public final class ChangeLogEventSerializer
/**
* Serializes a ChangeLogEvent instance.
*
- * @param principal The ChangeLogEvent instance to serialize
+ * @param event The ChangeLogEvent instance to serialize
* @param out The stream into which we will write the serialized instance
* @throws IOException If the stream can't be written
*/
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogSearchEngine.java b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogSearchEngine.java
index aa42f20..0abe209 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogSearchEngine.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/ChangeLogSearchEngine.java
@@ -133,7 +133,7 @@ public interface ChangeLogSearchEngine
* @return an enumeration of all the ChangeLogEvents within some revision range inclusive
* @throws Exception if there are failures accessing the store
* @throws IllegalArgumentException if the start and end revisions are out of range
- * (less than 0 and greater than the current revision), or if startRevision > endRevision
+ * (less than 0 and greater than the current revision), or if startRevision > endRevision
*/
Cursor<ChangeLogEvent> find( long startRevision, long endRevision, RevisionOrder order )
throws Exception;
@@ -227,8 +227,8 @@ public interface ChangeLogSearchEngine
*
* <ul>
* <li>equality (=) </li>
- * <li>greaterThanEq (>=) </li>
- * <li>lessThanEq (<=) </li>
+ * <li>greaterThanEq (>=) </li>
+ * <li>lessThanEq (<=) </li>
* <li>scope (specialized) </li>
* </ul>
*
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 8153727..8bedfe1 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
@@ -49,7 +49,7 @@ public interface ChangeLogStore
/**
* Write the changes on disk
*
- * @throws Exception If the write failed
+ * @throws LdapException If the write failed
*/
void sync() throws LdapException;
@@ -78,9 +78,8 @@ public interface ChangeLogStore
* @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
*/
- ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, LdifEntry reverse ) throws Exception;
+ ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, LdifEntry reverse );
/**
@@ -91,9 +90,8 @@ public interface ChangeLogStore
* @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
*/
- ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, List<LdifEntry> reverses ) throws Exception;
+ ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, List<LdifEntry> reverses );
/**
@@ -101,11 +99,10 @@ public interface ChangeLogStore
*
* @param revision to get a ChangeLogEvent for
* @return the ChangeLogEvent associated with the revision
- * @throws Exception if there are failures accessing the store
* @throws IllegalArgumentException if the revision is out of range (less than 0
* and greater than the current revision)
*/
- ChangeLogEvent lookup( long revision ) throws Exception;
+ ChangeLogEvent lookup( long revision );
/**
@@ -117,9 +114,8 @@ public interface ChangeLogStore
* increasing the revision should not be seen.
*
* @return a Cursor over all the ChangeLogEvents
- * @throws Exception if there are failures accessing the store
*/
- Cursor<ChangeLogEvent> find() throws Exception;
+ Cursor<ChangeLogEvent> find();
/**
@@ -128,11 +124,10 @@ public interface ChangeLogStore
*
* @param revision the revision number to get the ChangeLogEvents before
* @return a Cursor over the ChangeLogEvents before a revision
- * @throws Exception if there are failures accessing the store
* @throws IllegalArgumentException if the revision is out of range (less than 0
* and greater than the current revision)
*/
- Cursor<ChangeLogEvent> findBefore( long revision ) throws Exception;
+ Cursor<ChangeLogEvent> findBefore( long revision );
/**
@@ -144,11 +139,10 @@ public interface ChangeLogStore
*
* @param revision the revision number to get the ChangeLogEvents after
* @return a Cursor of all the ChangeLogEvents after and including the revision
- * @throws Exception if there are failures accessing the store
* @throws IllegalArgumentException if the revision is out of range (less than 0
* and greater than the current revision)
*/
- Cursor<ChangeLogEvent> findAfter( long revision ) throws LdapException;
+ Cursor<ChangeLogEvent> findAfter( long revision );
/**
@@ -157,9 +151,8 @@ public interface ChangeLogStore
* @param startRevision the revision number to start getting the ChangeLogEvents above
* @param endRevision the revision number to start getting the ChangeLogEvents below
* @return an enumeration of all the ChangeLogEvents within some revision range inclusive
- * @throws Exception if there are failures accessing the store
* @throws IllegalArgumentException if the start and end revisions are out of range
- * (less than 0 and greater than the current revision), or if startRevision > endRevision
+ * (less than 0 and greater than the current revision), or if startRevision > endRevision
*/
- Cursor<ChangeLogEvent> find( long startRevision, long endRevision ) throws Exception;
+ Cursor<ChangeLogEvent> find( long startRevision, long endRevision );
}
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/TaggableChangeLogStore.java b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/TaggableChangeLogStore.java
index 4efab6e..6f940f6 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/TaggableChangeLogStore.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/TaggableChangeLogStore.java
@@ -20,9 +20,6 @@
package org.apache.directory.server.core.api.changelog;
-import org.apache.directory.api.ldap.model.exception.LdapException;
-
-
/**
* A ChangeLogStore which allows tagging for tracking server state snapshots.
* At most one tag per revision can be created. There is no point to creating
@@ -37,19 +34,16 @@ public interface TaggableChangeLogStore extends ChangeLogStore
*
* @param revision the revision to tag the snapshot
* @return the Tag associated with the revision
- * @throws Exception if there is a problem taking a tag, or if
- * the revision does not exist
*/
- Tag tag( long revision ) throws Exception;
+ Tag tag( long revision );
/**
* Creates a snapshot of the server at the current revision.
*
* @return the revision at which the tag is created
- * @throws Exception if there is a problem taking a tag
*/
- Tag tag() throws Exception;
+ Tag tag();
/**
@@ -58,9 +52,8 @@ public interface TaggableChangeLogStore extends ChangeLogStore
*
* @param description a description of the state associate with the tag
* @return the revision at which the tag is created
- * @throws Exception if there is a problem taking a tag
*/
- Tag tag( String description ) throws Exception;
+ Tag tag( String description );
/**
@@ -68,9 +61,8 @@ public interface TaggableChangeLogStore extends ChangeLogStore
*
* @return the last tag to have been created (youngest), or null if no
* tags have been created
- * @throws Exception on failures to access the tag store
*/
- Tag getLatest() throws LdapException;
+ Tag getLatest();
/**
@@ -78,9 +70,8 @@ public interface TaggableChangeLogStore extends ChangeLogStore
*
* @param revision the revision number that was tagged
* @return the removed tag, null if there is no Tag present with the given revision
- * @throws Exception on failures to access the tag store
*/
- Tag removeTag( long revision ) throws Exception;
+ Tag removeTag( long revision );
/**
@@ -90,7 +81,6 @@ public interface TaggableChangeLogStore extends ChangeLogStore
* @param revision the revision number that was tagged
* @param descrition a description of the state associate with the tag
* @return the Tag associated with the revision
- * @throws Exception on failures to access the tag store
*/
- Tag tag( long revision, String descrition ) throws Exception;
+ Tag tag( long revision, String descrition );
}
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/TaggableSearchableChangeLogStore.java b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/TaggableSearchableChangeLogStore.java
index 2330ddd..d9bc45e 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/changelog/TaggableSearchableChangeLogStore.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/changelog/TaggableSearchableChangeLogStore.java
@@ -45,9 +45,11 @@ public interface TaggableSearchableChangeLogStore extends TaggableChangeLogStore
* Note: This partition allows add/delete operation on the tags container
* The revisions container is read-only.<br><br>
* The default containers of the partition are
- * <li>ou=changelog</li>
- * <li>ou=tags,ou=changelog</li>
- * <li>ou=revisions,ou=changelog</li>
+ * <ul>
+ * <li>ou=changelog</li>
+ * <li>ou=tags,ou=changelog</li>
+ * <li>ou=revisions,ou=changelog</li>
+ * </ul>
*
* @param partitionSuffix the suffix of the partition e.x ou=chnagelog
* @param revContainerName the container's name for holding the revisions ex. ou=revisions
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/entry/ClonedServerEntry.java b/core-api/src/main/java/org/apache/directory/server/core/api/entry/ClonedServerEntry.java
index 5243da1..dce3289 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/entry/ClonedServerEntry.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/entry/ClonedServerEntry.java
@@ -460,7 +460,7 @@ public class ClonedServerEntry implements Entry
/**
- * @see Object#equals(Object);
+ * {@inheritDoc}
*/
@Override
public boolean equals( Object obj )
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/entry/ServerEntryUtils.java b/core-api/src/main/java/org/apache/directory/server/core/api/entry/ServerEntryUtils.java
index 75c4af6..f5232ec 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/entry/ServerEntryUtils.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/entry/ServerEntryUtils.java
@@ -73,6 +73,7 @@ public final class ServerEntryUtils
* during this conversion, as the Attributes object does not store
* this element.
*
+ * @param entryAttribute The Server entry to convert
* @return An instance of a AttributesImpl() object
*/
public static javax.naming.directory.Attribute toBasicAttribute( Attribute entryAttribute )
@@ -102,6 +103,7 @@ public final class ServerEntryUtils
* during this conversion, as the Attributes object does not store
* this element.
*
+ * @param entry The entry to convert
* @return An instance of a AttributesImpl() object
*/
public static Attributes toBasicAttributes( Entry entry )
@@ -136,10 +138,10 @@ public final class ServerEntryUtils
* Convert a BasicAttribute or a AttributeImpl to a ServerAtribute
*
* @param attribute the BasicAttributes or AttributesImpl instance to convert
- * @param attributeType
+ * @param attributeType The AttributeType to use
* @return An instance of a ServerEntry object
*
- * @throws InvalidAttributeIdentifierException If we had an incorrect attribute
+ * @throws LdapException If we had an incorrect attribute
*/
public static Attribute toServerAttribute( javax.naming.directory.Attribute attribute, AttributeType attributeType )
throws LdapException
@@ -213,8 +215,8 @@ public final class ServerEntryUtils
* Convert a BasicAttributes or a AttributesImpl to a ServerEntry
*
* @param attributes the BasicAttributes or AttributesImpl instance to convert
- * @param registries The registries, needed ro build a ServerEntry
* @param dn The Dn which is needed by the ServerEntry
+ * @param schemaManager The SchemaManager instance
* @return An instance of a ServerEntry object
*
* @throws LdapInvalidAttributeTypeException If we get an invalid attribute
@@ -266,6 +268,7 @@ public final class ServerEntryUtils
*
* @param mod the modification
* @param entry the source entry that is modified
+ * @param schemaManager The SchemaManager instance
* @return the resultant entry after the modification has taken place
* @throws LdapException if there are problems accessing attributes
*/
@@ -416,19 +419,19 @@ public final class ServerEntryUtils
/**
*
- * Convert a list of ModificationItemImpl to a list of
+ * Convert a list of ModificationItemImpl to a list of LDAP API Modifications
*
- * @param modificationImpls
- * @param atRegistry
- * @return
- * @throws LdapException
+ * @param modificationItems The modificationItems to convert
+ * @param schemaManager The SchemaManager instance
+ * @return A list of converted Modification
+ * @throws LdapException If the conversion failed
*/
public static List<Modification> convertToServerModification( List<ModificationItem> modificationItems,
SchemaManager schemaManager ) throws LdapException
{
if ( modificationItems != null )
{
- List<Modification> modifications = new ArrayList<Modification>( modificationItems.size() );
+ List<Modification> modifications = new ArrayList<>( modificationItems.size() );
for ( ModificationItem modificationItem : modificationItems )
{
@@ -465,6 +468,14 @@ public final class ServerEntryUtils
}
+ /**
+ * Convert a JNDI set of Modifications to LDAP API Modifications
+ *
+ * @param modifications The modifications to convert
+ * @param schemaManager The SchemaManager instance
+ * @return The list of converted Modifications
+ * @throws LdapException If the conversion failed
+ */
public static List<Modification> toServerModification( Modification[] modifications,
SchemaManager schemaManager ) throws LdapException
{
@@ -509,6 +520,14 @@ public final class ServerEntryUtils
}
+ /**
+ * Convert a JNDI set of ModificationItems to LDAP API Modifications
+ *
+ * @param modifications The modificationItems to convert
+ * @param schemaManager The SchemaManager instance
+ * @return The list of converted ModificationItems
+ * @throws LdapException If the conversion failed
+ */
public static List<Modification> toServerModification( ModificationItem[] modifications,
SchemaManager schemaManager ) throws LdapException
{
@@ -744,8 +763,9 @@ public final class ServerEntryUtils
/**
* Filters an entry accordingly to the requested Attribute list.
*
- * @param entry The entry to filter
+ * @param schemaManager The SchemaManager instance
* @param operationContext The SearchingOperationContext
+ * @param entry The entry to filter
* @throws LdapException If the filtering fails
*/
public static void filterContents( SchemaManager schemaManager, FilteringOperationContext operationContext,
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/event/Evaluator.java b/core-api/src/main/java/org/apache/directory/server/core/api/event/Evaluator.java
index 2b8c138..17a945f 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/event/Evaluator.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/event/Evaluator.java
@@ -38,10 +38,10 @@ public interface Evaluator
/**
* Evaluates a candidate to determine if a filter expression selects it.
*
- * @param node the filter expression to evaluate on the candidate
+ * @param refinement the filter expression to evaluate on the candidate
* @param dn the normalized distinguished name of the entry being tested
* @param entry the entry to evaluate
- * @return true if the filter selects the candidate false otherwise
+ * @return <tt>true</tt> if the filter selects the candidate false otherwise
* @throws LdapException if there is a database fault during evaluation
*/
boolean evaluate( ExprNode refinement, Dn dn, Entry entry ) throws LdapException;
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/event/EventType.java b/core-api/src/main/java/org/apache/directory/server/core/api/event/EventType.java
index d62442b..0fcb3ca 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/event/EventType.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/event/EventType.java
@@ -74,7 +74,6 @@ public enum EventType
* NOTE: When the changeTypes mask includes a modDN(8) we include both the
* RENAME and MOVE EventType objects in the array.
*
- * @see PersistentSearchDecorator
* @param psearchChangeTypes the value of the changeTypes parameter
* @return array of EventType objects
*/
@@ -109,6 +108,9 @@ public enum EventType
/**
* Tells if the EventType is an ADD
+ *
+ * @param mask The EventType to check
+ * @return <tt>true</tt> if the EventType is a ADD
*/
public static boolean isAdd( int mask )
{
@@ -118,6 +120,9 @@ public enum EventType
/**
* Tells if the EventType is a DELETE
+ *
+ * @param mask The EventType to check
+ * @return <tt>true</tt> if the EventType is a DELETE
*/
public static boolean isDelete( int mask )
{
@@ -127,6 +132,9 @@ public enum EventType
/**
* Tells if the EventType is a MODIFY
+ *
+ * @param mask The EventType to check
+ * @return <tt>true</tt> if the EventType is a MODIFY
*/
public static boolean isModify( int mask )
{
@@ -136,6 +144,9 @@ public enum EventType
/**
* Tells if the EventType is a MOVE
+ *
+ * @param mask The EventType to check
+ * @return <tt>true</tt> if the EventType is a MOVE
*/
public static boolean isMove( int mask )
{
@@ -145,6 +156,9 @@ public enum EventType
/**
* Tells if the EventType is a RENAME
+ *
+ * @param mask The EventType to check
+ * @return <tt>true</tt> if the EventType is a RENAME
*/
public static boolean isRename( int mask )
{
@@ -154,6 +168,9 @@ public enum EventType
/**
* Tells if the EventType is a MOVE and RENAME
+ *
+ * @param mask The EventType to check
+ * @return <tt>true</tt> if the EventType is a MOVE_AND_RENAME
*/
public static boolean isMoveAndRename( int mask )
{
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/event/LeafEvaluator.java b/core-api/src/main/java/org/apache/directory/server/core/api/event/LeafEvaluator.java
index 5db5ec8..0100200 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/event/LeafEvaluator.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/event/LeafEvaluator.java
@@ -79,7 +79,7 @@ public class LeafEvaluator implements Evaluator
/**
* Creates a leaf expression node evaluator.
*
- * @param schemaManager The server schemaManager
+ * @param substringEvaluator The evaluator to use
*/
public LeafEvaluator( SubstringEvaluator substringEvaluator )
{
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/filtering/CursorList.java b/core-api/src/main/java/org/apache/directory/server/core/api/filtering/CursorList.java
index 64cd93c..7affbcd 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/filtering/CursorList.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/filtering/CursorList.java
@@ -27,6 +27,7 @@ import org.apache.directory.api.i18n.I18n;
import org.apache.directory.api.ldap.model.constants.Loggers;
import org.apache.directory.api.ldap.model.cursor.AbstractCursor;
import org.apache.directory.api.ldap.model.cursor.ClosureMonitor;
+import org.apache.directory.api.ldap.model.cursor.Cursor;
import org.apache.directory.api.ldap.model.cursor.CursorException;
import org.apache.directory.api.ldap.model.cursor.InvalidCursorPositionException;
import org.apache.directory.api.ldap.model.entry.Entry;
@@ -93,6 +94,7 @@ public class CursorList extends AbstractCursor<Entry> implements EntryFilteringC
* @param start the lower bound index
* @param list the list this ListCursor operates on
* @param end the upper bound index
+ * @param searchContext The SearchContext instance
*/
public CursorList( int start, List<EntryFilteringCursor> list, int end, SearchOperationContext searchContext )
{
@@ -142,6 +144,7 @@ public class CursorList extends AbstractCursor<Entry> implements EntryFilteringC
* acquired from the size of the list.
*
* @param list the backing for this ListCursor
+ * @param searchContext The SearchContext instance
*/
public CursorList( List<EntryFilteringCursor> list, SearchOperationContext searchContext )
{
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/filtering/EntryFilter.java b/core-api/src/main/java/org/apache/directory/server/core/api/filtering/EntryFilter.java
index 04e1e69..3857085 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/filtering/EntryFilter.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/filtering/EntryFilter.java
@@ -28,7 +28,7 @@ import org.apache.directory.server.core.api.interceptor.context.SearchOperationC
/**
* An entry filter is used to modify search results while they are being
* returned from Cursors over ServerEntry objects. These filters are used in
- * conjunction with a {@link FilteringCursor}. Multiple filters can be
+ * conjunction with a FilteringCursor. Multiple filters can be
* applied one after the other and hence they are stack-able and applied in
* order.
*
@@ -43,10 +43,10 @@ public interface EntryFilter
* should be cloned when alterations are made to avoid altering cached
* entries.
*
+ * @param operation The SeachOperationContext instance
* @param result the result to accept or reject possibly modifying it
- * @param controls search controls associated with the invocation
* @return true if the entry is to be returned, false if it is rejected
- * @throws Exception if there are failures during evaluation
+ * @throws LdapException if there are failures during evaluation
*/
boolean accept( SearchOperationContext operation, Entry result ) throws LdapException;
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/filtering/EntryFilteringCursorImpl.java b/core-api/src/main/java/org/apache/directory/server/core/api/filtering/EntryFilteringCursorImpl.java
index 3172ee9..7a0c775 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/filtering/EntryFilteringCursorImpl.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/filtering/EntryFilteringCursorImpl.java
@@ -86,8 +86,8 @@ public class EntryFilteringCursorImpl extends AbstractCursor<Entry> implements E
* single filter initially: more can be added later after creation.
*
* @param wrapped the underlying wrapped Cursor whose entries are filtered
- * @param searchControls the controls of search that created this Cursor
- * @param invocation the search operation invocation creating this Cursor
+ * @param schemaManager The SchemaManager instance
+ * @param operationContext The OperationContext instance
* @param filter a single filter to be used
*/
public EntryFilteringCursorImpl( Cursor<Entry> wrapped,
@@ -102,9 +102,8 @@ public class EntryFilteringCursorImpl extends AbstractCursor<Entry> implements E
* no filter initially: more can be added later after creation.
*
* @param wrapped the underlying wrapped Cursor whose entries are filtered
- * @param searchControls the controls of search that created this Cursor
- * @param invocation the search operation invocation creating this Cursor
- * @param filter a single filter to be used
+ * @param operationContext The OperationContext instance
+ * @param schemaManager The SchemaManager instance
*/
public EntryFilteringCursorImpl( Cursor<Entry> wrapped, SearchOperationContext operationContext,
SchemaManager schemaManager )
@@ -127,7 +126,7 @@ public class EntryFilteringCursorImpl extends AbstractCursor<Entry> implements E
*
* @param wrapped the underlying wrapped Cursor whose entries are filtered
* @param operationContext the operation context that created this Cursor
- * @param invocation the search operation invocation creating this Cursor
+ * @param schemaManager The SchemaManager instance
* @param filters a list of filters to be used
*/
public EntryFilteringCursorImpl( Cursor<Entry> wrapped,
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/interceptor/Interceptor.java b/core-api/src/main/java/org/apache/directory/server/core/api/interceptor/Interceptor.java
index f289b0b..4abab51 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/interceptor/Interceptor.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/interceptor/Interceptor.java
@@ -37,22 +37,23 @@ import org.apache.directory.server.core.api.interceptor.context.MoveOperationCon
import org.apache.directory.server.core.api.interceptor.context.RenameOperationContext;
import org.apache.directory.server.core.api.interceptor.context.SearchOperationContext;
import org.apache.directory.server.core.api.interceptor.context.UnbindOperationContext;
+import org.apache.directory.server.core.api.partition.Partition;
/**
- * Filters invocations on {@link DefaultPartitionNexus}. {@link Interceptor}
- * filters most method calls performed on {@link DefaultPartitionNexus} just
+ * Filters invocations on DefaultPartitionNexus. Interceptor
+ * filters most method calls performed on DefaultPartitionNexus just
* like Servlet filters do.
- * <p/>
+ *
* <h2>Interceptor Chaining</h2>
*
* Interceptors should usually pass the control
* of current invocation to the next interceptor by calling an appropriate method
- * on {@link NextInterceptor}. The flow control is returned when the next
+ * on NextInterceptor. The flow control is returned when the next
* interceptor's filter method returns. You can therefore implement pre-, post-,
* around- invocation handler by how you place the statement. Otherwise, you
* can transform the invocation into other(s).
- * <p/>
+ *
* <h3>Pre-invocation Filtering</h3>
* <pre>
* public void delete( NextInterceptor nextInterceptor, Name name )
@@ -61,7 +62,7 @@ import org.apache.directory.server.core.api.interceptor.context.UnbindOperationC
* nextInterceptor.delete( name );
* }
* </pre>
- * <p/>
+ *
* <h3>Post-invocation Filtering</h3>
* <pre>
* public void delete( NextInterceptor nextInterceptor, Name name )
@@ -70,7 +71,7 @@ import org.apache.directory.server.core.api.interceptor.context.UnbindOperationC
* System.out.println( "Invocation ended." );
* }
* </pre>
- * <p/>
+ *
* <h3>Around-invocation Filtering</h3>
* <pre>
* public void delete( NextInterceptor nextInterceptor, Name name )
@@ -87,7 +88,7 @@ import org.apache.directory.server.core.api.interceptor.context.UnbindOperationC
* }
* }
* </pre>
- * <p/>
+ *
* <h3>Transforming invocations</h3>
* <pre>
* public void delete( NextInterceptor nextInterceptor, Name name )
@@ -110,8 +111,10 @@ public interface Interceptor
/**
- * Intializes this interceptor.
- * @throws Exception
+ * Intializes this interceptor.
+ *
+ * @param directoryService The DirectoryService instance
+ * @throws LdapException If the initialization failed
*/
void init( DirectoryService directoryService ) throws LdapException;
@@ -124,35 +127,45 @@ public interface Interceptor
/**
* Filters {@link Partition#add( AddOperationContext )} call.
- * @param addContext The {@link AddOperationContext} instance
*
+ * @param addContext The {@link AddOperationContext} instance
* @throws LdapException If we had some error while processing the Add operation
*/
void add( AddOperationContext addContext ) throws LdapException;
/**
- * Filters {@link Partition#bind( BindOperationContext )} call.
+ * Filters {@link BindOperationContext} call.
+ *
+ * @param bindContext The {@link BindOperationContext} instance
+ * @throws LdapException If we had some error while processing the Bind operation
*/
void bind( BindOperationContext bindContext ) throws LdapException;
/**
- * Filters {@link DefaultPartitionNexus#compare( CompareOperationContext )} call.
+ * Filters Compare call.
+ *
+ * @param compareContext The {@link CompareOperationContext} instance
+ * @throws LdapException If we had some error while processing the Compare operation
+ * @return <tt>true</tt> if teh comparaison is successful
*/
boolean compare( CompareOperationContext compareContext ) throws LdapException;
/**
* Filters {@link Partition#delete( DeleteOperationContext )} call.
+ *
+ * @param deleteContext The {@link DeleteOperationContext} instance
+ * @throws LdapException If we had some error while processing the Delete operation
*/
void delete( DeleteOperationContext deleteContext ) throws LdapException;
/**
- * Filters {@link DefaultPartitionNexus#getRootDse( GetRootDseOperationContext )} call.
+ * Filters getRootDse call.
*
- * @param getRootDseContext The getRoot() operation context
+ * @param getRootDseContext The getRootDSE operation context
* @return The RootDSE entry, if found
* @throws LdapException If we can't get back the RootDSE entry
*/
@@ -161,48 +174,75 @@ public interface Interceptor
/**
* Filters {@link Partition#hasEntry( HasEntryOperationContext )} call.
+ *
+ * @param hasEntryContext The {@link HasEntryOperationContext} instance
+ * @throws LdapException If we had some error while processing the HasEntry operation
+ * @return <tt>true</tt> f the entry is present in the DIT
*/
boolean hasEntry( HasEntryOperationContext hasEntryContext ) throws LdapException;
/**
* Filters {@link Partition#lookup( LookupOperationContext )} call.
+ *
+ * @param lookupContext The {@link LookupOperationContext} instance
+ * @throws LdapException If we had some error while processing the Lookup operation
+ * @return The found entry
*/
Entry lookup( LookupOperationContext lookupContext ) throws LdapException;
/**
* Filters {@link Partition#modify( ModifyOperationContext )} call.
+ *
+ * @param modifyContext The {@link ModifyOperationContext} instance
+ * @throws LdapException If we had some error while processing the Modify operation
*/
void modify( ModifyOperationContext modifyContext ) throws LdapException;
/**
* Filters {@link Partition#move( MoveOperationContext )} call.
+ *
+ * @param moveContext The {@link MoveOperationContext} instance
+ * @throws LdapException If we had some error while processing the Move operation
*/
void move( MoveOperationContext moveContext ) throws LdapException;
/**
- * Filters {@link Partition#moveAndRename( MoveAndRenameOperationContext) } call.
+ * Filters MoveAndRename call.
+ *
+ * @param moveAndRenameContext The {@link moveAndRenameOperationContext} instance
+ * @throws LdapException If we had some error while processing the MoveAndRename operation
*/
void moveAndRename( MoveAndRenameOperationContext moveAndRenameContext ) throws LdapException;
/**
* Filters {@link Partition#rename( RenameOperationContext )} call.
+ *
+ * @param renameContext The {@link RenameOperationContext} instance
+ * @throws LdapException If we had some error while processing the Rename operation
*/
void rename( RenameOperationContext renameContext ) throws LdapException;
/**
* Filters {@link Partition#search( SearchOperationContext )} call.
+ *
+ * @param searchContext The {@link SearchOperationContext} instance
+ * @throws LdapException If we had some error while processing the Search operation
+ * @return A cursror over the found entries
*/
EntryFilteringCursor search( SearchOperationContext searchContext ) throws LdapException;
/**
* Filters {@link Partition#unbind( UnbindOperationContext )} call.
+ *
+ * @param unbindContext The {@link UnbindOperationContext} instance
+ * @throws LdapException If we had some error while processing the Unbind operation
*/
void unbind( UnbindOperationContext unbindContext ) throws LdapException;
}
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/interceptor/context/BindOperationContext.java b/core-api/src/main/java/org/apache/directory/server/core/api/interceptor/context/BindOperationContext.java
index bcf64c5..8ca70e3 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/interceptor/context/BindOperationContext.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/interceptor/context/BindOperationContext.java
@@ -80,11 +80,13 @@ public class BindOperationContext extends AbstractOperationContext
/**
* @return The authentication level. One of :
+ * <ul>
* <li>ANONYMOUS</li>
* <li>SIMPLE</li>
* <li>STRONG (sasl)</li>
* <li>UNAUTHENT</li>
* <li>INVALID</li>
+ * </ul>
*/
public AuthenticationLevel getAuthenticationLevel() throws LdapAuthenticationException
{
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/normalization/FilterNormalizingVisitor.java b/core-api/src/main/java/org/apache/directory/server/core/api/normalization/FilterNormalizingVisitor.java
index 9446124..af41653 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/normalization/FilterNormalizingVisitor.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/normalization/FilterNormalizingVisitor.java
@@ -416,8 +416,8 @@ public class FilterNormalizingVisitor implements FilterVisitor
* - SubStringNode ( attr = *X*Y* )
* - ApproximateNode ( attr ~= value )
* - EqualityNode ( attr = value )
- * - GreaterEqNode ( attr >= value )
- * - LessEqNode ( attr <= value )
+ * - GreaterEqNode ( attr >= value )
+ * - LessEqNode ( attr <= value )
*
* The PresencNode is managed differently from other nodes, as it just check
* for the attribute, not the value.
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/partition/Partition.java b/core-api/src/main/java/org/apache/directory/server/core/api/partition/Partition.java
index ad126fe..bb3fccd 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/partition/Partition.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/partition/Partition.java
@@ -60,12 +60,16 @@ public interface Partition
/**
* Start a read transaction
+ *
+ * @return a read transaction instance
*/
PartitionReadTxn beginReadTransaction();
/**
* Start a write transaction
+ *
+ * @return A write transaction instance
*/
PartitionWriteTxn beginWriteTransaction();
@@ -101,7 +105,7 @@ public interface Partition
/**
* Sets the schema manager assigned to this Partition.
*
- * @param registries the manager to assign to this Partition.
+ * @param schemaManager The SchemaManager instance
*/
void setSchemaManager( SchemaManager schemaManager );
@@ -111,9 +115,9 @@ public interface Partition
// -----------------------------------------------------------------------
/**
- * Initializes this partition. {@link #isInitialized()} will return <tt>true</tt> if
- * {@link #doInit()} returns without any errors. {@link #destroy()} is called automatically
- * as a clean-up process if {@link #doInit()} throws an exception.
+ * Initializes this partition. <code>isInitialized()</code> will return <tt>true</tt> if
+ * <code>doInit()</code> returns without any errors. <code>destroy()</code> is called automatically
+ * as a clean-up process if <code>doInit()</code> throws an exception.
*
* @throws LdapException if initialization fails in any way
*/
@@ -142,6 +146,7 @@ public interface Partition
* Sets the suffix Dn, must be normalized.
*
* @param suffixDn the new suffix Dn
+ * @throws LdapInvalidDnException If the Dn is invalid
*/
void setSuffixDn( Dn suffixDn ) throws LdapInvalidDnException;
@@ -149,20 +154,25 @@ public interface Partition
/**
* Instructs this Partition to synchronize with it's persistent store, and
* destroy all held resources, in preparation for a shutdown event.
+ *
+ * @param partitionTxn The transaction to use
+ * @throws LdapException If we can't destroy the partition
*/
void destroy( PartitionTxn partitionTxn ) throws LdapException;
/**
* Checks to see if this partition is initialized or not.
- * @return true if the partition is initialized, false otherwise
+ *
+ * @return <tt>true</tt> if the partition is initialized, false otherwise
*/
boolean isInitialized();
/**
* Flushes any changes made to this partition now.
- * @throws Exception if buffers cannot be flushed to disk
+ *
+ * @throws LdapException if buffers cannot be flushed to disk
*/
void sync() throws LdapException;
@@ -174,7 +184,7 @@ public interface Partition
* @param deleteContext the context of the entry to
* delete from this ContextPartition.
* @return The delete Entry, if found
- * @throws Exception if there are any problems
+ * @throws LdapException if there are any problems
*/
Entry delete( DeleteOperationContext deleteContext ) throws LdapException;
@@ -195,12 +205,7 @@ public interface Partition
* to perform on the entry which is one of constants specified by the
* DirContext interface:
* <code>ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE</code>.
- *
- * @throws Exception if there are any problems
- * @see javax.naming.directory.DirContext
- * @see javax.naming.directory.DirContext#ADD_ATTRIBUTE
- * @see javax.naming.directory.DirContext#REMOVE_ATTRIBUTE
- * @see javax.naming.directory.DirContext#REPLACE_ATTRIBUTE
+ * @throws LdapException if there are any problems
*/
void modify( ModifyOperationContext modifyContext ) throws LdapException;
@@ -214,8 +219,8 @@ public interface Partition
* Controls.
*
* @param searchContext The context containing the information used by the operation
- * @throws Exception if there are any problems
* @return a NamingEnumeration containing objects of type
+ * @throws LdapException if there are any problems
*/
EntryFilteringCursor search( SearchOperationContext searchContext ) throws LdapException;
@@ -230,7 +235,7 @@ public interface Partition
*
* @param lookupContext The context containing the parameters
* @return an Attributes object representing the entry
- * @throws Exception if there are any problems
+ * @throws LdapException if there are any problems
*/
Entry lookup( LookupOperationContext lookupContext ) throws LdapException;
@@ -240,7 +245,7 @@ public interface Partition
*
* @param hasEntryContext The context used to pass informations
* @return true if the entry exists, false if it does not
- * @throws Exception if there are any problems
+ * @throws LdapException if there are any problems
*/
boolean hasEntry( HasEntryOperationContext hasEntryContext ) throws LdapException;
@@ -252,7 +257,7 @@ public interface Partition
* if it is irrelevant.
*
* @param renameContext the modify Dn context
- * @throws Exception if there are any problems
+ * @throws LdapException if there are any problems
*/
void rename( RenameOperationContext renameContext ) throws LdapException;
@@ -262,7 +267,7 @@ public interface Partition
* parent entry.
*
* @param moveContext The context containing the DNs to move
- * @throws Exception if there are any problems
+ * @throws LdapException if there are any problems
*/
void move( MoveOperationContext moveContext ) throws LdapException;
@@ -277,7 +282,7 @@ public interface Partition
*
* @param moveAndRenameContext The context contain all the information about
* the modifyDN operation
- * @throws Exception if there are any problems
+ * @throws LdapException if there are any problems
*/
void moveAndRename( MoveAndRenameOperationContext moveAndRenameContext ) throws LdapException;
@@ -288,13 +293,16 @@ public interface Partition
* interested in implementing virtual directories with ApacheDS.
*
* @param unbindContext the context used to unbind
- * @throws Exception if something goes wrong
+ * @throws LdapException if something goes wrong
*/
void unbind( UnbindOperationContext unbindContext ) throws LdapException;
/**
* Dump the requested index to a given stream
+ *
+ * @param partitionTxn The transaction to use
+ * @param stream The Stream used to dump the index
* @param name The index to dump to stdout
* @throws IOException if we can't write the data
*/
@@ -302,22 +310,27 @@ public interface Partition
/**
- * set the Cache service
+ * Set the Cache service
*
- * @param cacheService
+ * @param cacheService The CacheService instance
*/
void setCacheService( CacheService cacheService );
/**
+ * Get the contextCSN
+ *
+ * @param partitionTxn The transaction to use
* @return the current highest committed CSN value
*/
String getContextCsn( PartitionTxn partitionTxn );
/**
- * saves the context CSN value in the context entry of the partition
- * @throws Exception
+ * Saves the context CSN value in the context entry of the partition
+ *
+ * @param partitionTxn The transaction to use
+ * @throws LdapException If the context can't be saved
*/
void saveContextCsn( PartitionTxn partitionTxn ) throws LdapException;
@@ -325,6 +338,7 @@ public interface Partition
/**
* Return the number of children and subordinates for a given entry
*
+ * @param partitionTxn The transaction to use
* @param entry The entry
* @return The Subordinate instance that contains the values.
* @throws LdapException If we had an issue while processing the request
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/partition/PartitionNexus.java b/core-api/src/main/java/org/apache/directory/server/core/api/partition/PartitionNexus.java
index 39935e6..9cd82b4 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/partition/PartitionNexus.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/partition/PartitionNexus.java
@@ -72,7 +72,7 @@ public interface PartitionNexus extends Partition
* Add a partition to the server.
*
* @param Partition The Partition to add
- * @throws Exception If the addition can't be done
+ * @throws LdapException If the addition can't be done
*/
void addContextPartition( Partition partition ) throws LdapException;
@@ -81,7 +81,7 @@ public interface PartitionNexus extends Partition
* Remove a partition from the server.
*
* @param partitionDn the partition Dn
- * @throws Exception If the removal can't be done
+ * @throws LdapException If the removal can't be done
*/
void removeContextPartition( String partitionDn ) throws LdapException;
@@ -94,7 +94,7 @@ public interface PartitionNexus extends Partition
*
* @param dn the normalized distinguished name to get a partition for
* @return the partition containing the entry represented by the dn
- * @throws Exception if there is no partition for the dn
+ * @throws LdapException if there is no partition for the dn
*/
Partition getPartition( Dn dn ) throws LdapException;
@@ -107,6 +107,7 @@ public interface PartitionNexus extends Partition
* @param The Dn we want to find the suffix from
* @return the suffix portion of dn, or the valid empty string Dn if no
* naming context was found for dn.
+ * @throws LdapException If we can't get the suffix Dn
*/
Dn getSuffixDn( Dn dn ) throws LdapException;
@@ -116,7 +117,7 @@ public interface PartitionNexus extends Partition
* {@link DefaultPartitionNexus}.
*
* @return Iteration over ContextPartition suffix names as Names.
- * @throws Exception if there are any problems
+ * @throws LdapException if there are any problems
*/
Set<String> listSuffixes() throws LdapException;
@@ -126,6 +127,7 @@ public interface PartitionNexus extends Partition
*
* @param extensionOids a set of OID strings to add to the supportedExtension
* attribute in the RootDSE
+ * @throws LdapException If we cannot register the extensions
*/
void registerSupportedExtensions( Set<String> extensionOids ) throws LdapException;
@@ -133,8 +135,9 @@ public interface PartitionNexus extends Partition
/**
* Adds a set of supportedSaslMechanisms (OID Strings) to the RootDSE.
*
- * @param extensionOids a set of OID strings to add to the supportedSaslMechanisms
+ * @param supportedSaslMechanisms a set of OID strings to add to the supportedSaslMechanisms
* attribute in the RootDSE
+ * @throws LdapException If we cannot fetch the supported SASL mechanism
*/
void registerSupportedSaslMechanisms( Set<String> supportedSaslMechanisms ) throws LdapException;
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/RegistrySynchronizer.java b/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/RegistrySynchronizer.java
index 6e273c3..1d18536 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/RegistrySynchronizer.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/RegistrySynchronizer.java
@@ -46,7 +46,7 @@ public interface RegistrySynchronizer
* Adds a new SchemaObject to its registry
*
* @param entry The SchemObject to add
- * @throws Exception If the addition failed
+ * @throws LdapException If the addition failed
*/
void add( Entry entry ) throws LdapException;
@@ -56,7 +56,7 @@ public interface RegistrySynchronizer
*
* @param entry The entry associated with the SchemaObject to delete
* @param cascaded unused
- * @throws Exception If the deletion failed
+ * @throws LdapException If the deletion failed
*/
void delete( Entry entry, boolean cascaded ) throws LdapException;
@@ -67,7 +67,7 @@ public interface RegistrySynchronizer
* @param entry The entry to be renamed
* @param newRdn The new entry name
* @param cascaded unused
- * @throws Exception If the rename failed
+ * @throws LdapException If the rename failed
*/
void rename( Entry entry, Rdn newRdn, boolean cascaded ) throws LdapException;
@@ -79,7 +79,7 @@ public interface RegistrySynchronizer
* @param targetEntry The modified entry
* @param cascaded Unused
* @return True if the modification has been done
- * @throws Exception If the modification failed
+ * @throws LdapException If the modification failed
*/
boolean modify( ModifyOperationContext modifyContext, Entry targetEntry, boolean cascaded )
throws LdapException;
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/RegistrySynchronizerAdaptor.java b/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/RegistrySynchronizerAdaptor.java
index edb914a..7f3f6f5 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/RegistrySynchronizerAdaptor.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/RegistrySynchronizerAdaptor.java
@@ -156,7 +156,7 @@ public class RegistrySynchronizerAdaptor
* Add a new SchemaObject or a new Schema in the Schema partition.
*
* @param addContext The Add context, containing the entry to be added
- * @throws Exception If the addition failed
+ * @throws LdapException If the addition failed
*/
public void add( AddOperationContext addContext ) throws LdapException
{
@@ -278,7 +278,7 @@ public class RegistrySynchronizerAdaptor
* @param modifyContext The context
* @param targetEntry The modified entry
* @param doCascadeModify Not used
- * @throws Exception If the modification failed
+ * @throws LdapException If the modification failed
*/
public boolean modify( ModifyOperationContext modifyContext, Entry targetEntry, boolean doCascadeModify )
throws LdapException
@@ -319,7 +319,7 @@ public class RegistrySynchronizerAdaptor
*
* @param renameContext The contect contaoning the rename informations
* @param doCascadeModify unused
- * @throws Exception If the rename failed
+ * @throws LdapException If the rename failed
*/
public void rename( RenameOperationContext renameContext, boolean doCascadeModify )
throws LdapException
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/SchemaSynchronizer.java b/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/SchemaSynchronizer.java
index 508cc1b..f659d50 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/SchemaSynchronizer.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/schema/registries/synchronizers/SchemaSynchronizer.java
@@ -53,7 +53,7 @@ import org.slf4j.LoggerFactory;
* This class handle modifications made on a global schema. Modifications made
* on SchemaObjects are handled by the specific shcemaObject synchronizers.
*
- * @todo poorly implemented - revisit the SchemaChangeHandler for this puppy
+ * TODO poorly implemented - revisit the SchemaChangeHandler for this puppy
* and do it right.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
@@ -152,8 +152,8 @@ public class SchemaSynchronizer implements RegistrySynchronizer
/**
* Handles the addition of a metaSchema object to the schema partition.
*
- * @param name the dn of the new metaSchema object
* @param entry the attributes of the new metaSchema object
+ * @throws LdapException If the add failed
*/
@Override
public void add( Entry entry ) throws LdapException
@@ -222,8 +222,9 @@ public class SchemaSynchronizer implements RegistrySynchronizer
* simply removes the schema from the loaded schema map of the global
* registries.
*
- * @param name the dn of the metaSchema object being deleted
* @param entry the attributes of the metaSchema object
+ * @param cascade If we have to process recursively
+ * @throws LdapException If the delete failed
*/
@Override
public void delete( Entry entry, boolean cascade ) throws LdapException
@@ -255,9 +256,10 @@ public class SchemaSynchronizer implements RegistrySynchronizer
* changed. Changes all the schema entities associated with the
* renamed schema so they now map to a new schema name.
*
- * @param name the dn of the metaSchema object renamed
* @param entry the entry of the metaSchema object before the rename
* @param newRdn the new commonName of the metaSchema object
+ * @param cascade If we have to process recursively
+ * @throws LdapException If the rename failed
*/
@Override
public void rename( Entry entry, Rdn newRdn, boolean cascade ) throws LdapException
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/subtree/SubentryCache.java b/core-api/src/main/java/org/apache/directory/server/core/api/subtree/SubentryCache.java
index 0093655..b8f8fb2 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/subtree/SubentryCache.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/subtree/SubentryCache.java
@@ -109,7 +109,7 @@ public class SubentryCache implements Iterable<Dn>
* Stores a new Subentry into the cache, associated with a Dn
*
* @param dn The Subentry Dn
- * @param ss The SubtreeSpecification
+ * @param subentry The SubtreeSpecification
* @param adminRoles The administrative roles for this Subentry
* @return The old Subentry, if any
*/
diff --git a/core-api/src/main/java/org/apache/directory/server/core/api/subtree/SubentryUtils.java b/core-api/src/main/java/org/apache/directory/server/core/api/subtree/SubentryUtils.java
index 3ba9d75..53f728e 100644
--- a/core-api/src/main/java/org/apache/directory/server/core/api/subtree/SubentryUtils.java
+++ b/core-api/src/main/java/org/apache/directory/server/core/api/subtree/SubentryUtils.java
@@ -64,7 +64,7 @@ public class SubentryUtils
* @param dn the normalized distinguished name of the entry
* @param entryAttrs the entry attributes are generated for
* @return the set of subentry op attrs for an entry
- * @throws Exception if there are problems accessing entry information
+ * @throws LdapException if there are problems accessing entry information
*/
public Entry getSubentryAttributes( Dn dn, Entry entryAttrs ) throws LdapException
{
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 d3e560c..5975189 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
@@ -83,7 +83,7 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
* {@inheritDoc}
*/
@Override
- public Tag tag( long revision ) throws Exception
+ public Tag tag( long revision )
{
if ( tags.containsKey( revision ) )
{
@@ -92,6 +92,7 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
latest = new Tag( revision, null );
tags.put( revision, latest );
+
return latest;
}
@@ -100,7 +101,7 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
* {@inheritDoc}
*/
@Override
- public Tag tag() throws Exception
+ public Tag tag()
{
if ( ( latest != null ) && ( latest.getRevision() == currentRevision ) )
{
@@ -113,8 +114,11 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
}
+ /**
+ * {@inheritDoc}
+ */
@Override
- public Tag tag( String description ) throws Exception
+ public Tag tag( String description )
{
if ( ( latest != null ) && ( latest.getRevision() == currentRevision ) )
{
@@ -127,6 +131,9 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void init( DirectoryService service ) throws LdapException
{
@@ -438,6 +445,9 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void sync() throws LdapException
{
@@ -473,6 +483,9 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public long getCurrentRevision()
{
@@ -484,12 +497,13 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
* {@inheritDoc}
*/
@Override
- public ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, LdifEntry reverse ) throws Exception
+ public ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, LdifEntry reverse )
{
currentRevision++;
ChangeLogEvent event = new ChangeLogEvent( currentRevision, DateUtils.getGeneralizedTime(),
principal, forward, reverse );
events.add( event );
+
return event;
}
@@ -498,18 +512,22 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
* {@inheritDoc}
*/
@Override
- public ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, List<LdifEntry> reverses ) throws Exception
+ public ChangeLogEvent log( LdapPrincipal principal, LdifEntry forward, List<LdifEntry> reverses )
{
currentRevision++;
ChangeLogEvent event = new ChangeLogEvent( currentRevision, DateUtils.getGeneralizedTime(),
principal, forward, reverses );
events.add( event );
+
return event;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
- public ChangeLogEvent lookup( long revision ) throws Exception
+ public ChangeLogEvent lookup( long revision )
{
if ( revision < 0 )
{
@@ -525,56 +543,71 @@ public class MemoryChangeLogStore implements TaggableChangeLogStore
}
+ /**
+ * {@inheritDoc}
+ */
@Override
- public Cursor<ChangeLogEvent> find() throws Exception
+ public Cursor<ChangeLogEvent> find()
{
return new ListCursor<>( events );
}
+ /**
+ * {@inheritDoc}
+ */
@Override
- public Cursor<ChangeLogEvent> findBefore( long revision ) throws Exception
+ public Cursor<ChangeLogEvent> findBefore( long revision )
{
return new ListCursor<>( events, ( int ) revision );
}
+ /**
+ * {@inheritDoc}
+ */
@Override
- public Cursor<ChangeLogEvent> findAfter( long revision ) throws LdapException
+ public Cursor<ChangeLogEvent> findAfter( long revision )
{
return new ListCursor<>( ( int ) revision, events );
}
+ /**
+ * {@inheritDoc}
+ */
@Override
- public Cursor<ChangeLogEvent> find( long startRevision, long endRevision ) throws Exception
+ public Cursor<ChangeLogEvent> find( long startRevision, long endRevision )
{
return new ListCursor<>( ( int ) startRevision, events, ( int ) ( endRevision + 1 ) );
}
+ /**
+ * {@inheritDoc}
+ */
@Override
- public Tag getLatest() throws LdapException
+ public Tag getLatest()
{
return latest;
}
/**
- * @see TaggableChangeLogStore#removeTag(long)
+ * {@inheritDoc}
*/
@Override
- public Tag removeTag( long revision ) throws Exception
+ public Tag removeTag( long revision )
{
return tags.remove( revision );
}
/**
- * @see TaggableChangeLogStore#tag(long, String)
+ * {@inheritDoc}
*/
@Override
- public Tag tag( long revision, String descrition ) throws Exception
+ public Tag tag( long revision, String descrition )
{
if ( tags.containsKey( revision ) )
{
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/decoder/MailExchangeRecordDecoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/decoder/MailExchangeRecordDecoder.java
index e29ef2b..f0af8b3 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/decoder/MailExchangeRecordDecoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/decoder/MailExchangeRecordDecoder.java
@@ -50,7 +50,7 @@ import org.apache.mina.core.buffer.IoBuffer;
* others at the same owner. Lower values are preferred.
*
* EXCHANGE
- * A <domain-name> which specifies a host willing to act as a mail exchange
+ * A <domain-name> which specifies a host willing to act as a mail exchange
* for the owner name.
* </pre>
*
@@ -60,7 +60,7 @@ public class MailExchangeRecordDecoder implements RecordDecoder
{
public Map<String, Object> decode( IoBuffer byteBuffer, short length ) throws IOException
{
- Map<String, Object> attributes = new HashMap<String, Object>();
+ Map<String, Object> attributes = new HashMap<>();
attributes.put( Strings.toLowerCaseAscii( DnsAttribute.MX_PREFERENCE ), byteBuffer.getShort() );
attributes.put( Strings.toLowerCaseAscii( DnsAttribute.DOMAIN_NAME ), DnsMessageDecoder.getDomainName( byteBuffer ) );
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/decoder/NameServerRecordDecoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/decoder/NameServerRecordDecoder.java
index 6bc845f..b996883 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/decoder/NameServerRecordDecoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/decoder/NameServerRecordDecoder.java
@@ -44,7 +44,7 @@ import org.apache.mina.core.buffer.IoBuffer;
* where:
*
* NSDNAME
- * A <domain-name> which specifies a host which should be authoritative for
+ * A <domain-name> which specifies a host which should be authoritative for
* the specified class and domain.
* </pre>
*
@@ -54,7 +54,7 @@ public class NameServerRecordDecoder implements RecordDecoder
{
public Map<String, Object> decode( IoBuffer byteBuffer, short length ) throws IOException
{
- Map<String, Object> map = new HashMap<String, Object>();
+ Map<String, Object> map = new HashMap<>();
map.put( Strings.toLowerCaseAscii( DnsAttribute.DOMAIN_NAME ), DnsMessageDecoder.getDomainName( byteBuffer ) );
return map;
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/CanonicalNameRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/CanonicalNameRecordEncoder.java
index 1e86ce4..d844acb 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/CanonicalNameRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/CanonicalNameRecordEncoder.java
@@ -36,7 +36,7 @@ import org.apache.mina.core.buffer.IoBuffer;
*
* where:
*
- * CNAME A <domain-name> which specifies the canonical or primary
+ * CNAME A <domain-name> which specifies the canonical or primary
* name for the owner. The owner name is an alias.
*
* CNAME RRs cause no additional section processing, but name servers may
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/DnameRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/DnameRecordEncoder.java
index 8a0a1f7..c58a818 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/DnameRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/DnameRecordEncoder.java
@@ -28,15 +28,15 @@ package org.apache.directory.server.dns.io.encoder;
*
* DNAME has the following format:
*
- * <owner> <ttl> <class> DNAME <target>
+ * <owner> <ttl> <class> DNAME <target>
*
* The format is not class-sensitive. All fields are required. The
- * RDATA field <target> is a <domain-name> [DNSIS].
+ * RDATA field <target> is a <domain-name> [DNSIS].
*
* The DNAME RR causes type NS additional section processing.
*
* The effect of the DNAME record is the substitution of the record's
- * <target> for its <owner> as a suffix of a domain name. A "no-
+ * <target> for its <owner> as a suffix of a domain name. A "no-
* descendants" limitation governs the use of DNAMEs in a zone file:
*
* If a DNAME RR is present at a node N, there may be other data at N
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/HostInformationRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/HostInformationRecordEncoder.java
index 7ba3bc7..c83ee52 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/HostInformationRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/HostInformationRecordEncoder.java
@@ -32,9 +32,9 @@ package org.apache.directory.server.dns.io.encoder;
*
* where:
*
- * CPU A <character-string> which specifies the CPU type.
+ * CPU A <character-string> which specifies the CPU type.
*
- * OS A <character-string> which specifies the operating
+ * OS A <character-string> which specifies the operating
* system type.
*
* Standard values for CPU and OS can be found in [RFC-1010].
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/KeyExchangeRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/KeyExchangeRecordEncoder.java
index 0bccfdc..1fd32cf 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/KeyExchangeRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/KeyExchangeRecordEncoder.java
@@ -39,7 +39,7 @@ package org.apache.directory.server.dns.io.encoder;
* preference given to this RR among other KX records
* at the same owner. Lower values are preferred.
*
- * EXCHANGER A <domain-name> which specifies a host willing to
+ * EXCHANGER A <domain-name> which specifies a host willing to
* act as a mail exchange for the owner name.
*
* KX records MUST cause type A additional section processing for the
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/LocationRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/LocationRecordEncoder.java
index 209f434..82cb71a 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/LocationRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/LocationRecordEncoder.java
@@ -55,7 +55,7 @@ package org.apache.directory.server.dns.io.encoder;
* integers, each ranging from zero to nine, with the most
* significant four bits representing the base and the second
* number representing the power of ten by which to multiply
- * the base. This allows sizes from 0e0 (<1cm) to 9e9
+ * the base. This allows sizes from 0e0 (<1cm) to 9e9
* (90,000km) to be expressed. This representation was chosen
* such that the hexadecimal representation can be read by
* eye; 0x15 = 1e5. Four-bit values greater than 9 are
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/MailExchangeRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/MailExchangeRecordEncoder.java
index b769ec2..92ac592 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/MailExchangeRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/MailExchangeRecordEncoder.java
@@ -42,7 +42,7 @@ import org.apache.mina.core.buffer.IoBuffer;
* this RR among others at the same owner. Lower values
* are preferred.
*
- * EXCHANGE A <domain-name> which specifies a host willing to act as
+ * EXCHANGE A <domain-name> which specifies a host willing to act as
* a mail exchange for the owner name.
*
* MX records cause type A additional section processing for the host
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/MailInformationRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/MailInformationRecordEncoder.java
index 7b414ee..d071fc9 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/MailInformationRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/MailInformationRecordEncoder.java
@@ -32,7 +32,7 @@ package org.apache.directory.server.dns.io.encoder;
*
* where:
*
- * RMAILBX A <domain-name> which specifies a mailbox which is
+ * RMAILBX A <domain-name> which specifies a mailbox which is
* responsible for the mailing list or mailbox. If this
* domain name names the root, the owner of the MINFO RR is
* responsible for itself. Note that many existing mailing
@@ -40,7 +40,7 @@ package org.apache.directory.server.dns.io.encoder;
* mailing list X, e.g., Msgroup-request for Msgroup. This
* field provides a more general mechanism.
*
- * EMAILBX A <domain-name> which specifies a mailbox which is to
+ * EMAILBX A <domain-name> which specifies a mailbox which is to
* receive error messages related to the mailing list or
* mailbox specified by the owner of the MINFO RR (similar
* to the ERRORS-TO: field which has been proposed). If
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/NameAuthorityPointerEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/NameAuthorityPointerEncoder.java
index 072f5a3..2b085ec 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/NameAuthorityPointerEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/NameAuthorityPointerEncoder.java
@@ -47,7 +47,7 @@ package org.apache.directory.server.dns.io.encoder;
* / /
* +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
*
- * <character-string> and <domain-name> as used here are defined in RFC
+ * <character-string> and <domain-name> as used here are defined in RFC
* 1035 [7].
*
* ORDER
@@ -87,7 +87,7 @@ package org.apache.directory.server.dns.io.encoder;
* records should be utilized to accomplish load balancing.
*
* FLAGS
- * A <character-string> containing flags to control aspects of the
+ * A <character-string> containing flags to control aspects of the
* rewriting and interpretation of the fields in the record. Flags
* are single characters from the set A-Z and 0-9. The case of the
* alphabetic characters is not significant. The field can be empty.
@@ -97,13 +97,13 @@ package org.apache.directory.server.dns.io.encoder;
* ones are terminal and which ones are not.
*
* SERVICES
- * A <character-string> that specifies the Service Parameters
+ * A <character-string> that specifies the Service Parameters
* applicable to this this delegation path. It is up to the
* Application Specification to specify the values found in this
* field.
*
* REGEXP
- * A <character-string> containing a substitution expression that is
+ * A <character-string> containing a substitution expression that is
* applied to the original string held by the client in order to
* construct the next domain name to lookup. See the DDDS Algorithm
* specification for the syntax of this field.
@@ -117,7 +117,7 @@ package org.apache.directory.server.dns.io.encoder;
* difficult to debug.
*
* REPLACEMENT
- * A <domain-name> which is the next domain-name to query for
+ * A <domain-name> which is the next domain-name to query for
* depending on the potential values found in the flags field. This
* field is used when the regular expression is a simple replacement
* operation. Any value in this field MUST be a fully qualified
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/NameServerRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/NameServerRecordEncoder.java
index 53aabbf..d355cf9 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/NameServerRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/NameServerRecordEncoder.java
@@ -36,7 +36,7 @@ import org.apache.mina.core.buffer.IoBuffer;
*
* where:
*
- * NSDNAME A <domain-name> which specifies a host which should be
+ * NSDNAME A <domain-name> which specifies a host which should be
* authoritative for the specified class and domain.
*
* NS records cause both the usual additional section processing to locate
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/PointerRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/PointerRecordEncoder.java
index c4eba29..bd40755 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/PointerRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/PointerRecordEncoder.java
@@ -35,7 +35,7 @@ import org.apache.mina.core.buffer.IoBuffer;
*
* where:
*
- * PTRDNAME A <domain-name> which points to some location in the
+ * PTRDNAME A <domain-name> which points to some location in the
* domain name space.
*
* PTR records cause no additional section processing. These RRs are used
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/ResourceRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/ResourceRecordEncoder.java
index 4508a76..8716e5b 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/ResourceRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/ResourceRecordEncoder.java
@@ -73,7 +73,7 @@ public abstract class ResourceRecordEncoder implements RecordEncoder
/**
- * <domain-name> is a domain name represented as a series of labels, and
+ * <domain-name> is a domain name represented as a series of labels, and
* terminated by a label with zero length.
*
* @param byteBuffer the ByteBuffer to encode the domain name into
@@ -116,8 +116,8 @@ public abstract class ResourceRecordEncoder implements RecordEncoder
/**
- * <character-string> is a single length octet followed by that number
- * of characters. <character-string> is treated as binary information,
+ * <character-string> is a single length octet followed by that number
+ * of characters. <character-string> is treated as binary information,
* and can be up to 256 characters in length (including the length octet).
*
* @param byteBuffer The byte buffer to encode the character string into.
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/StartOfAuthorityRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/StartOfAuthorityRecordEncoder.java
index ba269d6..2849b35 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/StartOfAuthorityRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/StartOfAuthorityRecordEncoder.java
@@ -53,10 +53,10 @@ import org.apache.mina.core.buffer.IoBuffer;
*
* where:
*
- * MNAME The <domain-name> of the name server that was the
+ * MNAME The <domain-name> of the name server that was the
* original or primary source of data for this zone.
*
- * RNAME A <domain-name> which specifies the mailbox of the
+ * RNAME A <domain-name> which specifies the mailbox of the
* person responsible for this zone.
*
* SERIAL The unsigned 32 bit version number of the original copy
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/TextRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/TextRecordEncoder.java
index 891f2c5..e9ae5b7 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/TextRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/TextRecordEncoder.java
@@ -35,7 +35,7 @@ import org.apache.mina.core.buffer.IoBuffer;
*
* where:
*
- * TXT-DATA One or more <character-string>s.
+ * TXT-DATA One or more <character-string>s.
*
* TXT RRs are used to hold descriptive text. The semantics of the text
* depends on the domain where it is found.
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/WellKnownServicesRecordEncoder.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/WellKnownServicesRecordEncoder.java
index 9c415f5..5ca64cd 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/WellKnownServicesRecordEncoder.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/io/encoder/WellKnownServicesRecordEncoder.java
@@ -30,7 +30,7 @@ package org.apache.directory.server.dns.io.encoder;
* | PROTOCOL | |
* +--+--+--+--+--+--+--+--+ |
* | |
- * / <BIT MAP> /
+ * / <BIT MAP> /
* / /
* +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
*
@@ -40,7 +40,7 @@ package org.apache.directory.server.dns.io.encoder;
*
* PROTOCOL An 8 bit IP protocol number
*
- * <BIT MAP> A variable length bit map. The bit map must be a
+ * <BIT MAP> A variable length bit map. The bit map must be a
* multiple of 8 bits long.
*
* The WKS record is used to describe the well known services supported by
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/store/jndi/DnsOperation.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/store/jndi/DnsOperation.java
index 328d5ab..27e5109 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/store/jndi/DnsOperation.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/store/jndi/DnsOperation.java
@@ -40,7 +40,7 @@ public interface DnsOperation
*
* @param ctx The context to execute the command with
* @param baseDn The base Dn for working with the context
- * @return Set<ResourceRecord> The result returned by the command
+ * @return The result returned by the command
* @throws Exception The exception thrown by the command
*/
Set<ResourceRecord> execute( DirContext ctx, Name baseDn ) throws Exception;
diff --git a/protocol-dns/src/main/java/org/apache/directory/server/dns/store/jndi/SearchStrategy.java b/protocol-dns/src/main/java/org/apache/directory/server/dns/store/jndi/SearchStrategy.java
index 7cf2304..7c65db1 100644
--- a/protocol-dns/src/main/java/org/apache/directory/server/dns/store/jndi/SearchStrategy.java
+++ b/protocol-dns/src/main/java/org/apache/directory/server/dns/store/jndi/SearchStrategy.java
@@ -40,9 +40,9 @@ interface SearchStrategy
/**
* Returns a set of {@link ResourceRecord}s, given a DNS {@link QuestionRecord}.
*
- * @param question
+ * @param question The DNS question
* @return The set of {@link ResourceRecord}s.
- * @throws Exception
+ * @throws DnsException If the records can't be found
*/
Set<ResourceRecord> getRecords( QuestionRecord question ) throws DnsException;
}
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/DirectoryBackedService.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/DirectoryBackedService.java
index a176a99..866f13e 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/DirectoryBackedService.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/DirectoryBackedService.java
@@ -53,6 +53,9 @@ public abstract class DirectoryBackedService extends AbstractProtocolService
/**
+ * Set the DirectoryService
+ *
+ * @param directoryService The DirectoryService instance
*/
public void setDirectoryService( DirectoryService directoryService )
{
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/MapAdapter.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/MapAdapter.java
index 5b386a6..2b1db21 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/MapAdapter.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/MapAdapter.java
@@ -47,7 +47,7 @@ public class MapAdapter implements Map<Object, Object>
/**
* Creates a new instance of MapAdapter.
*
- * @param dictionary
+ * @param dictionary The dictionary to store
*/
public MapAdapter( Dictionary<Object, Object> dictionary )
{
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/ProtocolService.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/ProtocolService.java
index 6a331ec..482650d 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/ProtocolService.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/ProtocolService.java
@@ -59,6 +59,7 @@ public interface ProtocolService
* If this protocol service supports UDP transport then this gets the
* non-null MINA DatagramAcceptor it uses.
*
+ * @param transport The Transport we are interested in
* @return the MINA DatagramAcceptor used for UDP transports
*/
DatagramAcceptor getDatagramAcceptor( Transport transport );
@@ -68,6 +69,7 @@ public interface ProtocolService
* If this protocol service support TCP transport then this gets the
* MINA SocketAcceptor it uses.
*
+ * @param transport The Transport we are interested in
* @return the MINA SocketAcceptor used for TCP transport
*/
SocketAcceptor getSocketAcceptor( Transport transport );
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/ServiceConfigurationException.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/ServiceConfigurationException.java
index 44030d4..723673e 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/ServiceConfigurationException.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/ServiceConfigurationException.java
@@ -21,6 +21,8 @@ package org.apache.directory.server.protocol.shared;
/**
+ * An exception for the Service configuration
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class ServiceConfigurationException extends RuntimeException
@@ -40,8 +42,8 @@ public class ServiceConfigurationException extends RuntimeException
/**
* Creates a new instance of ServiceConfigurationException.
*
- * @param message
- * @param cause
+ * @param message The exception's message
+ * @param cause The exception's cause
*/
public ServiceConfigurationException( String message, Throwable cause )
{
@@ -52,7 +54,7 @@ public class ServiceConfigurationException extends RuntimeException
/**
* Creates a new instance of ServiceConfigurationException.
*
- * @param message
+ * @param message The exception's message
*/
public ServiceConfigurationException( String message )
{
@@ -63,7 +65,7 @@ public class ServiceConfigurationException extends RuntimeException
/**
* Creates a new instance of ServiceConfigurationException.
*
- * @param cause
+ * @param cause The exception's cause
*/
public ServiceConfigurationException( Throwable cause )
{
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/StandardThreadPool.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/StandardThreadPool.java
index 0d0aa31..2197386 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/StandardThreadPool.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/StandardThreadPool.java
@@ -27,7 +27,9 @@ import java.util.concurrent.TimeUnit;
/**
- * @todo : Missing Javadoc
+ * TODO: Javadoc missing
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class StandardThreadPool implements Executor
{
@@ -53,6 +55,7 @@ public class StandardThreadPool implements Executor
public void stop()
{
delegate.shutdown();
+
for ( ;; )
{
try
@@ -67,6 +70,5 @@ public class StandardThreadPool implements Executor
//ignore
}
}
-
}
}
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/catalog/Catalog.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/catalog/Catalog.java
index 291099e..66d5ae6 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/catalog/Catalog.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/catalog/Catalog.java
@@ -31,7 +31,7 @@ public interface Catalog
/**
* Returns the base Dn for searches, given a zone or realm name.
*
- * @param name
+ * @param name The realm name
* @return The base Dn for searches.
*/
String getBaseDn( String name );
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/kerberos/GetPrincipal.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/kerberos/GetPrincipal.java
index 472a0b7..72b2a14 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/kerberos/GetPrincipal.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/kerberos/GetPrincipal.java
@@ -69,6 +69,11 @@ public class GetPrincipal
/**
* Note that the base is a relative path from the existing context.
* It is not a Dn.
+ *
+ * @param session The Session
+ * @param base The principal's Dn
+ * @return The found entry
+ * @throws Exception If the execution failed
*/
public Object execute( CoreSession session, Dn base ) throws Exception
{
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/store/LdifFileLoader.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/store/LdifFileLoader.java
index 014b40d..54f54bb 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/store/LdifFileLoader.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/store/LdifFileLoader.java
@@ -90,9 +90,9 @@ public class LdifFileLoader
/**
* Creates a new instance of LdifFileLoader.
*
- * @param coreSession
- * @param ldif
- * @param filters
+ * @param coreSession The CoreSession instance
+ * @param ldif The ldif file to load
+ * @param filters The search filter to use
*/
public LdifFileLoader( CoreSession coreSession, File ldif, List<? extends LdifLoadFilter> filters )
{
@@ -103,10 +103,10 @@ public class LdifFileLoader
/**
* Creates a new instance of LdifFileLoader.
*
- * @param coreSession
- * @param ldif
- * @param filters
- * @param loader
+ * @param coreSession The CoreSession instance
+ * @param ldif The ldif file to load
+ * @param filters The search filter to use
+ * @param loader The LdifLoader to use
*/
public LdifFileLoader( CoreSession coreSession, File ldif, List<? extends LdifLoadFilter> filters,
ClassLoader loader )
@@ -129,7 +129,7 @@ public class LdifFileLoader
/**
* Applies filters making sure failures in one filter do not effect another.
*
- * @param dn the Dn of the entry
+ * @param dn the Dn of the entry
* @param entry the attributes of the entry
* @return true if all filters passed the entry, false otherwise
*/
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/store/LdifLoadFilter.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/store/LdifLoadFilter.java
index 2c49b6a..4c71f6e 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/store/LdifLoadFilter.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/store/LdifLoadFilter.java
@@ -43,7 +43,7 @@ public interface LdifLoadFilter
* @param entry the entry attributes within the LDIF file
* @param coreSession session to be used for loading the entry into the DIT
* @return true if the entry will be created in the DIT, false if it is to be skipped
- * @throws LdapException
+ * @throws LdapException If the filtering failed
*/
boolean filter( File file, Dn dn, Entry entry, CoreSession coreSession ) throws LdapException;
}
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/transport/TcpTransport.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/transport/TcpTransport.java
index 443e280..ab02434 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/transport/TcpTransport.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/transport/TcpTransport.java
@@ -31,7 +31,7 @@ import org.slf4j.LoggerFactory;
/**
- * @todo : missing javadoc
+ * The Transport instance for TCP based protocols.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -111,7 +111,6 @@ public class TcpTransport extends AbstractTransport
* @param nbThreads The number of threads to create in the acceptor
* @param backLog The queue size for incoming messages, waiting for the
* acceptor to be ready
- * @throws UnknownHostException
*/
public TcpTransport( int tcpPort, int nbThreads, int backLog )
{
@@ -262,7 +261,7 @@ public class TcpTransport extends AbstractTransport
/**
* Set the list of enabled ciphers
*
- * @param enabledCiphers The list of enabled ciphers
+ * @param cipherSuite The list of enabled ciphers
*/
public void setEnabledCiphers( List<String> cipherSuite )
{
diff --git a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/transport/UdpTransport.java b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/transport/UdpTransport.java
index 1385e9f..20a673a 100644
--- a/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/transport/UdpTransport.java
+++ b/protocol-shared/src/main/java/org/apache/directory/server/protocol/shared/transport/UdpTransport.java
@@ -29,7 +29,7 @@ import org.slf4j.LoggerFactory;
/**
- * @todo : Missing Javadoc
+ * The Transport instance for UDP based protocols.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/