org.bonitasoft.engine.api

Class PlatformAPIAccessor

java.lang.Object

org.bonitasoft.engine.api.PlatformAPIAccessor

public class PlatformAPIAccessor
extends java.lang.Object

Accessor class that retrieve Platform APIs

All APIs given by this class are relevant to the platform only.

• PlatformAPI
• PlatformCommandAPI
• PlatformLoginAPI

Constructor Summary

Constructors

Constructor and Description
PlatformAPIAccessor()

Method Summary

Modifier and Type	Method and Description
static org.bonitasoft.engine.api.PlatformAPI	getPlatformAPI(org.bonitasoft.engine.session.PlatformSession session)
static org.bonitasoft.engine.api.PlatformCommandAPI	getPlatformCommandAPI(org.bonitasoft.engine.session.PlatformSession session)
static org.bonitasoft.engine.api.PlatformLoginAPI	getPlatformLoginAPI()
static void	refresh() Reload the configuration of the Bonita home from the file system It allows to change in runtime the Bonita engine your client application uses

Methods inherited from class java.lang.Object

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

Constructor Detail

PlatformAPIAccessor

public PlatformAPIAccessor()

Method Detail

refresh

public static void refresh()

Reload the configuration of the Bonita home from the file system It allows to change in runtime the Bonita engine your client application uses

getPlatformLoginAPI

public static org.bonitasoft.engine.api.PlatformLoginAPI getPlatformLoginAPI()
                                                                      throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                             org.bonitasoft.engine.exception.ServerAPIException,
                                                                             UnknownAPITypeException

Returns:

the PlatformLoginAPI

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getPlatformAPI

public static org.bonitasoft.engine.api.PlatformAPI getPlatformAPI(org.bonitasoft.engine.session.PlatformSession session)
                                                            throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                   org.bonitasoft.engine.exception.ServerAPIException,
                                                                   UnknownAPITypeException

Parameters:

session - a PlatformSession created using the PlatformLoginAPI

Returns:

the PlatformAPI

Throws:

org.bonitasoft.engine.session.InvalidSessionException

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

getPlatformCommandAPI

public static org.bonitasoft.engine.api.PlatformCommandAPI getPlatformCommandAPI(org.bonitasoft.engine.session.PlatformSession session)
                                                                          throws org.bonitasoft.engine.exception.BonitaHomeNotSetException,
                                                                                 org.bonitasoft.engine.exception.ServerAPIException,
                                                                                 UnknownAPITypeException

Parameters:

session - a PlatformSession created using the PlatformLoginAPI

Returns:

the PlatformCommandAPI

Throws:

org.bonitasoft.engine.exception.BonitaHomeNotSetException

org.bonitasoft.engine.exception.ServerAPIException

UnknownAPITypeException

org.bonitasoft.engine.session.InvalidSessionException