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.sp;
21  
22  
23  import org.apache.directory.server.core.CoreSession;
24  import org.apache.directory.server.core.entry.ServerEntry;
25  
26  
27  /**
28   * An abstraction over stored procedure execution depending on the type of the language supported.
29   * 
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   * @version $Rev$ $Date$
32   */
33  public interface StoredProcEngine
34  {
35      
36      /**
37       * Returns the unique identifier of the supported stored procedure language.
38       * 
39       */
40      public String getSPLangId();
41      
42      
43      /**
44       * Registers an entry found to be contaning a stored procedure unit which this engine can operate on.
45       *
46       * <p>
47       * This method should be called before an attempt to invoke a stored procedure via this Engine.
48       */
49      public void setSPUnitEntry( final ServerEntry spUnit );
50      
51      
52      /**
53       * Invokes the stored procedure handled by the engine.
54       * 
55       * @param fullSPName A fully qualified name of the stored procedure including its unit name.
56       * @param spArgs A list or arguments to be passed to the stored procedure. It should be an empty array if there aren't any parameters defined.
57       * @return The value obtained from invoked procedure. The client should know what will return exactly so that it can downcast to the appropriate type.
58       * @throws NamingException If an error occurs during invocation.
59       */
60      public Object invokeProcedure( CoreSession session, String fullSPName, Object[] spArgs ) throws Exception;
61  
62  }