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.protocol.shared.store;
21  
22  
23  import java.io.Serializable;
24  
25  import org.apache.directory.server.core.CoreSession;
26  import org.apache.directory.shared.ldap.name.LdapDN;
27  
28  
29  /**
30   * Interface to support the command pattern for LDAP operations.
31   *
32   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33   * @version $Rev$, $Date$
34   */
35  public interface DirectoryServiceOperation extends Serializable
36  {
37      /**
38       * The command pattern execute method.
39       * 
40       * @param session The CoreSession to execute the command with
41       * @param baseDn The base DN for working with the context
42       * @return Object The result returned by the command
43       * @throws Exception The exception thrown by the command
44       */
45      public Object execute( CoreSession session, LdapDN baseDn ) throws Exception;
46  }