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.mitosis.common;
21  
22  
23  import javax.naming.NamingException;
24  
25  import org.apache.directory.server.core.entry.ClonedServerEntry;
26  import org.apache.directory.server.core.filtering.EntryFilter;
27  import org.apache.directory.server.core.interceptor.context.SearchingOperationContext;
28  import org.apache.directory.shared.ldap.entry.EntryAttribute;
29  
30  
31  /**
32   * Defines constant values used by Mitosis.
33   *
34   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
35   */
36  public class Constants
37  {
38      /**
39       * The name of the attribute that represents the {@link UUID} of an
40       * LDAP entry.
41       */
42      public static final String ENTRY_UUID = "entryUUID";
43      
44      /**
45       * The name of the attribute that represents the {@link CSN} of an LDAP
46       * entry.
47       */
48      public static final String ENTRY_CSN = "entryCSN";
49      
50      /**
51       * The name of the attribute that determines if an entry is actually
52       * deleted or not (even if it exists in a DIT.)
53       */
54      public static final String ENTRY_DELETED = "entryDeleted";
55      
56      /**
57       * A {@link SearchResultFilter} that filters out the entries whose
58       * {@link #ENTRY_DELETED} attribute is <tt>TRUE</tt>.
59       */
60      public static final EntryFilter DELETED_ENTRIES_FILTER = new EntryFilter()
61      {
62          public boolean accept( SearchingOperationContext operation, ClonedServerEntry entry )
63              throws NamingException
64          {
65              EntryAttribute deleted = entry.get( ENTRY_DELETED );
66              Object value = deleted == null ? null : deleted.get();
67              return ( value == null || !"TRUE".equalsIgnoreCase( value.toString() ) );
68          }
69      };
70  
71  
72      private Constants()
73      {
74      }
75  }