/*!
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* Copyright (c) 2002-2013 Pentaho Corporation.. All rights reserved.
*/
package org.pentaho.platform.api.engine;
import java.util.List;
import java.util.Map;
/**
* The way the BI platform creates and manages system objects.
* <p>
* Here is an example of how the API might be used:
* <p>
* <code>
* 1. IPentahoObjectFactory fac = new MyPentahoObjectFactory();<br>
* //configure the factory with an object specification file and/or a runtime context object<br>
* 2. fac.init(objectSpecFile, contextObject) {@link IPentahoObjectFactory#init(String, Object)}<br>
* 3. ISolutionEngine eng = fac.get(ISolutionEngine.class, session)
* {@link IPentahoObjectFactory#get(Class, IPentahoSession)}
* </code>
* <p>
*
* You will notice that the this way of serving up objects does not expose an API for scoping of objects. This
* behavior is delegated to the particular {@link IPentahoObjectFactory} implementation, which means a factory
* implementation has total freedom to be as simple or sophisticated at it wants without being required to handle
* object scoping. Any kind of object binding/scoping or any other rules for the creation and management of objects
* is totally up the implementation. Typically, a factory implementation would be made aware of it's rules for
* object creation by way of a well-known object specification file, see {@link #init(String, Object)}
*
* @author Aaron Phillips
*/
public interface IPentahoObjectFactory {
// Available Factory impls are ordered by priority. If one is not provided this default value is used.
public static final int DEFAULT_PRIORTIY = 0;
/**
* Retrieves an instance of a Pentaho BI Server API interface using the simple interface name (interfaceClass
* name without the package) as the object key. If an appropriate implementation does not exist the factory
* implementation should create it.
*
* @param interfaceClass
* the type of object to retrieve (retrieved object will be returned as this type)
* @param session
* the Pentaho session object. Can be used to associate an object instance to a Pentaho session. Value
* will be null if request to getObject does not originate in a session context.
* @return the implementation object typed to interfaceClass
* @throws ObjectFactoryException
* if the object cannot be retrieved
*/
public <T> T get( Class<T> interfaceClass, final IPentahoSession session ) throws ObjectFactoryException;
/**
* Retrieves an instance of a Pentaho BI Server API interface by the given object key. If an appropriate
* implementation does not exist the factory implementation should create it.
*
* @param interfaceClass
* the type of object to retrieve (retrieved object will be returned as this type)
* @param key
* the object identifier, typically the interface name
* @param session
* the Pentaho session object. Can be used to associate an object instance to a Pentaho session. Value
* will be null if request to getObject does not originate in a session context.
* @return the implementation object typed to interfaceClass
* @throws ObjectFactoryException
* if the object cannot be retrieved
*
* @Deprecated use {@link IPentahoObjectFactory#get(Class, IPentahoSession)} instead}
*/
public <T> T get( Class<T> interfaceClass, String key, final IPentahoSession session ) throws ObjectFactoryException;
/**
* Retrieves an instance of a Pentaho BI Server API interface using the simple interface name (interfaceClass
* name without the package) as the object key. If an appropriate implementation does not exist the factory
* implementation should create it.
*
* @param interfaceClass
* the type of object to retrieve (retrieved object will be returned as this type)
* @param session
* the Pentaho session object. Can be used to associate an object instance to a Pentaho session. Value
* will be null if request to getObject does not originate in a session context.
* @param properties
* Map of properties to filter matches in the ObjectFactory by
*
* @return the implementation object typed to interfaceClass
* @throws ObjectFactoryException
* if the object cannot be retrieved
*/
public <T> T get( Class<T> interfaceClass, final IPentahoSession session, Map<String, String> properties )
throws ObjectFactoryException;
/**
* Checks if the implementation for the given interface is defined.
*
* @param key
* the object identifier, typically the interface name
* @return true if the object is defined
*/
public boolean objectDefined( String key );
/**
* Checks if the implementation for the given interface is defined.
*
* @param clazz
* Interface or class literal to search for
* @return true if the object is defined
*/
public boolean objectDefined( Class<?> clazz );
/**
* Provides the concrete Class defined for the given object key.
*
* @param key
* the object identifier, typically the interface name
* @return the type of object associated with key
* @throws RuntimeException
* of some type indicating a problem loading or finding the implementing class
*/
public Class<?> getImplementingClass( String key );
/**
* Initialize the factory with optional configuration file and runtime context. Calling this method should also
* reset any state the factory may be holding, such as object definitions.
*
* @param configFile
* an object configuration definition file understandable by the factory implementation
* @param context
* a context object whereby the factory implementation can access runtime information, type of object
* varies depending on the framework used by the factory and the environment in which the application is
* running.
*/
public void init( String configFile, Object context );
/**
*
* Returns all objects implementing the provided interface or extending the provided class if the Class is not an
* Interface.
*
* The returned list will be ordered by the optional "priority" property
*
*
* @param interfaceClass
* Interface or Class literal for which implementations of will be found
* @param curSession
* current session to be used for session-based implementations
* @return List of registered implementations
*/
<T> List<T> getAll( Class<T> interfaceClass, IPentahoSession curSession ) throws ObjectFactoryException;
/**
*
* Returns all objects implementing the provided interface or extending the provided class if the Class is not an
* Interface.
*
* The returned list will be ordered by the optional "priority" property
*
*
* @param interfaceClass
* Interface or Class literal for which implementations of will be found
* @param curSession
* current session to be used for session-based implementations
* @param properties
* Map of properties to filter matches in the ObjectFactory by
*
* @return List of registered implementations
*/
<T> List<T> getAll( Class<T> interfaceClass, IPentahoSession curSession, Map<String, String> properties )
throws ObjectFactoryException;
/**
* Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
*
* @param interfaceClass
* Interface or Class literal for which implementations of will be found
* @param curSession
* current session to be used for session-based implementations
* @return IPentahoObjectReference for the matching Object or null if no Object is found
*/
<T> IPentahoObjectReference<T> getObjectReference( Class<T> interfaceClass, IPentahoSession curSession )
throws ObjectFactoryException;
/**
* Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
*
* @param interfaceClass
* Interface or Class literal for which implementations of will be found
* @param curSession
* current session to be used for session-based implementations
* @param properties
* Map of properties to filter matches in the ObjectFactory by
*
* @return IPentahoObjectReference for the matching Object or null if no Object is found
*/
<T> IPentahoObjectReference<T> getObjectReference( Class<T> interfaceClass, IPentahoSession curSession,
Map<String, String> properties ) throws ObjectFactoryException;
/**
* Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
*
* @param interfaceClass
* Interface or Class literal for which implementations of will be found
* @param curSession
* current session to be used for session-based implementations
* @return IPentahoObjectReference for the matching Object or null if no Object is found
*/
<T> List<IPentahoObjectReference<T>> getObjectReferences( Class<T> interfaceClass, IPentahoSession curSession )
throws ObjectFactoryException;
/**
* Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
*
* @param interfaceClass
* Interface or Class literal for which implementations of will be found
* @param curSession
* current session to be used for session-based implementations
* @param properties
* Map of properties to filter matches in the ObjectFactory by
*
* @return IPentahoObjectReference for the matching Object or null if no Object is found
*/
<T> List<IPentahoObjectReference<T>> getObjectReferences( Class<T> interfaceClass, IPentahoSession curSession,
Map<String, String> properties ) throws ObjectFactoryException;
/**
* Return the name for this factory. Not assumed to be unique. Useful for logging only
*
* @return factory name
*/
String getName();
}