View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.server.core.filtering;
21  
22  
23  import org.apache.directory.server.core.entry.ClonedServerEntry;
24  import org.apache.directory.server.core.interceptor.context.SearchingOperationContext;
25  
26  
27  /**
28   * An entry filter is used to modify search results while they are being 
29   * returned from Cursors over ServerEntry objects.  These filters are used in
30   * conjunction with a {@link FilteringCursor}.  Multiple filters can be 
31   * applied one after the other and hence they are stack-able and applied in
32   * order.
33   *
34   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
35   * @version $Rev$
36   */
37  public interface EntryFilter
38  {
39      /**
40       * Filters the contents of search entries on the way out the door to 
41       * client callers.  These filters can and do produce side-effects on the 
42       * entry results if need be.  These entries, their attributes and values
43       * should be cloned when alterations are made to avoid altering cached
44       * entries.
45       *
46       * @param result the result to accept or reject possibly modifying it
47       * @param controls search controls associated with the invocation
48       * @return true if the entry is to be returned, false if it is rejected
49       * @throws Exception if there are failures during evaluation
50       */
51      boolean accept( SearchingOperationContext operation, ClonedServerEntry result ) throws Exception;
52  }