Package org.bonitasoft.engine.api

Class TenantAPIAccessor

java.lang.Object

org.bonitasoft.engine.api.TenantAPIAccessor

public final class TenantAPIAccessor
extends java.lang.Object

Accessor class that retrieve APIs in Bonita Community Edition.

• ProcessAPI,
• CommandAPI,
• IdentityAPI,
• LoginAPI

Constructor Summary

Constructors

Constructor	Description
TenantAPIAccessor()

Method Summary

Modifier and Type	Method	Description
static org.bonitasoft.engine.api.ApplicationAPI	getApplicationAPI(org.bonitasoft.engine.session.APISession session)
static org.bonitasoft.engine.api.BusinessDataAPI	getBusinessDataAPI(org.bonitasoft.engine.session.APISession session)	Deprecated. as of 7.3, see BusinessDataAPI for replacements
static org.bonitasoft.engine.api.CommandAPI	getCommandAPI(org.bonitasoft.engine.session.APISession session)
static org.bonitasoft.engine.api.PageAPI	getCustomPageAPI(org.bonitasoft.engine.session.APISession session)
static org.bonitasoft.engine.api.IdentityAPI	getIdentityAPI(org.bonitasoft.engine.session.APISession session)
static org.bonitasoft.engine.api.ApplicationAPI	getLivingApplicationAPI(org.bonitasoft.engine.session.APISession session)
static org.bonitasoft.engine.api.LoginAPI	getLoginAPI()
static org.bonitasoft.engine.api.PermissionAPI	getPermissionAPI(org.bonitasoft.engine.session.APISession session)
static org.bonitasoft.engine.api.ProcessAPI	getProcessAPI(org.bonitasoft.engine.session.APISession session)
static org.bonitasoft.engine.api.ProfileAPI	getProfileAPI(org.bonitasoft.engine.session.APISession session)
static org.bonitasoft.engine.api.TenantAdministrationAPI	getTenantAdministrationAPI(org.bonitasoft.engine.session.APISession session)
static org.bonitasoft.engine.api.ThemeAPI	getThemeAPI(org.bonitasoft.engine.session.APISession session)	Deprecated. since 7.13.0, ThemeAPI does nothing.
static void	refresh()	Refreshes the way the engine client communicates to the engine server.

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantAPIAccessor

public TenantAPIAccessor()

Method Detail

refresh

public static void refresh()

Refreshes the way the engine client communicates to the engine server.

See Also:

APITypeManager, ApiAccessType

getLoginAPI

public static org.bonitasoft.engine.api.LoginAPI getLoginAPI()
                                                      throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                             org.bonitasoft.engine.exception.ServerAPIException,
                                                             UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getIdentityAPI

public static org.bonitasoft.engine.api.IdentityAPI getIdentityAPI(org.bonitasoft.engine.session.APISession session)
                                                            throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                   org.bonitasoft.engine.exception.ServerAPIException,
                                                                   UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getProcessAPI

public static org.bonitasoft.engine.api.ProcessAPI getProcessAPI(org.bonitasoft.engine.session.APISession session)
                                                          throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                 org.bonitasoft.engine.exception.ServerAPIException,
                                                                 UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getCommandAPI

public static org.bonitasoft.engine.api.CommandAPI getCommandAPI(org.bonitasoft.engine.session.APISession session)
                                                          throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                 org.bonitasoft.engine.exception.ServerAPIException,
                                                                 UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getProfileAPI

public static org.bonitasoft.engine.api.ProfileAPI getProfileAPI(org.bonitasoft.engine.session.APISession session)
                                                          throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                 org.bonitasoft.engine.exception.ServerAPIException,
                                                                 UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getThemeAPI

@Deprecated(since="7.13.0")
public static org.bonitasoft.engine.api.ThemeAPI getThemeAPI(org.bonitasoft.engine.session.APISession session)
                                                      throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                             org.bonitasoft.engine.exception.ServerAPIException,
                                                             UnknownAPITypeException

Deprecated.

since 7.13.0, ThemeAPI does nothing. There is no replacement, as it used to serve old removed feature.

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getPermissionAPI

public static org.bonitasoft.engine.api.PermissionAPI getPermissionAPI(org.bonitasoft.engine.session.APISession session)
                                                                throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                       org.bonitasoft.engine.exception.ServerAPIException,
                                                                       UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getCustomPageAPI

public static org.bonitasoft.engine.api.PageAPI getCustomPageAPI(org.bonitasoft.engine.session.APISession session)
                                                          throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                 org.bonitasoft.engine.exception.ServerAPIException,
                                                                 UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getLivingApplicationAPI

public static org.bonitasoft.engine.api.ApplicationAPI getLivingApplicationAPI(org.bonitasoft.engine.session.APISession session)
                                                                        throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                               org.bonitasoft.engine.exception.ServerAPIException,
                                                                               UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getTenantAdministrationAPI

public static org.bonitasoft.engine.api.TenantAdministrationAPI getTenantAdministrationAPI(org.bonitasoft.engine.session.APISession session)
                                                                                    throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                                           org.bonitasoft.engine.exception.ServerAPIException,
                                                                                           UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getBusinessDataAPI

@Deprecated
public static org.bonitasoft.engine.api.BusinessDataAPI getBusinessDataAPI(org.bonitasoft.engine.session.APISession session)
                                                                    throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                           org.bonitasoft.engine.exception.ServerAPIException,
                                                                           UnknownAPITypeException

Deprecated.

as of 7.3, see BusinessDataAPI for replacements

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getApplicationAPI

public static org.bonitasoft.engine.api.ApplicationAPI getApplicationAPI(org.bonitasoft.engine.session.APISession session)
                                                                  throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                         org.bonitasoft.engine.exception.ServerAPIException,
                                                                         UnknownAPITypeException

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException