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 */ 020package org.apache.directory.server.core.api.sp; 021 022 023import org.apache.directory.api.ldap.model.entry.Entry; 024import org.apache.directory.api.ldap.model.exception.LdapException; 025import org.apache.directory.server.core.api.CoreSession; 026 027 028/** 029 * An abstraction over stored procedure execution depending on the type of the language supported. 030 * 031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 032 */ 033public interface StoredProcEngine 034{ 035 036 /** 037 * @return the unique identifier of the supported stored procedure language. 038 */ 039 String getSPLangId(); 040 041 042 /** 043 * Registers an entry found to be containing a stored procedure unit which this engine can operate on. 044 * 045 * This method should be called before an attempt to invoke a stored procedure via this Engine. 046 * 047 * @param spUnit The Stored Procedure unit to set 048 */ 049 void setSPUnitEntry( Entry spUnit ); 050 051 052 /** 053 * Invokes the stored procedure handled by the engine. 054 * 055 * @param session The CoreSession it's acting on 056 * @param fullSPName A fully qualified name of the stored procedure including its unit name. 057 * @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. 058 * @return The value obtained from invoked procedure. The client should know what will return exactly so that it can downcast to the appropriate type. 059 * @throws org.apache.directory.api.ldap.model.exception.LdapException If an error occurs during invocation. 060 */ 061 Object invokeProcedure( CoreSession session, String fullSPName, Object[] spArgs ) throws LdapException; 062}