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 2016/12/01 18:18:40 UTC
svn commit: r1772245 - in
/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec:
./ api/ controls/search/entryChange/ controls/sort/ decorators/
Author: elecharny
Date: Thu Dec 1 18:18:40 2016
New Revision: 1772245
URL: http://svn.apache.org/viewvc?rev=1772245&view=rev
Log:
Added some missing Javadoc
Modified:
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/LdapMessageGrammar.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestContainer.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestGrammar.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestStates.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseContainer.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseGrammar.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseStates.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java
directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/LdapMessageGrammar.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/LdapMessageGrammar.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/LdapMessageGrammar.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/LdapMessageGrammar.java Thu Dec 1 18:18:40 2016
@@ -145,7 +145,6 @@ import org.slf4j.LoggerFactory;
* an action is to be added or modified, this is where the work is to be done !
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
- * @param <E> The Grammar type
*/
public final class LdapMessageGrammar extends
AbstractGrammar<LdapMessageContainer<MessageDecorator<? extends Message>>>
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedRequestDecorator.java Thu Dec 1 18:18:40 2016
@@ -90,7 +90,9 @@ public class ExtendedRequestDecorator<Q
/**
- * {@inheritDoc}
+ * Gets the Extended request payload
+ *
+ * @return The extended payload
*/
public byte[] getRequestValue()
{
@@ -99,7 +101,9 @@ public class ExtendedRequestDecorator<Q
/**
- * {@inheritDoc}
+ * sets the Extended request payload
+ *
+ * @param requestValue The extended payload
*/
public void setRequestValue( byte[] requestValue )
{
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ExtendedResponseDecorator.java Thu Dec 1 18:18:40 2016
@@ -88,7 +88,9 @@ public class ExtendedResponseDecorator<R
/**
- * {@inheritDoc}
+ * Gets the Extended response payload
+ *
+ * @return The extended payload
*/
public byte[] getResponseValue()
{
@@ -97,7 +99,9 @@ public class ExtendedResponseDecorator<R
/**
- * {@inheritDoc}
+ * sets the Extended response payload
+ *
+ * @param responseValue The extended payload
*/
public void setResponseValue( byte[] responseValue )
{
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/LdapApiService.java Thu Dec 1 18:18:40 2016
@@ -39,6 +39,7 @@ import org.apache.mina.filter.codec.Prot
*/
public interface LdapApiService
{
+ /** The default codec factory */
String DEFAULT_PROTOCOL_CODEC_FACTORY =
"org.apache.directory.api.ldap.codec.protocol.mina.LdapProtocolCodecFactory";
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/search/entryChange/EntryChangeDecorator.java Thu Dec 1 18:18:40 2016
@@ -48,7 +48,7 @@ import org.apache.directory.api.util.Str
*/
public class EntryChangeDecorator extends ControlDecorator<EntryChange> implements EntryChange
{
-
+ /** Default value when no change number is provided */
public static final int UNDEFINED_CHANGE_NUMBER = -1;
/** A temporary storage for the previous Dn */
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestContainer.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestContainer.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestContainer.java Thu Dec 1 18:18:40 2016
@@ -71,7 +71,9 @@ public class SortRequestContainer extend
/**
- * {@inheritDoc}
+ * Decorate a SortRequest control
+ *
+ * @param control The control to decorate
*/
public void decorate( SortRequest control )
{
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestDecorator.java Thu Dec 1 18:18:40 2016
@@ -54,8 +54,10 @@ public class SortRequestDecorator extend
private List<Integer> sortKeyLenList = new ArrayList<>();
+ /** ASN.1 BER tag for the forward ordering rule */
public static final int ORDERING_RULE_TAG = 0x80;
+ /** ASN.1 BER tag for the backward ordering rule */
public static final int REVERSE_ORDER_TAG = 0x81;
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestGrammar.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestGrammar.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestGrammar.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestGrammar.java Thu Dec 1 18:18:40 2016
@@ -39,7 +39,14 @@ import org.slf4j.LoggerFactory;
/**
- * Grammar used for decoding a SortRequestControl.
+ * Grammar used for decoding a SortRequestControl. It's defined in https://tools.ietf.org/html/rfc2891
+ *
+ * <pre>
+ * SortKeyList ::= SEQUENCE OF SEQUENCE {
+ * attributeType AttributeDescription,
+ * orderingRule [0] MatchingRuleId OPTIONAL,
+ * reverseOrder [1] BOOLEAN DEFAULT FALSE }
+ * </pre>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestStates.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestStates.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestStates.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortRequestStates.java Thu Dec 1 18:18:40 2016
@@ -30,18 +30,25 @@ import org.apache.directory.api.asn1.ber
*/
public enum SortRequestStates implements States
{
+ /** Initial state */
START_STATE,
+ /** SortKeyList ::= SEQUENCE OF transition */
SEQUENCE_OF_SEQUENCE_STATE,
+ /** SortKeyList ::= SEQUENCE OF SEQUENCE transition */
SORT_KEY_SEQUENCE_STATE,
+ /** attributeType AttributeDescription transition */
AT_DESC_STATE,
+ /** orderingRule [0] MatchingRuleId OPTIONAL transition */
ORDER_RULE_STATE,
+ /** reverseOrder [1] BOOLEAN DEFAULT FALSE transition */
REVERSE_ORDER_STATE,
+ /** Final state */
END_STATE;
/**
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseContainer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseContainer.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseContainer.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseContainer.java Thu Dec 1 18:18:40 2016
@@ -67,7 +67,9 @@ public class SortResponseContainer exten
/**
- * {@inheritDoc}
+ * Decorate the SortResponse control
+ *
+ * @param control The Sort Response control to decorate
*/
public void decorate( SortResponse control )
{
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseGrammar.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseGrammar.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseGrammar.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseGrammar.java Thu Dec 1 18:18:40 2016
@@ -33,7 +33,33 @@ import org.slf4j.LoggerFactory;
/**
- * Grammar for decoding SortResponseControl.
+ * Grammar for decoding SortResponseControl. It's defined in https://tools.ietf.org/html/rfc2891
+ *
+ * <pre>
+ * SortResult ::= SEQUENCE {
+ * sortResult ENUMERATED {
+ * success (0), -- results are sorted
+ * operationsError (1), -- server internal failure
+ * timeLimitExceeded (3), -- timelimit reached before
+ * -- sorting was completed
+ * strongAuthRequired (8), -- refused to return sorted
+ * -- results via insecure
+ * -- protocol
+ * adminLimitExceeded (11), -- too many matching entries
+ $ -- for the server to sort
+ * noSuchAttribute (16), -- unrecognized attribute
+ * -- type in sort key
+ * inappropriateMatching (18), -- unrecognized or
+ * -- inappropriate matching
+ * -- rule in sort key
+ * insufficientAccessRights (50), -- refused to return sorted
+ * -- results to this client
+ * busy (51), -- too busy to process
+ * unwillingToPerform (53), -- unable to sort
+ * other (80)
+ * },
+ * attributeType [0] AttributeDescription OPTIONAL }
+ * </pre>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseStates.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseStates.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseStates.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/controls/sort/SortResponseStates.java Thu Dec 1 18:18:40 2016
@@ -30,14 +30,19 @@ import org.apache.directory.api.asn1.ber
*/
public enum SortResponseStates implements States
{
+ /** Initialstate */
START_STATE,
+ /** SortResult ::= SEQUENCE transition */
SEQUENCE_STATE,
+ /** sortResult ENUMERATED transition */
RESULT_CODE_STATE,
+ /** attributeType [0] AttributeDescription OPTIONAL transition */
AT_DESC_STATE,
+ /** Final state */
END_STATE;
/**
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java Thu Dec 1 18:18:40 2016
@@ -126,6 +126,9 @@ public class SearchRequestDecorator exte
}
+ /**
+ * @return The current search filter
+ */
public Filter getCurrentFilter()
{
return currentFilter;
Modified: directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java?rev=1772245&r1=1772244&r2=1772245&view=diff
==============================================================================
--- directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java (original)
+++ directory/shared/trunk/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java Thu Dec 1 18:18:40 2016
@@ -84,6 +84,9 @@ public class SearchResultEntryDecorator
}
+ /**
+ * @return The current attribute
+ */
public Attribute getCurrentAttribute()
{
return currentAttribute;