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/09/02 13:37:21 UTC
svn commit: r1758954 [2/2] - in
/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec:
./ actions/ldapMessage/ api/ controls/cascade/ controls/manageDsaIT/
controls/proxiedauthz/ controls/search/entry...
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyRequestDecorator.java Fri Sep 2 13:37:20 2016
@@ -82,6 +82,7 @@ public class ModifyRequestDecorator exte
/**
* Makes a ModifyRequest encodable.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated ModifyRequest
*/
public ModifyRequestDecorator( LdapApiService codec, ModifyRequest decoratedMessage )
@@ -116,7 +117,7 @@ public class ModifyRequestDecorator exte
/**
- * Return the current attribute's type
+ * @return the current attribute's type
*/
public String getCurrentAttributeType()
{
@@ -128,6 +129,7 @@ public class ModifyRequestDecorator exte
* Add a new value to the current attribute
*
* @param value The value to add
+ * @throws LdapException If teh value is invalid
*/
public void addAttributeValue( byte[] value ) throws LdapException
{
@@ -139,6 +141,7 @@ public class ModifyRequestDecorator exte
* Add a new value to the current attribute
*
* @param value The value to add
+ * @throws LdapException If teh value is invalid
*/
public void addAttributeValue( String value ) throws LdapException
{
@@ -377,44 +380,43 @@ public class ModifyRequestDecorator exte
/**
* Compute the ModifyRequest length
- *
+ * <br>
* ModifyRequest :
- *
* <pre>
* 0x66 L1
* |
- * +--> 0x04 L2 object
- * +--> 0x30 L3 modifications
+ * +--> 0x04 L2 object
+ * +--> 0x30 L3 modifications
* |
- * +--> 0x30 L4-1 modification sequence
+ * +--> 0x30 L4-1 modification sequence
* | |
- * | +--> 0x0A 0x01 (0..2) operation
- * | +--> 0x30 L5-1 modification
+ * | +--> 0x0A 0x01 (0..2) operation
+ * | +--> 0x30 L5-1 modification
* | |
- * | +--> 0x04 L6-1 type
- * | +--> 0x31 L7-1 vals
+ * | +--> 0x04 L6-1 type
+ * | +--> 0x31 L7-1 vals
* | |
- * | +--> 0x04 L8-1-1 attributeValue
- * | +--> 0x04 L8-1-2 attributeValue
- * | +--> ...
- * | +--> 0x04 L8-1-i attributeValue
- * | +--> ...
- * | +--> 0x04 L8-1-n attributeValue
+ * | +--> 0x04 L8-1-1 attributeValue
+ * | +--> 0x04 L8-1-2 attributeValue
+ * | +--> ...
+ * | +--> 0x04 L8-1-i attributeValue
+ * | +--> ...
+ * | +--> 0x04 L8-1-n attributeValue
* |
- * +--> 0x30 L4-2 modification sequence
+ * +--> 0x30 L4-2 modification sequence
* . |
- * . +--> 0x0A 0x01 (0..2) operation
- * . +--> 0x30 L5-2 modification
+ * . +--> 0x0A 0x01 (0..2) operation
+ * . +--> 0x30 L5-2 modification
* |
- * +--> 0x04 L6-2 type
- * +--> 0x31 L7-2 vals
+ * +--> 0x04 L6-2 type
+ * +--> 0x31 L7-2 vals
* |
- * +--> 0x04 L8-2-1 attributeValue
- * +--> 0x04 L8-2-2 attributeValue
- * +--> ...
- * +--> 0x04 L8-2-i attributeValue
- * +--> ...
- * +--> 0x04 L8-2-n attributeValue
+ * +--> 0x04 L8-2-1 attributeValue
+ * +--> 0x04 L8-2-2 attributeValue
+ * +--> ...
+ * +--> 0x04 L8-2-i attributeValue
+ * +--> ...
+ * +--> 0x04 L8-2-n attributeValue
* </pre>
*/
public int computeLength()
@@ -488,7 +490,7 @@ public class ModifyRequestDecorator exte
/**
* Encode the ModifyRequest message to a PDU.
- *
+ * <br>
* ModifyRequest :
* <pre>
* 0x66 LL
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ModifyResponseDecorator.java Fri Sep 2 13:37:20 2016
@@ -46,6 +46,7 @@ public class ModifyResponseDecorator ext
/**
* Makes a ModifyResponse encodable.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated ModifyResponse
*/
public ModifyResponseDecorator( LdapApiService codec, ModifyResponse decoratedMessage )
@@ -60,12 +61,12 @@ public class ModifyResponseDecorator ext
/**
* Compute the ModifyResponse length
- *
+ * <br>
* ModifyResponse :
* <pre>
* 0x67 L1
* |
- * +--> LdapResult
+ * +--> LdapResult
*
* L1 = Length(LdapResult)
* Length(ModifyResponse) = Length(0x67) + Length(L1) + L1
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/RequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/RequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/RequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/RequestDecorator.java Fri Sep 2 13:37:20 2016
@@ -28,7 +28,7 @@ import org.apache.directory.api.ldap.mod
/**
* A decorator for the LdapResultResponse message
*
- * @TODO make this extend AbstractDsmlMessageDecorator instead of codec's
+ * TODO make this extend AbstractDsmlMessageDecorator instead of codec's
* MessageDecorator.
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -37,6 +37,7 @@ public abstract class RequestDecorator<M
/**
* Makes Request a MessageDecorator.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated message
*/
public RequestDecorator( LdapApiService codec, M decoratedMessage )
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResponseDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResponseDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResponseDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResponseDecorator.java Fri Sep 2 13:37:20 2016
@@ -40,6 +40,7 @@ public abstract class ResponseDecorator<
/**
* Makes a AddRequest encodable.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated AddRequest
*/
public ResponseDecorator( LdapApiService codec, M decoratedMessage )
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResultResponseRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResultResponseRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResultResponseRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/ResultResponseRequestDecorator.java Fri Sep 2 13:37:20 2016
@@ -36,6 +36,7 @@ public abstract class ResultResponseRequ
/**
* Makes Request a MessageDecorator.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated message
*/
public ResultResponseRequestDecorator( LdapApiService codec, M decoratedMessage )
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchRequestDecorator.java Fri Sep 2 13:37:20 2016
@@ -111,6 +111,7 @@ public class SearchRequestDecorator exte
/**
* Makes a SearchRequest encodable.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated SearchRequest
*/
public SearchRequestDecorator( LdapApiService codec, SearchRequest decoratedMessage )
@@ -150,6 +151,7 @@ public class SearchRequestDecorator exte
* Gets the search filter associated with this search request.
*
* @return the expression node for the root of the filter expression tree.
+ * @throws LdapSchemaException If the filter is invalid
*/
public ExprNode getFilterNode() throws LdapSchemaException
{
@@ -224,6 +226,7 @@ public class SearchRequestDecorator exte
* ConnectorFilter when this method is called.
*
* @param localFilter The filter to set.
+ * @throws DecoderException If the filter is invalid
*/
public void addCurrentFilter( Filter localFilter ) throws DecoderException
{
@@ -321,9 +324,10 @@ public class SearchRequestDecorator exte
*
* @param filter The filter to be transformed
* @return An ExprNode
+ * @throws LdapSchemaException If teh filter is invalid
*/
@SuppressWarnings(
- { "unchecked", "rawtypes" })
+ { "rawtypes" })
private ExprNode transform( Filter filter ) throws LdapSchemaException
{
if ( filter != null )
@@ -882,27 +886,27 @@ public class SearchRequestDecorator exte
/**
* Compute the SearchRequest length
- *
+ * <br>
* SearchRequest :
* <pre>
* 0x63 L1
* |
- * +--> 0x04 L2 baseObject
- * +--> 0x0A 0x01 scope
- * +--> 0x0A 0x01 derefAliases
- * +--> 0x02 0x0(1..4) sizeLimit
- * +--> 0x02 0x0(1..4) timeLimit
- * +--> 0x01 0x01 typesOnly
- * +--> filter.computeLength()
- * +--> 0x30 L3 (Attribute description list)
+ * +--> 0x04 L2 baseObject
+ * +--> 0x0A 0x01 scope
+ * +--> 0x0A 0x01 derefAliases
+ * +--> 0x02 0x0(1..4) sizeLimit
+ * +--> 0x02 0x0(1..4) timeLimit
+ * +--> 0x01 0x01 typesOnly
+ * +--> filter.computeLength()
+ * +--> 0x30 L3 (Attribute description list)
* |
- * +--> 0x04 L4-1 Attribute description
- * +--> 0x04 L4-2 Attribute description
- * +--> ...
- * +--> 0x04 L4-i Attribute description
- * +--> ...
- * +--> 0x04 L4-n Attribute description
- * </pre>
+ * +--> 0x04 L4-1 Attribute description
+ * +--> 0x04 L4-2 Attribute description
+ * +--> ...
+ * +--> 0x04 L4-i Attribute description
+ * +--> ...
+ * +--> 0x04 L4-n Attribute description
+ * </pre>
*/
public int computeLength()
{
@@ -960,7 +964,7 @@ public class SearchRequestDecorator exte
/**
* Encode the SearchRequest message to a PDU.
- *
+ * <br>
* SearchRequest :
* <pre>
* 0x63 LL
@@ -976,6 +980,7 @@ public class SearchRequestDecorator exte
* ...
* 0x04 LL attributeDescription
* </pre>
+ *
* @param buffer The buffer where to put the PDU
* @return The PDU.
*/
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultDoneDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultDoneDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultDoneDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultDoneDecorator.java Fri Sep 2 13:37:20 2016
@@ -45,6 +45,7 @@ public class SearchResultDoneDecorator e
/**
* Makes a SearchResultDone encodable.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated SearchResultDone
*/
public SearchResultDoneDecorator( LdapApiService codec, SearchResultDone decoratedMessage )
@@ -59,16 +60,17 @@ public class SearchResultDoneDecorator e
/**
* Compute the SearchResultDone length
- *
+ * <br>
* SearchResultDone :
* <pre>
* 0x65 L1
* |
- * +--> LdapResult
+ * +--> LdapResult
*
* L1 = Length(LdapResult)
* Length(SearchResultDone) = Length(0x65) + Length(L1) + L1
* </pre>
+ *
*/
public int computeLength()
{
@@ -82,7 +84,8 @@ public class SearchResultDoneDecorator e
* Encode the SearchResultDone message to a PDU.
*
* @param buffer The buffer where to put the PDU
- * @param searchResultDoneDecorator The SearchResultDone decorator
+ * return The encoded response
+ * @throws EncoderException If the encoding failed
*/
public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
{
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultEntryDecorator.java Fri Sep 2 13:37:20 2016
@@ -75,6 +75,7 @@ public class SearchResultEntryDecorator
/**
* Makes a SearchResultEntry encodable.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated SearchResultEntry
*/
public SearchResultEntryDecorator( LdapApiService codec, SearchResultEntry decoratedMessage )
@@ -93,6 +94,7 @@ public class SearchResultEntryDecorator
* Create a new attribute
*
* @param type The attribute's type
+ * @throws LdapException If the value is invalid
*/
public void addAttribute( String type ) throws LdapException
{
@@ -106,6 +108,7 @@ public class SearchResultEntryDecorator
* Create a new attribute
*
* @param type The attribute's type
+ * @throws LdapException If the value is invalid
*/
public void addAttribute( byte[] type ) throws LdapException
{
@@ -119,6 +122,7 @@ public class SearchResultEntryDecorator
* Add a new value to the current attribute
*
* @param value The added value
+ * @throws LdapException If the value is invalid
*/
public void addAttributeValue( Object value ) throws LdapException
{
@@ -179,42 +183,42 @@ public class SearchResultEntryDecorator
/**
* Compute the SearchResultEntry length
- *
+ * <br>
* SearchResultEntry :
* <pre>
* 0x64 L1
* |
- * +--> 0x04 L2 objectName
- * +--> 0x30 L3 (attributes)
+ * +--> 0x04 L2 objectName
+ * +--> 0x30 L3 (attributes)
* |
- * +--> 0x30 L4-1 (partial attributes list)
+ * +--> 0x30 L4-1 (partial attributes list)
* | |
- * | +--> 0x04 L5-1 type
- * | +--> 0x31 L6-1 (values)
+ * | +--> 0x04 L5-1 type
+ * | +--> 0x31 L6-1 (values)
* | |
- * | +--> 0x04 L7-1-1 value
- * | +--> ...
- * | +--> 0x04 L7-1-n value
+ * | +--> 0x04 L7-1-1 value
+ * | +--> ...
+ * | +--> 0x04 L7-1-n value
* |
- * +--> 0x30 L4-2 (partial attributes list)
+ * +--> 0x30 L4-2 (partial attributes list)
* | |
- * | +--> 0x04 L5-2 type
- * | +--> 0x31 L6-2 (values)
+ * | +--> 0x04 L5-2 type
+ * | +--> 0x31 L6-2 (values)
* | |
- * | +--> 0x04 L7-2-1 value
- * | +--> ...
- * | +--> 0x04 L7-2-n value
+ * | +--> 0x04 L7-2-1 value
+ * | +--> ...
+ * | +--> 0x04 L7-2-n value
* |
- * +--> ...
+ * +--> ...
* |
- * +--> 0x30 L4-m (partial attributes list)
+ * +--> 0x30 L4-m (partial attributes list)
* |
- * +--> 0x04 L5-m type
- * +--> 0x31 L6-m (values)
+ * +--> 0x04 L5-m type
+ * +--> 0x31 L6-m (values)
* |
- * +--> 0x04 L7-m-1 value
- * +--> ...
- * +--> 0x04 L7-m-n value
+ * +--> 0x04 L7-m-1 value
+ * +--> ...
+ * +--> 0x04 L7-m-n value
* </pre>
*/
public int computeLength()
@@ -301,7 +305,7 @@ public class SearchResultEntryDecorator
/**
* Encode the SearchResultEntry message to a PDU.
- *
+ * <br>
* SearchResultEntry :
* <pre>
* 0x64 LL
@@ -321,8 +325,8 @@ public class SearchResultEntryDecorator
* ...
* 0x04 LL attributeValue
* </pre>
+ *
* @param buffer The buffer where to put the PDU
- * @param searchResultEntryDecorator the SearchResultEntry decorator
* @return The PDU.
*/
public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultReferenceDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultReferenceDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultReferenceDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SearchResultReferenceDecorator.java Fri Sep 2 13:37:20 2016
@@ -50,6 +50,7 @@ public class SearchResultReferenceDecora
/**
* Makes a SearchResultReference encodable.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated SearchResultReference
*/
public SearchResultReferenceDecorator( LdapApiService codec, SearchResultReference decoratedMessage )
@@ -86,22 +87,24 @@ public class SearchResultReferenceDecora
/**
* Compute the SearchResultReference length
- *
+ * <br>
* SearchResultReference :
* <pre>
* 0x73 L1
* |
- * +--> 0x04 L2 reference
- * +--> 0x04 L3 reference
- * +--> ...
- * +--> 0x04 Li reference
- * +--> ...
- * +--> 0x04 Ln reference
+ * +--> 0x04 L2 reference
+ * +--> 0x04 L3 reference
+ * +--> ...
+ * +--> 0x04 Li reference
+ * +--> ...
+ * +--> 0x04 Ln reference
*
* L1 = n*Length(0x04) + sum(Length(Li)) + sum(Length(reference[i]))
*
* Length(SearchResultReference) = Length(0x73 + Length(L1) + L1
* </pre>
+ *
+ * @return The encoded length
*/
public int computeLength()
{
@@ -125,15 +128,15 @@ public class SearchResultReferenceDecora
/**
* Encode the SearchResultReference message to a PDU.
- *
+ * <br>
* SearchResultReference :
* <pre>
* 0x73 LL
* 0x04 LL reference
* [0x04 LL reference]*
* </pre>
+ *
* @param buffer The buffer where to put the PDU
- * @param searchResultReferenceDecorator The SearchResultReference decorator
* @return The PDU.
*/
public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SingleReplyRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SingleReplyRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SingleReplyRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/SingleReplyRequestDecorator.java Fri Sep 2 13:37:20 2016
@@ -38,6 +38,7 @@ public abstract class SingleReplyRequest
/**
* Makes Request a MessageDecorator.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated message
*/
public SingleReplyRequestDecorator( LdapApiService codec, M decoratedMessage )
@@ -55,18 +56,27 @@ public abstract class SingleReplyRequest
}
+ /**
+ * {@inheritDoc}
+ */
public void abandon()
{
( ( AbandonableRequest ) getDecorated() ).abandon();
}
+ /**
+ * {@inheritDoc}
+ */
public boolean isAbandoned()
{
return ( ( AbandonableRequest ) getDecorated() ).isAbandoned();
}
+ /**
+ * {@inheritDoc}
+ */
public AbandonableRequest addAbandonListener( AbandonListener listener )
{
( ( AbandonableRequest ) getDecorated() ).addAbandonListener( listener );
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/UnbindRequestDecorator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/UnbindRequestDecorator.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/UnbindRequestDecorator.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/decorators/UnbindRequestDecorator.java Fri Sep 2 13:37:20 2016
@@ -41,6 +41,7 @@ public class UnbindRequestDecorator exte
/**
* Makes Request a MessageDecorator.
*
+ * @param codec The LDAP service instance
* @param decoratedMessage the decorated message
*/
public UnbindRequestDecorator( LdapApiService codec, UnbindRequest decoratedMessage )
@@ -93,9 +94,11 @@ public class UnbindRequestDecorator exte
/**
* Compute the UnBindRequest length
- *
- * UnBindRequest :
+ * <br>
+ * UnBindRequest :
+ * <pre>
* 0x42 00
+ * </pre>
*/
public int computeLength()
{
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/osgi/DefaultLdapCodecService.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/osgi/DefaultLdapCodecService.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/osgi/DefaultLdapCodecService.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/osgi/DefaultLdapCodecService.java Fri Sep 2 13:37:20 2016
@@ -429,7 +429,6 @@ public class DefaultLdapCodecService imp
/**
* {@inheritDoc}
- * @throws DecoderException
*/
@SuppressWarnings("unchecked")
public <E extends ExtendedResponse> E newExtendedResponse( String responseName, int messageId,
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AndFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AndFilter.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AndFilter.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AndFilter.java Fri Sep 2 13:37:20 2016
@@ -37,12 +37,11 @@ import org.apache.directory.api.ldap.cod
*/
public class AndFilter extends ConnectorFilter
{
- // ~ Methods
- // ------------------------------------------------------------------------------------
-
/**
* The constructor. We wont initialize the ArrayList as they may not be
* used.
+ *
+ * @param tlvId The TLV identifier
*/
public AndFilter( int tlvId )
{
@@ -73,12 +72,16 @@ public class AndFilter extends Connector
/**
* Compute the AndFilter length
- *
- * AndFilter :
+ * <br>
+ * AndFilter :
+ * <pre>
* 0xA0 L1 super.computeLength()
*
* Length(AndFilter) = Length(0xA0) + Length(super.computeLength()) +
* super.computeLength()
+ * </pre>
+ *
+ * @return The encoded length
*/
public int computeLength()
{
@@ -90,10 +93,12 @@ public class AndFilter extends Connector
/**
* Encode the AndFilter message to a PDU.
- *
- * AndFilter :
+ * <br>
+ * AndFilter :
+ * <pre>
* 0xA0 LL
* filter.encode() ... filter.encode()
+ * </pre>
*
* @param buffer The buffer where to put the PDU
* @return The PDU.
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AttributeValueAssertionFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AttributeValueAssertionFilter.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AttributeValueAssertionFilter.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/AttributeValueAssertionFilter.java Fri Sep 2 13:37:20 2016
@@ -38,9 +38,6 @@ import org.apache.directory.api.ldap.cod
*/
public class AttributeValueAssertionFilter extends Filter
{
- // ~ Instance fields
- // ----------------------------------------------------------------------------
-
/** The assertion. */
private AttributeValueAssertion assertion;
@@ -51,12 +48,10 @@ public class AttributeValueAssertionFilt
private int avaLength;
- // ~ Constructors
- // -------------------------------------------------------------------------------
-
/**
* The constructor.
*
+ * @param tlvId The TLV identifier
* @param filterType The filter type
*/
public AttributeValueAssertionFilter( int tlvId, int filterType )
@@ -78,9 +73,6 @@ public class AttributeValueAssertionFilt
}
- // ~ Methods
- // ------------------------------------------------------------------------------------
-
/**
* Get the assertion
*
@@ -127,13 +119,13 @@ public class AttributeValueAssertionFilt
/**
* Compute the AttributeValueFilter length
- *
+ * <br>
* AttributeValueFilter :
- *
+ * <pre>
* 0xA(3, 5, 6, 8) L1
* |
- * +--> 0x04 L2 attributeDesc
- * +--> 0x04 L3 assertionValue
+ * +--> 0x04 L2 attributeDesc
+ * +--> 0x04 L3 assertionValue
*
*
* L2 = Length(attributeDesc)
@@ -144,6 +136,9 @@ public class AttributeValueAssertionFilt
* Length(AttributeValueFilter) = Length(0xA?) + Length(L1)
* + 1 + Length(L2) + L2
* + 1 + Length(L3) + L3
+ * </pre>
+ *
+ * @return The encoded length
*/
public int computeLength()
{
@@ -167,16 +162,20 @@ public class AttributeValueAssertionFilt
/**
* Encode the AttributeValueAssertion Filters to a PDU. The
* following filters are to be encoded :
- * - equality match
- * - greater or equal
- * - less or equal
- * - approx match
+ * <ul>
+ * <li>equality match</li>
+ * <li>greater or equal</li>
+ * <li>less or equal</li>
+ * <li>approx match</li>
+ * </ul>
*
* AttributeValueAssertion filters :
- *
+ * <br>
+ * <pre>
* 0xA[3, 5, 6, 8] LL
- * 0x04 LL attributeDesc
- * 0x04 LL assertionValue
+ * 0x04 LL attributeDesc
+ * 0x04 LL assertionValue
+ * </pre>
*
* @param buffer The buffer where to put the PDU
* @return The PDU.
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ConnectorFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ConnectorFilter.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ConnectorFilter.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ConnectorFilter.java Fri Sep 2 13:37:20 2016
@@ -37,9 +37,6 @@ import org.apache.directory.api.i18n.I18
*/
public abstract class ConnectorFilter extends Filter
{
- // ~ Instance fields
- // ----------------------------------------------------------------------------
-
/** The set of filters used by And/Or filters */
protected List<Filter> filterSet;
@@ -47,11 +44,10 @@ public abstract class ConnectorFilter ex
protected int filtersLength;
- // ~ Constructors
- // -------------------------------------------------------------------------------
-
/**
* The constructor. We wont initialize the ArrayList as it may not be used.
+ *
+ * @param tlvId The TLV identifier
*/
public ConnectorFilter( int tlvId )
{
@@ -68,13 +64,11 @@ public abstract class ConnectorFilter ex
}
- // ~ Methods
- // ------------------------------------------------------------------------------------
-
/**
* Add a new Filter to the list.
*
* @param filter The filter to add
+ * @throws DecoderException If the decoding failed
*/
public void addFilter( Filter filter ) throws DecoderException
{
@@ -102,6 +96,8 @@ public abstract class ConnectorFilter ex
/**
* Compute the ConnectorFilter length Length(ConnectorFilter) =
* sum(filterSet.computeLength())
+ *
+ * @return The encoded length
*/
public int computeLength()
{
@@ -121,12 +117,14 @@ public abstract class ConnectorFilter ex
/**
* Encode the ConnectorFilter message to a PDU.
- *
+ * <pre>
* ConnectorFilter :
* filter.encode() ... filter.encode()
+ * </pre>
*
* @param buffer The buffer where to put the PDU
* @return The PDU.
+ * @throws EncoderException If the encoding failed
*/
public ByteBuffer encode( ByteBuffer buffer ) throws EncoderException
{
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ExtensibleMatchFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ExtensibleMatchFilter.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ExtensibleMatchFilter.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/ExtensibleMatchFilter.java Fri Sep 2 13:37:20 2016
@@ -39,9 +39,6 @@ import org.apache.directory.api.util.Str
*/
public class ExtensibleMatchFilter extends Filter
{
- // ~ Instance fields
- // ----------------------------------------------------------------------------
-
/** The expected lenth of the Matching Rule Assertion */
private int expectedMatchingRuleLength;
@@ -66,11 +63,11 @@ public class ExtensibleMatchFilter exten
private int extensibleMatchLength;
- // ~ Constructors
- // -------------------------------------------------------------------------------
/**
* Creates a new ExtensibleMatchFilter object. The dnAttributes flag
* defaults to false.
+ *
+ * @param tlvId The TLV identifier
*/
public ExtensibleMatchFilter( int tlvId )
{
@@ -88,9 +85,6 @@ public class ExtensibleMatchFilter exten
}
- // ~ Methods
- // ------------------------------------------------------------------------------------
-
/**
* Get the dnAttributes flag
*
@@ -203,13 +197,18 @@ public class ExtensibleMatchFilter exten
/**
* Compute the ExtensibleMatchFilter length
- * ExtensibleMatchFilter :
+ * <br>
+ * ExtensibleMatchFilter :
+ * <pre>
* 0xA9 L1
* |
- * [+--> 0x81 L3 matchingRule]
- * [+--> 0x82 L4 type]
- * [+--> 0x83 L5 matchValue]
- * [+--> 0x01 0x01 dnAttributes]
+ * [+--> 0x81 L3 matchingRule]
+ * [+--> 0x82 L4 type]
+ * [+--> 0x83 L5 matchValue]
+ * [+--> 0x01 0x01 dnAttributes]
+ * </pre>
+ *
+ * @return The encoded length
*/
public int computeLength()
{
@@ -242,9 +241,9 @@ public class ExtensibleMatchFilter exten
/**
* Encode the ExtensibleMatch Filters to a PDU.
- *
+ * <br>
* ExtensibleMatch filter :
- *
+ * <pre>
* 0xA9 LL
* | 0x81 LL matchingRule
* | / | 0x82 LL Type
@@ -255,6 +254,7 @@ public class ExtensibleMatchFilter exten
* | 0x82 LL type
* | 0x83 LL matchValue
* +--[0x84 0x01 dnAttributes]
+ * </pre>
*
* @param buffer The buffer where to put the PDU
* @return The PDU.
@@ -329,7 +329,7 @@ public class ExtensibleMatchFilter exten
/**
* Return a String representing an extended filter as of RFC 2254
*
- * @return An Extened Filter String
+ * @return An Extended Filter String
*/
public String toString()
{
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/Filter.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/Filter.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/Filter.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/Filter.java Fri Sep 2 13:37:20 2016
@@ -46,6 +46,8 @@ public abstract class Filter
/**
* The constructor.
+ *
+ * @param tlvId The TLV identifier
*/
public Filter( int tlvId )
{
@@ -87,6 +89,7 @@ public abstract class Filter
* Set the parent
*
* @param parent The parent to set.
+ * @param parentTlvId The Parent TLV identifier
*/
public void setParent( Filter parent, int parentTlvId )
{
@@ -95,6 +98,9 @@ public abstract class Filter
}
+ /**
+ * @return The TLV identifier
+ */
public int getTlvId()
{
return tlvId;
@@ -103,14 +109,18 @@ public abstract class Filter
/**
* Compute the Filter length
+ *
+ * @return the encoded length
*/
public abstract int computeLength();
/**
* Encode the Filter message to a PDU.
+ *
* @param buffer The buffer where to put the PDU
* @return The PDU.
+ * @throws EncoderException If the encoding failed
*/
public abstract ByteBuffer encode( ByteBuffer buffer ) throws EncoderException;
}
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/NotFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/NotFilter.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/NotFilter.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/NotFilter.java Fri Sep 2 13:37:20 2016
@@ -37,11 +37,10 @@ import org.apache.directory.api.ldap.cod
*/
public class NotFilter extends ConnectorFilter
{
- // ~ Methods
- // ------------------------------------------------------------------------------------
-
/**
* The constructor.
+ *
+ * @param tlvId The TLV identifier
*/
public NotFilter( int tlvId )
{
@@ -90,6 +89,7 @@ public class NotFilter extends Connector
* Set the NotFilter
*
* @param notFilter The notFilter to set.
+ * @throws DecoderException If the NotFilter is already containing a filter
*/
public void setNotFilter( Filter notFilter ) throws DecoderException
{
@@ -104,11 +104,16 @@ public class NotFilter extends Connector
/**
* Compute the NotFilter length
- * NotFilter :
+ * <br>
+ * NotFilter :
+ * <pre>
* 0xA2 L1 super.computeLength()
*
* Length(NotFilter) = Length(0xA2) + Length(super.computeLength()) +
* super.computeLength()
+ * </pre>
+ *
+ * @return The encoded length
*/
public int computeLength()
{
@@ -120,8 +125,11 @@ public class NotFilter extends Connector
/**
* Encode the NotFilter message to a PDU.
- * NotFilter :
+ * <br>
+ * NotFilter :
+ * <pre>
* 0xA2 LL filter.encode()
+ * </pre>
*
* @param buffer The buffer where to put the PDU
* @return The PDU.
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/OrFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/OrFilter.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/OrFilter.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/OrFilter.java Fri Sep 2 13:37:20 2016
@@ -37,12 +37,11 @@ import org.apache.directory.api.ldap.cod
*/
public class OrFilter extends ConnectorFilter
{
- // ~ Constructors
- // -------------------------------------------------------------------------------
-
/**
* The constructor. We wont initialize the ArrayList as they may not be
* used.
+ *
+ * @param tlvId The TLV identifier
*/
public OrFilter( int tlvId )
{
@@ -60,9 +59,6 @@ public class OrFilter extends ConnectorF
}
- // ~ Methods
- // ------------------------------------------------------------------------------------
-
/**
* Get the OrFilter
*
@@ -76,12 +72,16 @@ public class OrFilter extends ConnectorF
/**
* Compute the OrFilter length
- *
- * OrFilter :
+ * <br>
+ * OrFilter :
+ * <pre>
* 0xA1 L1 super.computeLength()
*
* Length(OrFilter) = Length(0xA1) + Length(super.computeLength()) +
* super.computeLength()
+ * </pre>
+ *
+ * @return The encoded length
*/
public int computeLength()
{
@@ -93,8 +93,11 @@ public class OrFilter extends ConnectorF
/**
* Encode the OrFilter message to a PDU.
- * OrFilter :
+ * <br>
+ * OrFilter :
+ * <pre>
* 0xA1 LL filter.encode()
+ * </pre>
*
* @param buffer The buffer where to put the PDU
* @return The PDU.
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/PresentFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/PresentFilter.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/PresentFilter.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/PresentFilter.java Fri Sep 2 13:37:20 2016
@@ -37,9 +37,6 @@ import org.apache.directory.api.util.Str
*/
public class PresentFilter extends Filter
{
- // ~ Instance fields
- // ----------------------------------------------------------------------------
-
/** The attribute description. */
private String attributeDescription;
@@ -47,11 +44,10 @@ public class PresentFilter extends Filte
private byte[] attributeDescriptionBytes;
- // ~ Constructors
- // -------------------------------------------------------------------------------
-
/**
* The constructor.
+ *
+ * @param tlvId The TLV identifier
*/
public PresentFilter( int tlvId )
{
@@ -68,9 +64,6 @@ public class PresentFilter extends Filte
}
- // ~ Methods
- // ------------------------------------------------------------------------------------
-
/**
* Get the attribute
*
@@ -95,11 +88,16 @@ public class PresentFilter extends Filte
/**
* Compute the PresentFilter length
- * PresentFilter :
+ * <br>
+ * PresentFilter :
+ * <pre>
* 0x87 L1 present
*
* Length(PresentFilter) = Length(0x87) + Length(super.computeLength()) +
* super.computeLength()
+ * </pre>
+ *
+ * @return The encoded length
*/
public int computeLength()
{
Modified: directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/SubstringFilter.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/SubstringFilter.java?rev=1758954&r1=1758953&r2=1758954&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/SubstringFilter.java (original)
+++ directory/shared/branches/shared-value/ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/search/SubstringFilter.java Fri Sep 2 13:37:20 2016
@@ -77,12 +77,11 @@ public class SubstringFilter extends Fil
private int substringsFilterSequenceLength;
- // ~ Methods
- // ------------------------------------------------------------------------------------
-
/**
* The constructor. We will create the 'any' subsring arraylist with only
* one element.
+ *
+ * @param tlvId The TLV identifier
*/
public SubstringFilter( int tlvId )
{
@@ -208,21 +207,25 @@ public class SubstringFilter extends Fil
/**
* Compute the SubstringFilter length
- *
- * SubstringFilter :
+ * <br>
+ * SubstringFilter :
+ * <pre>
* 0xA4 L1
* |
- * +--> 0x04 L2 type
- * +--> 0x30 L3
+ * +--> 0x04 L2 type
+ * +--> 0x30 L3
* |
- * [+--> 0x80 L4 initial]
- * [+--> 0x81 L5-1 any]
- * [+--> 0x81 L5-2 any]
- * [+--> ...
- * [+--> 0x81 L5-i any]
- * [+--> ...
- * [+--> 0x81 L5-n any]
- * [+--> 0x82 L6 final]
+ * [+--> 0x80 L4 initial]
+ * [+--> 0x81 L5-1 any]
+ * [+--> 0x81 L5-2 any]
+ * [+--> ...
+ * [+--> 0x81 L5-i any]
+ * [+--> ...
+ * [+--> 0x81 L5-n any]
+ * [+--> 0x82 L6 final]
+ * </pre>
+ *
+ * @return The encoded length
*/
public int computeLength()
{
@@ -264,9 +267,9 @@ public class SubstringFilter extends Fil
/**
* Encode the Substrings Filter to a PDU.
- *
+ * <br>
* Substrings Filter :
- *
+ * <pre>
* 0xA4 LL
* 0x30 LL substringsFilter
* 0x04 LL type
@@ -278,6 +281,7 @@ public class SubstringFilter extends Fil
* \ [0x82 LL final]
* \
* 0x82 LL final
+ * </pre>
*
* @param buffer The buffer where to put the PDU
* @return The PDU.