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.xdbm.search.evaluator;
21
22
23 import org.apache.directory.api.ldap.model.entry.Entry;
24 import org.apache.directory.api.ldap.model.exception.LdapException;
25 import org.apache.directory.api.ldap.model.filter.UndefinedNode;
26 import org.apache.directory.server.core.api.partition.PartitionTxn;
27 import org.apache.directory.server.xdbm.IndexEntry;
28 import org.apache.directory.server.xdbm.Store;
29 import org.apache.directory.server.xdbm.search.Evaluator;
30
31
32 /**
33 * An Evaluator that always validate all the submitted values
34 *
35 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
36 */
37 public class PassThroughEvaluator implements Evaluator<UndefinedNode>
38 {
39 /** The backend */
40 private final Store db;
41
42
43 /**
44 * Create a new instance of the PassThroughEvaluator
45 *
46 * @param db The Store instance
47 */
48 public PassThroughEvaluator( Store db )
49 {
50 this.db = db;
51 }
52
53
54 /**
55 * {@inheritDoc}
56 */
57 public boolean evaluate( PartitionTxn partitionTxn, IndexEntry<?, String> indexEntry ) throws LdapException
58 {
59 Entry entry = indexEntry.getEntry();
60
61 // resuscitate the entry if it has not been and set entry in IndexEntry
62 if ( null == entry )
63 {
64 entry = db.fetch( partitionTxn, indexEntry.getId() );
65
66 if ( null == entry )
67 {
68 // The entry is not anymore present : get out
69 return false;
70 }
71
72 indexEntry.setEntry( entry );
73 }
74
75 return true;
76 }
77
78
79 /**
80 * {@inheritDoc}
81 */
82 public boolean evaluate( Entry entry ) throws LdapException
83 {
84 return true;
85 }
86
87
88 /**
89 * Gets the expression used by this expression Evaluator.
90 *
91 * @return the AST for the expression
92 */
93 public UndefinedNode getExpression()
94 {
95 return null;
96 }
97
98
99 /**
100 * @see Object#toString()
101 */
102 public String toString( String tabs )
103 {
104 StringBuilder sb = new StringBuilder();
105
106 sb.append( tabs ).append( "PassthroughEvaluator\n" );
107
108 return sb.toString();
109 }
110
111
112 /**
113 * @see Object#toString()
114 */
115 public String toString()
116 {
117 return toString( "" );
118 }
119 }