com.flexive.shared
Class EJBLookup

java.lang.Object
  extended by com.flexive.shared.EJBLookup

public class EJBLookup
extends java.lang.Object

Utility class for EJB lookups.

Author:
Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at), Markus Plesser (markus.plesser@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Field Summary
static java.lang.String EJB31_EMBEDDED_APPNAME
          EJB 3.1+ embedded application name.
 
Constructor Summary
protected EJBLookup()
          Protected default constructor to avoid instantiation.
 
Method Summary
static void clearCache()
          Clear the static interface cache on shutdown.
static AccountEngine getAccountEngine()
          Lookup of the AccountEngine EJB.
static ACLEngine getAclEngine()
          Lookup of the ACLEngine EJB.
static ApplicationConfigurationEngine getApplicationConfigurationEngine()
          Lookup of the ApplicationConfigurationEngine EJB.
static AssignmentEngine getAssignmentEngine()
          Lookup of the AssignmentEngine EJB.
static BriefcaseEngine getBriefcaseEngine()
          Lookup of the Briefcase EJB.
static CmisSearchEngine getCmisSearchEngine()
          Lookup of the CmisSearchEngine EJB.
static ConfigurationEngine getConfigurationEngine()
          Lookup of the FxConfiguration EJB.
static ContentEngine getContentEngine()
          Lookup of the ContentEngine EJB.
static DivisionConfigurationEngine getDivisionConfigurationEngine()
          Lookup of the DivisionConfigurationEngine EJB.
static
<T> T
getEngine(java.lang.Class<T> type)
          Lookup the EJB found under the given Class's name.
static
<T> T
getEngine(java.lang.String appName, java.lang.Class<T> type)
          Lookup the EJB found under the given Class's name.
static GlobalConfigurationEngine getGlobalConfigurationEngine()
          Lookup of the GlobalConfigurationBean EJB.
static HistoryTrackerEngine getHistoryTrackerEngine()
          Lookup of the HistoryTrackerEngine EJB.
static javax.naming.Context getInitialContext()
          Adjust the environment with strategy/application server specific settings
protected static
<T> T
getInterface(java.lang.Class<T> type, java.lang.String appName, java.util.Hashtable<java.lang.String,java.lang.String> environment)
          Lookup the EJB found under the given Class's name.
static LanguageEngine getLanguageEngine()
          Lookup of the Language EJB.
static MandatorConfigurationEngine getMandatorConfigurationEngine()
          Lookup of the MandatorConfigurationEngine EJB.
static MandatorEngine getMandatorEngine()
          Lookup of the MandatorEngine EJB.
static NodeConfigurationEngine getNodeConfigurationEngine()
          Lookup of the NodeConfigurationEngine EJB.
static PhraseEngine getPhraseEngine()
          Lookup of the PhraseEngine EJB.
static ResultPreferencesEngine getResultPreferencesEngine()
          Lookup of the ResultPreferencesEngine EJB.
static ScriptingEngine getScriptingEngine()
          Lookup of the ScriptingEngine EJB
static SearchEngine getSearchEngine()
          Lookup of the SqlSearch EJB.
static SelectListEngine getSelectListEngine()
          Lookup of the SelectListEngine EJB.
static SequencerEngine getSequencerEngine()
          Lookup of the SequencerEngine EJB.
static javax.ejb.SessionContext getSessionContext()
          Get a reference of the current EJB session context.
static StatelessTest getStatelessTestInterface()
          Lookup of the StatelessTest EJB.
static FxTimerService getTimerService()
          Lookup of the FxTimerService EJB
static javax.transaction.TransactionManager getTransactionManager()
          Get a reference of the transaction manager
static TreeEngine getTreeEngine()
          Lookup of the FxTree EJB
static TypeEngine getTypeEngine()
          Lookup of the TypeEngine EJB.
static UserConfigurationEngine getUserConfigurationEngine()
          Lookup of the UserConfigurationEngine EJB.
static UserGroupEngine getUserGroupEngine()
          Lookup of the GroupEngine EJB.
static WorkflowEngine getWorkflowEngine()
          Lookup of the WorkflowEngine EJB.
static RouteEngine getWorkflowRouteEngine()
          Lookup of the RouteEngine EJB.
static StepDefinitionEngine getWorkflowStepDefinitionEngine()
          Lookup of the StepDefinitionEngine EJB.
static StepEngine getWorkflowStepEngine()
          Lookup of the StepEngine EJB.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EJB31_EMBEDDED_APPNAME

public static final java.lang.String EJB31_EMBEDDED_APPNAME
EJB 3.1+ embedded application name. This must be the application name set in the container and will be used for building the JNDI paths of our EJBs. The resulting path will look like this:

java:global/flexive-embedded/ScriptingEngine!com.flexive.shared.interfaces.ScriptingEngine

Since:
3.1.4
See Also:
Constant Field Values
Constructor Detail

EJBLookup

protected EJBLookup()
Protected default constructor to avoid instantiation.

Method Detail

getAccountEngine

public static AccountEngine getAccountEngine()
Lookup of the AccountEngine EJB.

Returns:
a reference to the AccountEngine EJB

getSearchEngine

public static SearchEngine getSearchEngine()
Lookup of the SqlSearch EJB.

Returns:
a reference to the SqlSearch EJB

getBriefcaseEngine

public static BriefcaseEngine getBriefcaseEngine()
Lookup of the Briefcase EJB.

Returns:
a reference to the Briefcase EJB

getUserGroupEngine

public static UserGroupEngine getUserGroupEngine()
Lookup of the GroupEngine EJB.

Returns:
a reference to the GroupEngine EJB

getMandatorEngine

public static MandatorEngine getMandatorEngine()
Lookup of the MandatorEngine EJB.

Returns:
a reference to the MandatorEngine EJB

getAclEngine

public static ACLEngine getAclEngine()
Lookup of the ACLEngine EJB.

Returns:
a reference to the ACLEngine EJB

getLanguageEngine

public static LanguageEngine getLanguageEngine()
Lookup of the Language EJB.

Returns:
a reference to the Language EJB

getUserConfigurationEngine

public static UserConfigurationEngine getUserConfigurationEngine()
Lookup of the UserConfigurationEngine EJB.

Returns:
a reference to the UserConfigurationEngine EJB

getDivisionConfigurationEngine

public static DivisionConfigurationEngine getDivisionConfigurationEngine()
Lookup of the DivisionConfigurationEngine EJB.

Returns:
a reference to the DivisionConfigurationEngine EJB

getApplicationConfigurationEngine

public static ApplicationConfigurationEngine getApplicationConfigurationEngine()
Lookup of the ApplicationConfigurationEngine EJB.

Returns:
a reference to the ApplicationConfigurationEngine EJB
Since:
3.1

getNodeConfigurationEngine

public static NodeConfigurationEngine getNodeConfigurationEngine()
Lookup of the NodeConfigurationEngine EJB.

Returns:
a reference to the NodeConfigurationEngine EJB
Since:
3.1

getMandatorConfigurationEngine

public static MandatorConfigurationEngine getMandatorConfigurationEngine()
Lookup of the MandatorConfigurationEngine EJB.

Returns:
a reference to the MandatorConfigurationEngine EJB
Since:
3.1.6

getGlobalConfigurationEngine

public static GlobalConfigurationEngine getGlobalConfigurationEngine()
Lookup of the GlobalConfigurationBean EJB.

Returns:
a reference to the GlobalConfigurationBean EJB.

getConfigurationEngine

public static ConfigurationEngine getConfigurationEngine()
Lookup of the FxConfiguration EJB.

Returns:
a reference to the FxConfiguration EJB.

getAssignmentEngine

public static AssignmentEngine getAssignmentEngine()
Lookup of the AssignmentEngine EJB.

Returns:
a reference to the AssignmentEngine EJB.

getTypeEngine

public static TypeEngine getTypeEngine()
Lookup of the TypeEngine EJB.

Returns:
a reference to the TypeEngine EJB.

getSelectListEngine

public static SelectListEngine getSelectListEngine()
Lookup of the SelectListEngine EJB.

Returns:
a reference to the SelectListEngine EJB

getWorkflowEngine

public static WorkflowEngine getWorkflowEngine()
Lookup of the WorkflowEngine EJB.

Returns:
a reference to the WorkflowEngine EJB.

getWorkflowStepEngine

public static StepEngine getWorkflowStepEngine()
Lookup of the StepEngine EJB.

Returns:
a reference to the StepEngine EJB.

getWorkflowRouteEngine

public static RouteEngine getWorkflowRouteEngine()
Lookup of the RouteEngine EJB.

Returns:
a reference to the RouteEngine EJB.

getWorkflowStepDefinitionEngine

public static StepDefinitionEngine getWorkflowStepDefinitionEngine()
Lookup of the StepDefinitionEngine EJB.

Returns:
a reference to the StepDefinitionEngine EJB.

getContentEngine

public static ContentEngine getContentEngine()
Lookup of the ContentEngine EJB.

Returns:
a reference to the ContentEngine EJB.

getStatelessTestInterface

public static StatelessTest getStatelessTestInterface()
Lookup of the StatelessTest EJB.

Returns:
a reference to the StatelessTest EJB.

getSequencerEngine

public static SequencerEngine getSequencerEngine()
Lookup of the SequencerEngine EJB.

Returns:
a reference to the SequencerEngine EJB.

getScriptingEngine

public static ScriptingEngine getScriptingEngine()
Lookup of the ScriptingEngine EJB

Returns:
a reference to the ScriptingEngine EJB

getTimerService

public static FxTimerService getTimerService()
Lookup of the FxTimerService EJB

Returns:
a reference to the FxTimerService EJB

getTreeEngine

public static TreeEngine getTreeEngine()
Lookup of the FxTree EJB

Returns:
a reference to the FxTree EJB

getResultPreferencesEngine

public static ResultPreferencesEngine getResultPreferencesEngine()
Lookup of the ResultPreferencesEngine EJB.

Returns:
a reference to the ResultPreferencesEngine EJB.

getHistoryTrackerEngine

public static HistoryTrackerEngine getHistoryTrackerEngine()
Lookup of the HistoryTrackerEngine EJB.

Returns:
a reference to the HistoryTrackerEngine EJB

getCmisSearchEngine

public static CmisSearchEngine getCmisSearchEngine()
Lookup of the CmisSearchEngine EJB.

Returns:
a reference to the CmisSearchEngine EJB.
Since:
3.1

getPhraseEngine

public static PhraseEngine getPhraseEngine()
Lookup of the PhraseEngine EJB.

Returns:
a reference to the PhraseEngine EJB
Since:
3.2.0

getTransactionManager

public static javax.transaction.TransactionManager getTransactionManager()
Get a reference of the transaction manager

Returns:
TransactionManager

getSessionContext

public static javax.ejb.SessionContext getSessionContext()
Get a reference of the current EJB session context.

Returns:
the EJB session context

getInterface

protected static <T> T getInterface(java.lang.Class<T> type,
                                    java.lang.String appName,
                                    java.util.Hashtable<java.lang.String,java.lang.String> environment)
Lookup the EJB found under the given Class's name. Uses default flexive naming scheme.

Type Parameters:
T - EJB interface type
Parameters:
type - EJB interface class instance
appName - EJB application name
environment - optional environment for creating the initial context
Returns:
a reference to the given EJB

getInitialContext

public static javax.naming.Context getInitialContext()
                                              throws javax.naming.NamingException
Adjust the environment with strategy/application server specific settings

Returns:
Context
Throws:
javax.naming.NamingException - on errors

getEngine

public static <T> T getEngine(java.lang.String appName,
                              java.lang.Class<T> type)
Lookup the EJB found under the given Class's name. Uses default flexive naming scheme.

Type Parameters:
T - EJB interface type
Parameters:
appName - EJB application name
type - EJB interface class instance
Returns:
a reference to the given EJB

getEngine

public static <T> T getEngine(java.lang.Class<T> type)
Lookup the EJB found under the given Class's name. Uses default flexive naming scheme.

Type Parameters:
T - EJB interface type
Parameters:
type - EJB interface class instance
Returns:
a reference to the given EJB

clearCache

public static void clearCache()
Clear the static interface cache on shutdown.

Since:
3.1.4