directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r761657 - /directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/
Date Fri, 03 Apr 2009 12:55:59 GMT
Author: elecharny
Date: Fri Apr  3 12:55:59 2009
New Revision: 761657

URL: http://svn.apache.org/viewvc?rev=761657&view=rev
Log:
o Added some Javadoc
o Fixed minor issues

Modified:
    directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/AbstractResponseWithResult.java
    directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/BindResponseImpl.java
    directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponse.java
    directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponseImpl.java
    directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResult.java
    directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResultImpl.java
    directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/ResponseWithResult.java
    directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/SearchRequestImpl.java

Modified: directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/AbstractResponseWithResult.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/AbstractResponseWithResult.java?rev=761657&r1=761656&r2=761657&view=diff
==============================================================================
--- directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/AbstractResponseWithResult.java
(original)
+++ directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/AbstractResponseWithResult.java
Fri Apr  3 12:55:59 2009
@@ -28,11 +28,11 @@
  */
 public abstract class AbstractResponseWithResult extends AbstractMessage implements ResponseWithResult
 {
+    /** The result */
     private LdapResult ldapResult;
     
     /**
-     * If called for the first time, this method creates a result containing
-     * response object for this request.
+     * Returns the response's result
      * 
      * @return a result containing response with defaults and the messageId set
      * in response to this specific request
@@ -43,6 +43,11 @@
     }
     
     
+    /**
+     * Sets the result into the response.
+     * 
+     * @param ldapResult The LdapResult instance associated with this response
+     */
     public void setLdapResult( LdapResult ldapResult )
     {
         this.ldapResult = ldapResult;

Modified: directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/BindResponseImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/BindResponseImpl.java?rev=761657&r1=761656&r2=761657&view=diff
==============================================================================
--- directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/BindResponseImpl.java
(original)
+++ directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/BindResponseImpl.java
Fri Apr  3 12:55:59 2009
@@ -32,6 +32,9 @@
     private byte[] credentials;
 
     
+    /**
+     * Creates a new instance of BindResponseImpl.
+     */
     public BindResponseImpl()
     {
         super();

Modified: directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponse.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponse.java?rev=761657&r1=761656&r2=761657&view=diff
==============================================================================
--- directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponse.java
(original)
+++ directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponse.java
Fri Apr  3 12:55:59 2009
@@ -27,11 +27,34 @@
  */
 public interface IntermediateResponse extends Message
 {
+    /**
+     * Get the original response OID.
+     *
+     * @return The response OID
+     */
     String getResponseName();
     
+    
+    /**
+     * Sets the original response OID
+     *
+     * @param responseName The response OID
+     */
     void setResponseName( String responseName );
     
+    
+    /**
+     * Get the associated response value
+     *
+     * @return The response value
+     */
     byte[] getResponseValue();
     
+    
+    /**
+     * Sets the response's value
+     *
+     * @param responseValue The associated response's value
+     */
     void setResponseValue( byte[] responseValue );
 }

Modified: directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponseImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponseImpl.java?rev=761657&r1=761656&r2=761657&view=diff
==============================================================================
--- directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponseImpl.java
(original)
+++ directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/IntermediateResponseImpl.java
Fri Apr  3 12:55:59 2009
@@ -33,24 +33,45 @@
     /** The response value */
     private byte[] responseValue;
     
+    /**
+     * Creates a new instance of IntermediateResponseImpl.
+     */
+    public IntermediateResponseImpl()
+    {
+        super();
+    }
+
+    
+    /**
+     * {@inheritDoc}
+     */
     public String getResponseName()
     {
         return responseName;
     }
     
     
+    /**
+     * {@inheritDoc}
+     */
     public void setResponseName( String responseName )
     {
         this.responseName = responseName;
     }
     
     
+    /**
+     * {@inheritDoc}
+     */
     public byte[] getResponseValue()
     {
         return responseValue;
     }
 
     
+    /**
+     * {@inheritDoc}
+     */
     public void setResponseValue( byte[] responseValue )
     {
         this.responseValue = responseValue;

Modified: directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResult.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResult.java?rev=761657&r1=761656&r2=761657&view=diff
==============================================================================
--- directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResult.java
(original)
+++ directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResult.java
Fri Apr  3 12:55:59 2009
@@ -20,9 +20,7 @@
 
 package org.apache.directory.shared.ldap.client.api.messages;
 
-import org.apache.directory.shared.ldap.message.InternalReferral;
 import org.apache.directory.shared.ldap.message.ResultCodeEnum;
-import org.apache.directory.shared.ldap.name.LdapDN;
 
 
 /**
@@ -77,17 +75,16 @@
      * 
      * @return the Dn of the lowest matched entry.
      */
-    LdapDN getMatchedDn();
+    String getMatchedDn();
 
 
     /**
      * Sets the lowest entry in the directory that was matched.
      * 
      * @see #getMatchedDn()
-     * @param dn
-     *            the Dn of the lowest matched entry.
+     * @param dn the Dn of the lowest matched entry.
      */
-    void setMatchedDn( LdapDN dn );
+    void setMatchedDn( String dn );
 
 
     /**
@@ -124,7 +121,7 @@
      * 
      * @return the referral on REFERRAL errors, null on all others.
      */
-    InternalReferral getReferral();
+    Referral getReferral();
 
 
     /**
@@ -133,8 +130,7 @@
      * will result in a true return from isReferral and the resultCode should be
      * set to REFERRAL.
      * 
-     * @param referral
-     *            optional referral on REFERRAL errors.
+     * @param referral optional referral on REFERRAL errors.
      */
-    void setReferral( InternalReferral referral );
+    void setReferral( Referral referral );
 }

Modified: directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResultImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResultImpl.java?rev=761657&r1=761656&r2=761657&view=diff
==============================================================================
--- directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResultImpl.java
(original)
+++ directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/LdapResultImpl.java
Fri Apr  3 12:55:59 2009
@@ -20,9 +20,7 @@
 
 package org.apache.directory.shared.ldap.client.api.messages;
 
-import org.apache.directory.shared.ldap.message.InternalReferral;
 import org.apache.directory.shared.ldap.message.ResultCodeEnum;
-import org.apache.directory.shared.ldap.name.LdapDN;
 
 
 /**
@@ -34,10 +32,10 @@
 public class LdapResultImpl implements LdapResult
 {
     /** Lowest matched entry Dn - defaults to empty string */
-    private LdapDN matchedDn;
+    private String matchedDn;
 
     /** Referral associated with this LdapResult if the errorCode is REFERRAL */
-    private InternalReferral referral;
+    private Referral referral;
 
     /** Decriptive error message - defaults to empty string */
     private String errorMessage;
@@ -49,12 +47,8 @@
     // ------------------------------------------------------------------------
     // LdapResult Interface Method Implementations
     // ------------------------------------------------------------------------
-
     /**
-     * Gets the descriptive error message associated with the error code. May be
-     * null for SUCCESS, COMPARETRUE, COMPAREFALSE and REFERRAL operations.
-     * 
-     * @return the descriptive error message.
+     * {@inheritDoc}
      */
     public String getErrorMessage()
     {
@@ -63,11 +57,7 @@
 
 
     /**
-     * Sets the descriptive error message associated with the error code. May be
-     * null for SUCCESS, COMPARETRUE, and COMPAREFALSE operations.
-     * 
-     * @param errorMessage
-     *            the descriptive error message.
+     * {@inheritDoc}
      */
     public void setErrorMessage( String errorMessage )
     {
@@ -76,43 +66,25 @@
 
 
     /**
-     * Gets the lowest entry in the directory that was matched. For result codes
-     * of noSuchObject, aliasProblem, invalidDNSyntax and
-     * aliasDereferencingProblem, the matchedDN field is set to the name of the
-     * lowest entry (object or alias) in the directory that was matched. If no
-     * aliases were dereferenced while attempting to locate the entry, this will
-     * be a truncated form of the name provided, or if aliases were
-     * dereferenced, of the resulting name, as defined in section 12.5 of X.511
-     * [8]. The matchedDN field is to be set to a zero length string with all
-     * other result codes.
-     * 
-     * @return the Dn of the lowest matched entry.
+     * {@inheritDoc}
      */
-    public LdapDN getMatchedDn()
+    public String getMatchedDn()
     {
         return matchedDn;
     }
 
 
     /**
-     * Sets the lowest entry in the directory that was matched.
-     * 
-     * @see #getMatchedDn()
-     * @param matchedDn
-     *            the Dn of the lowest matched entry.
+     * {@inheritDoc}
      */
-    public void setMatchedDn( LdapDN matchedDn )
+    public void setMatchedDn( String matchedDn )
     {
         this.matchedDn = matchedDn;
     }
 
 
     /**
-     * Gets the result code enumeration associated with the response.
-     * Corresponds to the <b> resultCode </b> field within the LDAPResult ASN.1
-     * structure.
-     * 
-     * @return the result code enum value.
+     * {@inheritDoc}
      */
     public ResultCodeEnum getResultCode()
     {
@@ -121,12 +93,7 @@
 
 
     /**
-     * Sets the result code enumeration associated with the response.
-     * Corresponds to the <b> resultCode </b> field within the LDAPResult ASN.1
-     * structure.
-     * 
-     * @param resultCode
-     *            the result code enum value.
+     * {@inheritDoc}
      */
     public void setResultCode( ResultCodeEnum resultCode )
     {
@@ -135,22 +102,16 @@
 
 
     /**
-     * Gets the Referral associated with this LdapResult if the resultCode
-     * property is set to the REFERRAL ResultCodeEnum.
-     * 
-     * @return the referral on REFERRAL errors, null on all others.
+     * {@inheritDoc}
      */
-    public InternalReferral getReferral()
+    public Referral getReferral()
     {
         return referral;
     }
 
 
     /**
-     * Gets whether or not this result represents a Referral. For referrals the
-     * error code is set to REFERRAL and the referral property is not null.
-     * 
-     * @return true if this result represents a referral.
+     * {@inheritDoc}
      */
     public boolean isReferral()
     {
@@ -159,365 +120,10 @@
 
 
     /**
-     * Sets the Referral associated with this LdapResult if the resultCode
-     * property is set to the REFERRAL ResultCodeEnum. Setting this property
-     * will result in a true return from isReferral and the resultCode should be
-     * set to REFERRAL.
-     * 
-     * @param referral
-     *            optional referral on REFERRAL errors.
+     * {@inheritDoc}
      */
-    public void setReferral( InternalReferral referral )
+    public void setReferral( Referral referral )
     {
         this.referral = referral;
     }
-
-
-    /**
-     * @param obj The object to compare with
-     * @return <code>true</code> if both objects are equals
-     */
-    public boolean equals( Object obj )
-    {
-        // quickly return true if this is the obj
-        if ( obj == this )
-        {
-            return true;
-        }
-
-        // return false if object does not implement interface
-        if ( !( obj instanceof LdapResult ) )
-        {
-            return false;
-        }
-
-        // compare all the like elements of the two LdapResult objects
-        LdapResult result = ( LdapResult ) obj;
-
-        if ( referral == null && result.getReferral() != null )
-        {
-            return false;
-        }
-
-        if ( result.getReferral() == null && referral != null )
-        {
-            return false;
-        }
-
-        if ( referral != null && result.getReferral() != null )
-        {
-            if ( !referral.equals( result.getReferral() ) )
-            {
-                return false;
-            }
-        }
-
-        if ( !resultCode.equals( result.getResultCode() ) )
-        {
-            return false;
-        }
-
-        // Handle Error Messages where "" is considered equivalent to null
-        String errMsg0 = errorMessage;
-        String errMsg1 = result.getErrorMessage();
-
-        if ( errMsg0 == null )
-        {
-            errMsg0 = "";
-        }
-
-        if ( errMsg1 == null )
-        {
-            errMsg1 = "";
-        }
-
-        if ( !errMsg0.equals( errMsg1 ) )
-        {
-            return false;
-        }
-
-        if ( matchedDn != null )
-        {
-            if ( !matchedDn.equals( result.getMatchedDn() ) )
-            {
-                return false;
-            }
-        }
-        else if ( result.getMatchedDn() != null ) // one is null other is not
-        {
-            return false;
-        }
-
-        return true;
-    }
-
-
-    /**
-     * Get a String representation of a LdapResult
-     * 
-     * @return A LdapResult String
-     */
-    public String toString()
-    {
-
-        StringBuffer sb = new StringBuffer();
-
-        sb.append( "        Ldap Result\n" );
-        sb.append( "            Result code : (" ).append( resultCode ).append( ')' );
-
-        switch ( resultCode )
-        {
-
-            case SUCCESS :
-                sb.append( " success\n" );
-                break;
-
-            case OPERATIONS_ERROR :
-                sb.append( " operationsError\n" );
-                break;
-
-            case PROTOCOL_ERROR :
-                sb.append( " protocolError\n" );
-                break;
-
-            case TIME_LIMIT_EXCEEDED :
-                sb.append( " timeLimitExceeded\n" );
-                break;
-
-            case SIZE_LIMIT_EXCEEDED :
-                sb.append( " sizeLimitExceeded\n" );
-                break;
-
-            case COMPARE_FALSE :
-                sb.append( " compareFalse\n" );
-                break;
-
-            case COMPARE_TRUE :
-                sb.append( " compareTrue\n" );
-                break;
-
-            case AUTH_METHOD_NOT_SUPPORTED :
-                sb.append( " authMethodNotSupported\n" );
-                break;
-
-            case STRONG_AUTH_REQUIRED :
-                sb.append( " strongAuthRequired\n" );
-                break;
-
-            case REFERRAL :
-                sb.append( " referral -- new\n" );
-                break;
-
-            case ADMIN_LIMIT_EXCEEDED :
-                sb.append( " adminLimitExceeded -- new\n" );
-                break;
-
-            case UNAVAILABLE_CRITICAL_EXTENSION :
-                sb.append( " unavailableCriticalExtension -- new\n" );
-                break;
-
-            case CONFIDENTIALITY_REQUIRED :
-                sb.append( " confidentialityRequired -- new\n" );
-                break;
-
-            case SASL_BIND_IN_PROGRESS :
-                sb.append( " saslBindInProgress -- new\n" );
-                break;
-
-            case NO_SUCH_ATTRIBUTE :
-                sb.append( " noSuchAttribute\n" );
-                break;
-
-            case UNDEFINED_ATTRIBUTE_TYPE :
-                sb.append( " undefinedAttributeType\n" );
-                break;
-
-            case INAPPROPRIATE_MATCHING :
-                sb.append( " inappropriateMatching\n" );
-                break;
-
-            case CONSTRAINT_VIOLATION :
-                sb.append( " constraintViolation\n" );
-                break;
-
-            case ATTRIBUTE_OR_VALUE_EXISTS :
-                sb.append( " attributeOrValueExists\n" );
-                break;
-
-            case INVALID_ATTRIBUTE_SYNTAX :
-                sb.append( " invalidAttributeSyntax\n" );
-                break;
-
-            case NO_SUCH_OBJECT :
-                sb.append( " noSuchObject\n" );
-                break;
-
-            case ALIAS_PROBLEM :
-                sb.append( " aliasProblem\n" );
-                break;
-
-            case INVALID_DN_SYNTAX :
-                sb.append( " invalidDNSyntax\n" );
-                break;
-
-            case ALIAS_DEREFERENCING_PROBLEM :
-                sb.append( " aliasDereferencingProblem\n" );
-                break;
-
-            case INAPPROPRIATE_AUTHENTICATION :
-                sb.append( " inappropriateAuthentication\n" );
-                break;
-
-            case INVALID_CREDENTIALS :
-                sb.append( " invalidCredentials\n" );
-                break;
-
-            case INSUFFICIENT_ACCESS_RIGHTS :
-                sb.append( " insufficientAccessRights\n" );
-                break;
-
-            case BUSY :
-                sb.append( " busy\n" );
-                break;
-
-            case UNAVAILABLE :
-                sb.append( " unavailable\n" );
-                break;
-
-            case UNWILLING_TO_PERFORM :
-                sb.append( " unwillingToPerform\n" );
-                break;
-
-            case LOOP_DETECT :
-                sb.append( " loopDetect\n" );
-                break;
-
-            case NAMING_VIOLATION :
-                sb.append( " namingViolation\n" );
-                break;
-
-            case OBJECT_CLASS_VIOLATION :
-                sb.append( " objectClassViolation\n" );
-                break;
-
-            case NOT_ALLOWED_ON_NON_LEAF :
-                sb.append( " notAllowedOnNonLeaf\n" );
-                break;
-
-            case NOT_ALLOWED_ON_RDN :
-                sb.append( " notAllowedOnRDN\n" );
-                break;
-
-            case ENTRY_ALREADY_EXISTS :
-                sb.append( " entryAlreadyExists\n" );
-                break;
-
-            case OBJECT_CLASS_MODS_PROHIBITED :
-                sb.append( " objectClassModsProhibited\n" );
-                break;
-
-            case AFFECTS_MULTIPLE_DSAS :
-                sb.append( " affectsMultipleDSAs -- new\n" );
-                break;
-
-            case OTHER :
-                sb.append( " other\n" );
-                break;
-                
-            default :
-                switch ( resultCode.getResultCode() )
-                {
-                    case 9 :
-                        sb.append( " -- 9 reserved --\n" );
-                        break;
-                        
-                    case 22 :
-                    case 23:
-                    case 24 :
-                    case 25 :
-                    case 26 :
-                    case 27 :
-                    case 28 :
-                    case 29 :
-                    case 30 :
-                    case 31 :
-                        sb.append( " -- 22-31 unused --\n" );
-                        break;
-
-                    case 35 :
-                        sb.append( " -- 35 reserved for undefined isLeaf --\n" );
-                        break;
-                                
-                    case 37 :
-                    case 38 :
-                    case 39 :
-                    case 40 :
-                    case 41 :
-                    case 42 :
-                    case 43 :
-                    case 44 :
-                    case 45 :
-                    case 46 :
-                    case 47 :
-                        sb.append( " -- 37-47 unused --\n" );
-                        break;
-
-                    case 55 :
-                    case 56 :
-                    case 57 :
-                    case 58 :
-                    case 59 :
-                    case 60 :
-                    case 61 :
-                    case 62 :
-                    case 63 :
-                        sb.append( " -- 55-63 unused --\n" );
-                        break;
-
-                    case 70 :
-                        sb.append( " -- 70 reserved for CLDAP --\n" );
-                        break;
-
-                    case 72 :
-                    case 73 :
-                    case 74 :
-                    case 75 :
-                    case 76 :
-                    case 77 :
-                    case 78 :
-                    case 79 :
-                        sb.append( " -- 72-79 unused --\n" );
-                        break;
-
-                    case 81 :
-                    case 82 :
-                    case 83 :
-                    case 84 :
-                    case 85 :
-                    case 86 :
-                    case 87 :
-                    case 88 :
-                    case 89 :
-                    case 90 :
-                        sb.append( " -- 81-90 reserved for APIs --" );
-                        break;
-                        
-                    default :
-                        sb.append( "Unknown error code : " ).append( resultCode );
-                        break;
-                }
-        }
-
-        sb.append( "            Matched DN : '" ).append( matchedDn ).append( "'\n" );
-        sb.append( "            Error message : '" ).append( errorMessage ).append( "'\n"
);
-
-        if ( referral != null )
-        {
-            sb.append( "            Referrals :\n" );
-
-            sb.append( "                Referral :" ).append( referral.toString() ).append(
'\n' );
-        }
-
-        return sb.toString();
-    }
 }

Modified: directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/ResponseWithResult.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/ResponseWithResult.java?rev=761657&r1=761656&r2=761657&view=diff
==============================================================================
--- directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/ResponseWithResult.java
(original)
+++ directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/ResponseWithResult.java
Fri Apr  3 12:55:59 2009
@@ -29,13 +29,18 @@
 public interface ResponseWithResult extends Response
 {
     /**
-     * If called for the first time, this method creates a result containing
-     * response object for this request.
+     * Returns the response's result
      * 
      * @return a result containing response with defaults and the messageId set
      * in response to this specific request
      */
     LdapResult getLdapResult();
     
+    
+    /**
+     * Sets the result into the response.
+     * 
+     * @param ldapResult The LdapResult instance associated with this response
+     */
     void setLdapResult( LdapResult ldapResult );
 }

Modified: directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/SearchRequestImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/SearchRequestImpl.java?rev=761657&r1=761656&r2=761657&view=diff
==============================================================================
--- directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/SearchRequestImpl.java
(original)
+++ directory/shared/branches/shared-replication/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/SearchRequestImpl.java
Fri Apr  3 12:55:59 2009
@@ -75,26 +75,7 @@
     // SearchRequest Interface Method Implementations
     // ------------------------------------------------------------------------
     /**
-     * Gets a list of the attributes to be returned from each entry which
-     * matches the search filter. There are two special values which may be
-     * used: an empty list with no attributes, and the attribute description
-     * string "*". Both of these signify that all user attributes are to be
-     * returned. (The "*" allows the client to request all user attributes in
-     * addition to specific operational attributes). Attributes MUST be named at
-     * most once in the list, and are returned at most once in an entry. If
-     * there are attribute descriptions in the list which are not recognized,
-     * they are ignored by the server. If the client does not want any
-     * attributes returned, it can specify a list containing only the attribute
-     * with OID "1.1". This OID was chosen arbitrarily and does not correspond
-     * to any attribute in use. Client implementors should note that even if all
-     * user attributes are requested, some attributes of the entry may not be
-     * included in search results due to access control or other restrictions.
-     * Furthermore, servers will not return operational attributes, such as
-     * objectClasses or attributeTypes, unless they are listed by name, since
-     * there may be extremely large number of values for certain operational
-     * attributes.
-     * 
-     * @return the collection of attributes to return for each entry
+     * {@inheritDoc}
      */
     public Set<String> getAttributes()
     {



Mime
View raw message