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.api.interceptor.context;
21
22
23 import org.apache.directory.api.ldap.model.name.Dn;
24 import org.apache.directory.server.core.api.CoreSession;
25 import org.apache.directory.server.core.api.OperationEnum;
26
27
28 /**
29 * A context for tracking lookup operations. Lookup operations will return a
30 * cloned server entry.
31 *
32 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33 */
34 public class LookupOperationContext extends FilteringOperationContext
35 {
36 /** flag to indicate if this search is done for replication */
37 private boolean syncreplLookup;
38
39 /**
40 * Creates a new instance of LookupOperationContext.
41 *
42 * @param session The session to use
43 */
44 public LookupOperationContext( CoreSession session )
45 {
46 super( session );
47
48 if ( session != null )
49 {
50 setInterceptors( session.getDirectoryService().getInterceptors( OperationEnum.LOOKUP ) );
51 }
52 }
53
54
55 /**
56 * Creates a new instance of LookupOperationContext.
57 *
58 * @param session The session to use
59 * @param dn The Entry's Dn we are looking for
60 */
61 public LookupOperationContext( CoreSession session, Dn dn )
62 {
63 super( session, dn );
64
65 if ( session != null )
66 {
67 setInterceptors( session.getDirectoryService().getInterceptors( OperationEnum.LOOKUP ) );
68 }
69 }
70
71
72 /**
73 * Creates a new instance of LookupOperationContext.
74 *
75 * @param session The session to use
76 * @param returningAttributes The attributes to return
77 */
78 public LookupOperationContext( CoreSession session, String... returningAttributes )
79 {
80 super( session, returningAttributes );
81
82 if ( session != null )
83 {
84 setInterceptors( session.getDirectoryService().getInterceptors( OperationEnum.LOOKUP ) );
85 }
86 }
87
88
89 /**
90 * Creates a new instance of LookupOperationContext.
91 *
92 * @param session The session to use
93 * @param dn The Entry's Dn we are looking for
94 * @param returningAttributes The attributes to return
95 */
96 public LookupOperationContext( CoreSession session, Dn dn, String... returningAttributes )
97 {
98 super( session, dn, returningAttributes );
99
100 if ( session != null )
101 {
102 setInterceptors( session.getDirectoryService().getInterceptors( OperationEnum.LOOKUP ) );
103 }
104 }
105
106
107 /**
108 * @return the operation name
109 */
110 public String getName()
111 {
112 return "Lookup";
113 }
114
115
116 /**
117 * @return true if this is a syncrepl specific search
118 */
119 public boolean isSyncreplLookup()
120 {
121 return syncreplLookup;
122 }
123
124
125 /**
126 * sets the flag to indicate if this is a synrepl specific search or not
127 *
128 * @param syncreplLookup <tt>true</tt> if it's a syncrepl search
129 */
130 public void setSyncreplLookup( boolean syncreplLookup )
131 {
132 this.syncreplLookup = syncreplLookup;
133 }
134 }