| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| */ |
| package org.apache.directory.api.ldap.model.message; |
| |
| |
| import java.text.ParseException; |
| import java.util.ArrayList; |
| import java.util.Arrays; |
| import java.util.Collections; |
| import java.util.List; |
| |
| import org.apache.directory.api.i18n.I18n; |
| import org.apache.directory.api.ldap.model.exception.LdapException; |
| import org.apache.directory.api.ldap.model.exception.LdapProtocolErrorException; |
| import org.apache.directory.api.ldap.model.filter.BranchNormalizedVisitor; |
| import org.apache.directory.api.ldap.model.filter.ExprNode; |
| import org.apache.directory.api.ldap.model.filter.FilterParser; |
| import org.apache.directory.api.ldap.model.name.Dn; |
| |
| |
| /** |
| * SearchRequest implementation. |
| * |
| * @author <a href="mailto:dev@directory.apache.org"> Apache Directory Project</a> |
| */ |
| public class SearchRequestImpl extends AbstractAbandonableRequest implements SearchRequest |
| { |
| static final long serialVersionUID = -5655881944020886218L; |
| |
| /** Search base distinguished name */ |
| private Dn baseDn; |
| |
| /** Search filter expression tree's root node */ |
| private ExprNode filterNode; |
| |
| /** Search scope enumeration value */ |
| private SearchScope scope; |
| |
| /** Types only return flag */ |
| private boolean typesOnly; |
| |
| /** Max size in entries to return */ |
| private long sizeLimit; |
| |
| /** Max seconds to wait for search to complete */ |
| private int timeLimit; |
| |
| /** Alias dereferencing mode enumeration value (default to DEREF_ALWAYS) */ |
| private AliasDerefMode aliasDerefMode = AliasDerefMode.DEREF_ALWAYS; |
| |
| /** Attributes to return */ |
| private List<String> attributes = new ArrayList<>(); |
| |
| /** The final result containing SearchResponseDone response */ |
| private SearchResultDone response; |
| |
| /** A flag set to tell the search what to do wth referrals */ |
| private ReferralsPolicyEnum referralHandling = ReferralsPolicyEnum.THROW; |
| |
| |
| // ----------------------------------------------------------------------- |
| // Constructors |
| // ----------------------------------------------------------------------- |
| /** |
| * Creates a SearcRequest implementing object used to search the |
| * DIT. |
| */ |
| public SearchRequestImpl() |
| { |
| super( -1, MessageTypeEnum.SEARCH_REQUEST ); |
| } |
| |
| |
| // ------------------------------------------------------------------------ |
| // SearchRequest Interface Method Implementations |
| // ------------------------------------------------------------------------ |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public List<String> getAttributes() |
| { |
| return Collections.unmodifiableList( attributes ); |
| } |
| |
| |
| /** |
| * Gets the search base as a distinguished name. |
| * |
| * @return the search base |
| */ |
| @Override |
| public Dn getBase() |
| { |
| return baseDn; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest setBase( Dn base ) |
| { |
| baseDn = base; |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public AliasDerefMode getDerefAliases() |
| { |
| return aliasDerefMode; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest setDerefAliases( AliasDerefMode aliasDerefAliases ) |
| { |
| this.aliasDerefMode = aliasDerefAliases; |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public ExprNode getFilter() |
| { |
| return filterNode; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest setFilter( ExprNode filter ) |
| { |
| this.filterNode = filter; |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest setFilter( String filter ) throws LdapException |
| { |
| try |
| { |
| filterNode = FilterParser.parse( filter ); |
| } |
| catch ( ParseException pe ) |
| { |
| throw new LdapProtocolErrorException( I18n.err( I18n.ERR_13508_INVALID_FILTER, filter ), pe ); |
| } |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public MessageTypeEnum[] getResponseTypes() |
| { |
| return RESPONSE_TYPES; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchScope getScope() |
| { |
| return scope; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest setScope( SearchScope scope ) |
| { |
| this.scope = scope; |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public long getSizeLimit() |
| { |
| return sizeLimit; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest setSizeLimit( long entriesMax ) |
| { |
| sizeLimit = entriesMax; |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public int getTimeLimit() |
| { |
| return timeLimit; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest setTimeLimit( int secondsMax ) |
| { |
| timeLimit = secondsMax; |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public boolean getTypesOnly() |
| { |
| return typesOnly; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest setTypesOnly( boolean typesOnly ) |
| { |
| this.typesOnly = typesOnly; |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest addAttributes( String... attributesToAdd ) |
| { |
| this.attributes.addAll( Arrays.asList( attributesToAdd ) ); |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest removeAttribute( String attribute ) |
| { |
| attributes.remove( attribute ); |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchResultDone getResultResponse() |
| { |
| if ( response == null ) |
| { |
| response = new SearchResultDoneImpl( getMessageId() ); |
| } |
| |
| return response; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest setMessageId( int messageId ) |
| { |
| super.setMessageId( messageId ); |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest addControl( Control control ) |
| { |
| return ( SearchRequest ) super.addControl( control ); |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest addAllControls( Control[] controls ) |
| { |
| return ( SearchRequest ) super.addAllControls( controls ); |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest removeControl( Control control ) |
| { |
| return ( SearchRequest ) super.removeControl( control ); |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public int hashCode() |
| { |
| int hash = 37; |
| |
| if ( baseDn != null ) |
| { |
| hash = hash * 17 + baseDn.hashCode(); |
| } |
| |
| hash = hash * 17 + aliasDerefMode.hashCode(); |
| hash = hash * 17 + scope.hashCode(); |
| hash = hash * 17 + Long.valueOf( sizeLimit ).hashCode(); |
| hash = hash * 17 + timeLimit; |
| hash = hash * 17 + ( typesOnly ? 0 : 1 ); |
| |
| if ( attributes != null ) |
| { |
| hash = hash * 17 + attributes.size(); |
| |
| // Order doesn't matter, thus just add hashCode |
| for ( String attr : attributes ) |
| { |
| if ( attr != null ) |
| { |
| hash = hash + attr.hashCode(); |
| } |
| } |
| } |
| |
| BranchNormalizedVisitor visitor = new BranchNormalizedVisitor(); |
| filterNode.accept( visitor ); |
| hash = hash * 17 + filterNode.toString().hashCode(); |
| hash = hash * 17 + super.hashCode(); |
| |
| return hash; |
| } |
| |
| |
| /** |
| * Checks to see if two search requests are equal. The Lockable properties |
| * and the get/set context specific parameters are not consulted to |
| * determine equality. The filter expression tree comparison will normalize |
| * the child order of filter branch nodes then generate a string |
| * representation which is comparable. For the time being this is a very |
| * costly operation. |
| * |
| * @param obj the object to check for equality to this SearchRequest |
| * @return true if the obj is a SearchRequest and equals this SearchRequest, |
| * false otherwise |
| */ |
| @Override |
| public boolean equals( Object obj ) |
| { |
| if ( obj == this ) |
| { |
| return true; |
| } |
| |
| if ( !super.equals( obj ) ) |
| { |
| return false; |
| } |
| |
| SearchRequest req = ( SearchRequest ) obj; |
| |
| if ( !req.getBase().equals( baseDn ) ) |
| { |
| return false; |
| } |
| |
| if ( req.getDerefAliases() != aliasDerefMode ) |
| { |
| return false; |
| } |
| |
| if ( req.getScope() != scope ) |
| { |
| return false; |
| } |
| |
| if ( req.getSizeLimit() != sizeLimit ) |
| { |
| return false; |
| } |
| |
| if ( req.getTimeLimit() != timeLimit ) |
| { |
| return false; |
| } |
| |
| if ( req.getTypesOnly() != typesOnly ) |
| { |
| return false; |
| } |
| |
| if ( req.getAttributes() == null && attributes != null && !attributes.isEmpty() ) |
| { |
| return false; |
| } |
| |
| if ( req.getAttributes() != null && attributes == null && !req.getAttributes().isEmpty() ) |
| { |
| return false; |
| } |
| |
| if ( req.getAttributes() != null && attributes != null ) |
| { |
| if ( req.getAttributes().size() != attributes.size() ) |
| { |
| return false; |
| } |
| |
| for ( String attribute : attributes ) |
| { |
| if ( !req.getAttributes().contains( attribute ) ) |
| { |
| return false; |
| } |
| } |
| } |
| |
| BranchNormalizedVisitor visitor = new BranchNormalizedVisitor(); |
| req.getFilter().accept( visitor ); |
| filterNode.accept( visitor ); |
| |
| String myFilterString = filterNode.toString(); |
| String reqFilterString = req.getFilter().toString(); |
| |
| return myFilterString.equals( reqFilterString ); |
| } |
| |
| |
| /** |
| * Return a string the represent a SearchRequest |
| * {@inheritDoc} |
| */ |
| @Override |
| public String toString() |
| { |
| StringBuilder sb = new StringBuilder(); |
| |
| sb.append( " SearchRequest\n" ); |
| sb.append( " baseDn : '" ).append( baseDn ).append( "'\n" ); |
| |
| if ( filterNode != null ) |
| { |
| sb.append( " filter : '" ); |
| sb.append( filterNode.toString() ); |
| sb.append( "'\n" ); |
| } |
| |
| sb.append( " scope : " ); |
| |
| switch ( scope ) |
| { |
| case OBJECT: |
| sb.append( "base object" ); |
| break; |
| |
| case ONELEVEL: |
| sb.append( "single level" ); |
| break; |
| |
| case SUBTREE: |
| sb.append( "whole subtree" ); |
| break; |
| |
| default: |
| throw new IllegalArgumentException( I18n.err( I18n.ERR_13509_UNEXPECTED_SCOPE, scope ) ); |
| } |
| |
| sb.append( '\n' ); |
| |
| sb.append( " typesOnly : " ).append( typesOnly ).append( '\n' ); |
| |
| sb.append( " Size Limit : " ); |
| |
| if ( sizeLimit == 0L ) |
| { |
| sb.append( "no limit" ); |
| } |
| else |
| { |
| sb.append( sizeLimit ); |
| } |
| |
| sb.append( '\n' ); |
| |
| sb.append( " Time Limit : " ); |
| |
| if ( timeLimit == 0 ) |
| { |
| sb.append( "no limit" ); |
| } |
| else |
| { |
| sb.append( timeLimit ); |
| } |
| |
| sb.append( '\n' ); |
| |
| sb.append( " Deref Aliases : " ); |
| |
| switch ( aliasDerefMode ) |
| { |
| case NEVER_DEREF_ALIASES: |
| sb.append( "never Deref Aliases" ); |
| break; |
| |
| case DEREF_IN_SEARCHING: |
| sb.append( "deref In Searching" ); |
| break; |
| |
| case DEREF_FINDING_BASE_OBJ: |
| sb.append( "deref Finding Base Obj" ); |
| break; |
| |
| case DEREF_ALWAYS: |
| sb.append( "deref Always" ); |
| break; |
| |
| default: |
| throw new IllegalArgumentException( I18n.err( I18n.ERR_13517_UNEXPECTED_ALIAS_DEREF_MODE, aliasDerefMode ) ); |
| } |
| |
| sb.append( '\n' ); |
| sb.append( " attributes : " ); |
| |
| boolean isFirst = true; |
| |
| if ( attributes != null ) |
| { |
| for ( String attribute : attributes ) |
| { |
| if ( isFirst ) |
| { |
| isFirst = false; |
| } |
| else |
| { |
| sb.append( ", " ); |
| } |
| |
| sb.append( '\'' ).append( attribute ).append( '\'' ); |
| } |
| } |
| |
| sb.append( '\n' ); |
| |
| // The controls |
| sb.append( super.toString() ); |
| |
| return super.toString( sb.toString() ); |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public boolean isFollowReferrals() |
| { |
| return referralHandling == ReferralsPolicyEnum.FOLLOW; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest followReferrals() |
| { |
| referralHandling = ReferralsPolicyEnum.FOLLOW; |
| |
| return this; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public boolean isIgnoreReferrals() |
| { |
| return referralHandling == ReferralsPolicyEnum.IGNORE; |
| } |
| |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public SearchRequest ignoreReferrals() |
| { |
| referralHandling = ReferralsPolicyEnum.IGNORE; |
| |
| return this; |
| } |
| } |