001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020 package org.apache.directory.server.core.sp; 021 022 023 import org.apache.directory.server.core.CoreSession; 024 import org.apache.directory.shared.ldap.entry.ServerEntry; 025 026 027 /** 028 * An abstraction over stored procedure execution depending on the type of the language supported. 029 * 030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 031 * @version $Rev$ $Date$ 032 */ 033 public interface StoredProcEngine 034 { 035 036 /** 037 * Returns the unique identifier of the supported stored procedure language. 038 * 039 */ 040 public String getSPLangId(); 041 042 043 /** 044 * Registers an entry found to be contaning a stored procedure unit which this engine can operate on. 045 * 046 * <p> 047 * This method should be called before an attempt to invoke a stored procedure via this Engine. 048 */ 049 public void setSPUnitEntry( final ServerEntry spUnit ); 050 051 052 /** 053 * Invokes the stored procedure handled by the engine. 054 * 055 * @param fullSPName A fully qualified name of the stored procedure including its unit name. 056 * @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. 057 * @return The value obtained from invoked procedure. The client should know what will return exactly so that it can downcast to the appropriate type. 058 * @throws NamingException If an error occurs during invocation. 059 */ 060 public Object invokeProcedure( CoreSession session, String fullSPName, Object[] spArgs ) throws Exception; 061 062 }