org.bonitasoft.engine.api.impl

Class ServerAPIImpl

java.lang.Object

org.bonitasoft.engine.api.impl.ServerAPIImpl

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, org.bonitasoft.engine.api.internal.ServerAPI

public class ServerAPIImpl
extends java.lang.Object
implements org.bonitasoft.engine.api.internal.ServerAPI

Author:

Matthieu Chaffotte, Baptiste Mesta, Celine Souchet

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ServerAPIImpl.SessionType

Field Summary

Fields

Modifier and Type	Field and Description
protected APIAccessResolver	accessResolver

Constructor Summary

Constructors

Constructor and Description
ServerAPIImpl()
ServerAPIImpl(boolean cleanSession)
ServerAPIImpl(boolean cleanSession, APIAccessResolver accessResolver) For Test Mock usage

Method Summary

Modifier and Type	Method and Description
protected void	checkIsValidModeFor(boolean tenantRunning, AvailableWhenTenantIsPaused annotation, long tenantId, java.lang.Object apiImpl, java.lang.reflect.Method method, java.lang.String apiInterfaceName)
protected void	checkMethodAccessibility(java.lang.Object apiImpl, java.lang.String apiInterfaceName, java.lang.reflect.Method method, org.bonitasoft.engine.session.Session session, boolean isAlreadyInTransaction)
protected void	checkTenantIsInAValidModeFor(java.lang.Object apiImpl, java.lang.reflect.Method method, java.lang.String apiInterfaceName, long tenantId, org.bonitasoft.engine.session.Session session, boolean isAlreadyInTransaction)
protected java.lang.Class<?>[]	getParameterTypes(java.util.List<java.lang.String> classNameParameters)
protected ServerAPIImpl.SessionType	getSessionType(org.bonitasoft.engine.session.Session session)
protected java.lang.Object	invokeAPI(java.lang.reflect.Method method, java.lang.Object apiImpl, java.lang.Object... parametersValues)
protected java.lang.Object	invokeAPIInTransaction(java.lang.Object[] parametersValues, java.lang.Object apiImpl, java.lang.reflect.Method method, org.bonitasoft.engine.session.Session session, java.lang.String apiInterfaceName)
protected java.lang.Object	invokeAPIOutsideTransaction(java.lang.Object[] parametersValues, java.lang.Object apiImpl, java.lang.reflect.Method method, java.lang.String apiInterfaceName, org.bonitasoft.engine.session.Session session)
java.lang.Object	invokeMethod(java.util.Map<java.lang.String,java.io.Serializable> options, java.lang.String apiInterfaceName, java.lang.String methodName, java.util.List<java.lang.String> classNameParameters, java.lang.Object[] parametersValues)
protected boolean	isMethodAvailableOnPausedTenant(boolean tenantRunning, AvailableWhenTenantIsPaused annotation)
protected boolean	isMethodAvailableOnRunningTenant(boolean tenantRunning, AvailableWhenTenantIsPaused annotation)
protected boolean	isNodeInAValidStateFor(java.lang.reflect.Method method)
protected boolean	isTenantAvailable(long tenantId, org.bonitasoft.engine.session.Session session, boolean isAlreadyInTransaction)
protected void	logNodeNotStartedMessage(java.lang.String apiInterfaceName, java.lang.reflect.Method method)
protected void	logTechnicalErrorMessage(java.lang.String message)
protected void	methodCannotBeCalledOnPausedTenant(java.lang.Object apiImpl, java.lang.String apiInterfaceName, java.lang.reflect.Method method, long tenantId)
protected void	methodCannotBeCalledOnRunningTenant(java.lang.Object apiImpl, java.lang.String apiInterfaceName, java.lang.reflect.Method method, long tenantId)
protected UserTransactionService	selectUserTransactionService(org.bonitasoft.engine.session.Session session, ServerAPIImpl.SessionType sessionType)
protected org.bonitasoft.engine.exception.BonitaRuntimeException	wrapThrowable(java.lang.Throwable cause)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

accessResolver

protected final APIAccessResolver accessResolver

Constructor Detail

ServerAPIImpl

public ServerAPIImpl()

ServerAPIImpl

public ServerAPIImpl(boolean cleanSession)

ServerAPIImpl

public ServerAPIImpl(boolean cleanSession,
                     APIAccessResolver accessResolver)

For Test Mock usage

Method Detail

invokeMethod

public java.lang.Object invokeMethod(java.util.Map<java.lang.String,java.io.Serializable> options,
                                     java.lang.String apiInterfaceName,
                                     java.lang.String methodName,
                                     java.util.List<java.lang.String> classNameParameters,
                                     java.lang.Object[] parametersValues)
                              throws org.bonitasoft.engine.api.internal.ServerWrappedException

Specified by:

invokeMethod in interface org.bonitasoft.engine.api.internal.ServerAPI

Throws:

org.bonitasoft.engine.api.internal.ServerWrappedException

wrapThrowable

protected org.bonitasoft.engine.exception.BonitaRuntimeException wrapThrowable(java.lang.Throwable cause)

getSessionType

protected ServerAPIImpl.SessionType getSessionType(org.bonitasoft.engine.session.Session session)

invokeAPIOutsideTransaction

protected java.lang.Object invokeAPIOutsideTransaction(java.lang.Object[] parametersValues,
                                                       java.lang.Object apiImpl,
                                                       java.lang.reflect.Method method,
                                                       java.lang.String apiInterfaceName,
                                                       org.bonitasoft.engine.session.Session session)
                                                throws java.lang.Throwable

Throws:

java.lang.Throwable

checkMethodAccessibility

protected void checkMethodAccessibility(java.lang.Object apiImpl,
                                        java.lang.String apiInterfaceName,
                                        java.lang.reflect.Method method,
                                        org.bonitasoft.engine.session.Session session,
                                        boolean isAlreadyInTransaction)

checkTenantIsInAValidModeFor

protected void checkTenantIsInAValidModeFor(java.lang.Object apiImpl,
                                            java.lang.reflect.Method method,
                                            java.lang.String apiInterfaceName,
                                            long tenantId,
                                            org.bonitasoft.engine.session.Session session,
                                            boolean isAlreadyInTransaction)

checkIsValidModeFor

protected void checkIsValidModeFor(boolean tenantRunning,
                                   AvailableWhenTenantIsPaused annotation,
                                   long tenantId,
                                   java.lang.Object apiImpl,
                                   java.lang.reflect.Method method,
                                   java.lang.String apiInterfaceName)

methodCannotBeCalledOnRunningTenant

protected void methodCannotBeCalledOnRunningTenant(java.lang.Object apiImpl,
                                                   java.lang.String apiInterfaceName,
                                                   java.lang.reflect.Method method,
                                                   long tenantId)

methodCannotBeCalledOnPausedTenant

protected void methodCannotBeCalledOnPausedTenant(java.lang.Object apiImpl,
                                                  java.lang.String apiInterfaceName,
                                                  java.lang.reflect.Method method,
                                                  long tenantId)

isMethodAvailableOnPausedTenant

protected boolean isMethodAvailableOnPausedTenant(boolean tenantRunning,
                                                  AvailableWhenTenantIsPaused annotation)

isMethodAvailableOnRunningTenant

protected boolean isMethodAvailableOnRunningTenant(boolean tenantRunning,
                                                   AvailableWhenTenantIsPaused annotation)

isTenantAvailable

protected boolean isTenantAvailable(long tenantId,
                                    org.bonitasoft.engine.session.Session session,
                                    boolean isAlreadyInTransaction)

Parameters:

tenantId - the ID of the tenant to check

session - the session to user

isAlreadyInTransaction - if the request is made in a transaction

Returns:

true if the tenant is available, false otherwise (if the tenant is paused)

logNodeNotStartedMessage

protected void logNodeNotStartedMessage(java.lang.String apiInterfaceName,
                                        java.lang.reflect.Method method)

logTechnicalErrorMessage

protected void logTechnicalErrorMessage(java.lang.String message)

isNodeInAValidStateFor

protected boolean isNodeInAValidStateFor(java.lang.reflect.Method method)

invokeAPIInTransaction

protected java.lang.Object invokeAPIInTransaction(java.lang.Object[] parametersValues,
                                                  java.lang.Object apiImpl,
                                                  java.lang.reflect.Method method,
                                                  org.bonitasoft.engine.session.Session session,
                                                  java.lang.String apiInterfaceName)
                                           throws java.lang.Throwable

Throws:

java.lang.Throwable

selectUserTransactionService

protected UserTransactionService selectUserTransactionService(org.bonitasoft.engine.session.Session session,
                                                              ServerAPIImpl.SessionType sessionType)
                                                       throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                              java.lang.InstantiationException,
                                                              java.lang.IllegalAccessException,
                                                              java.lang.ClassNotFoundException,
                                                              java.io.IOException,
                                                              org.bonitasoft.engine.exception.BonitaHomeConfigurationException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.ClassNotFoundException

java.io.IOException

org.bonitasoft.engine.exception.BonitaHomeConfigurationException

invokeAPI

protected java.lang.Object invokeAPI(java.lang.reflect.Method method,
                                     java.lang.Object apiImpl,
                                     java.lang.Object... parametersValues)
                              throws java.lang.Throwable

Throws:

java.lang.Throwable

getParameterTypes

protected java.lang.Class<?>[] getParameterTypes(java.util.List<java.lang.String> classNameParameters)
                                          throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException