org.bonitasoft.engine.api.impl

Class ServerAPIImpl

java.lang.Object

org.bonitasoft.engine.api.impl.ServerAPIImpl

All Implemented Interfaces:

Serializable, Remote, ServerAPI

public class ServerAPIImpl
extends Object
implements 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

Methods

Modifier and Type	Method and Description
protected void	checkIsValidModeFor(boolean tenantRunning, AvailableWhenTenantIsPaused annotation, long tenantId, Object apiImpl, Method method, String apiInterfaceName)
protected void	checkMethodAccessibility(Object apiImpl, String apiInterfaceName, Method method, Session session, boolean isAlreadyInTransaction)
protected void	checkTenantIsInAValidModeFor(Object apiImpl, Method method, String apiInterfaceName, long tenantId, Session session, boolean isAlreadyInTransaction)
protected Class<?>[]	getParameterTypes(List<String> classNameParameters)
protected ServerAPIImpl.SessionType	getSessionType(Session session)
protected Object	invokeAPI(Method method, Object apiImpl, Object... parametersValues)
protected Object	invokeAPIInTransaction(Object[] parametersValues, Object apiImpl, Method method, Session session, String apiInterfaceName)
protected Object	invokeAPIOutsideTransaction(Object[] parametersValues, Object apiImpl, Method method, String apiInterfaceName, Session session)
Object	invokeMethod(Map<String,Serializable> options, String apiInterfaceName, String methodName, List<String> classNameParameters, Object[] parametersValues)
protected boolean	isMethodAvailableOnPausedTenant(boolean tenantRunning, AvailableWhenTenantIsPaused annotation)
protected boolean	isMethodAvailableOnRunningTenant(boolean tenantRunning, AvailableWhenTenantIsPaused annotation)
protected boolean	isNodeInAValidStateFor(Method method)
protected boolean	isTenantAvailable(long tenantId, Session session, boolean isAlreadyInTransaction)
protected void	logNodeNotStartedMessage(String apiInterfaceName, Method method)
protected void	logTechnicalErrorMessage(String message)
protected void	methodCannotBeCalledOnPausedTenant(Object apiImpl, String apiInterfaceName, Method method, long tenantId)
protected void	methodCannotBeCalledOnRunningTenant(Object apiImpl, String apiInterfaceName, Method method, long tenantId)
protected org.bonitasoft.engine.transaction.UserTransactionService	selectUserTransactionService(Session session, ServerAPIImpl.SessionType sessionType)
protected BonitaRuntimeException	wrapThrowable(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 Object invokeMethod(Map<String,Serializable> options,
                  String apiInterfaceName,
                  String methodName,
                  List<String> classNameParameters,
                  Object[] parametersValues)
                    throws ServerWrappedException

Specified by:

invokeMethod in interface ServerAPI

Throws:

ServerWrappedException

wrapThrowable

protected BonitaRuntimeException wrapThrowable(Throwable cause)

getSessionType

protected ServerAPIImpl.SessionType getSessionType(Session session)

invokeAPIOutsideTransaction

protected Object invokeAPIOutsideTransaction(Object[] parametersValues,
                                 Object apiImpl,
                                 Method method,
                                 String apiInterfaceName,
                                 Session session)
                                      throws Throwable

Throws:

Throwable

checkMethodAccessibility

protected void checkMethodAccessibility(Object apiImpl,
                            String apiInterfaceName,
                            Method method,
                            Session session,
                            boolean isAlreadyInTransaction)

checkTenantIsInAValidModeFor

protected void checkTenantIsInAValidModeFor(Object apiImpl,
                                Method method,
                                String apiInterfaceName,
                                long tenantId,
                                Session session,
                                boolean isAlreadyInTransaction)

checkIsValidModeFor

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

methodCannotBeCalledOnRunningTenant

protected void methodCannotBeCalledOnRunningTenant(Object apiImpl,
                                       String apiInterfaceName,
                                       Method method,
                                       long tenantId)

methodCannotBeCalledOnPausedTenant

protected void methodCannotBeCalledOnPausedTenant(Object apiImpl,
                                      String apiInterfaceName,
                                      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,
                        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(String apiInterfaceName,
                            Method method)

logTechnicalErrorMessage

protected void logTechnicalErrorMessage(String message)

isNodeInAValidStateFor

protected boolean isNodeInAValidStateFor(Method method)

invokeAPIInTransaction

protected Object invokeAPIInTransaction(Object[] parametersValues,
                            Object apiImpl,
                            Method method,
                            Session session,
                            String apiInterfaceName)
                                 throws Throwable

Throws:

Throwable

selectUserTransactionService

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

Throws:

BonitaHomeNotSetException

InstantiationException

IllegalAccessException

ClassNotFoundException

IOException

BonitaHomeConfigurationException

invokeAPI

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

Throws:

Throwable

getParameterTypes

protected Class<?>[] getParameterTypes(List<String> classNameParameters)
                                throws ClassNotFoundException

Throws:

ClassNotFoundException