org.bonitasoft.engine.api

Class PlatformAPIAccessor

java.lang.Object

org.bonitasoft.engine.api.PlatformAPIAccessor

public class PlatformAPIAccessor
extends Object

Accessor class that retrieve Platform APIs

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

• PlatformAPI
• PlatformCommandAPI
• PlatformLoginAPI

Author:

Matthieu Chaffotte

Constructor Summary

Constructors

Constructor and Description
PlatformAPIAccessor()

Method Summary

Modifier and Type	Method and Description
static PlatformAPI	getPlatformAPI(PlatformSession session)
static PlatformCommandAPI	getPlatformCommandAPI(PlatformSession session)
static 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 PlatformLoginAPI getPlatformLoginAPI()
                                            throws BonitaHomeNotSetException,
                                                   ServerAPIException,
                                                   UnknownAPITypeException

Returns:

the PlatformLoginAPI

Throws:

BonitaHomeNotSetException

ServerAPIException

UnknownAPITypeException

getPlatformAPI

public static PlatformAPI getPlatformAPI(PlatformSession session)
                                  throws BonitaHomeNotSetException,
                                         ServerAPIException,
                                         UnknownAPITypeException

Parameters:

session - a PlatformSession created using the PlatformLoginAPI

Returns:

the PlatformAPI

Throws:

InvalidSessionException

BonitaHomeNotSetException

ServerAPIException

UnknownAPITypeException

getPlatformCommandAPI

public static PlatformCommandAPI getPlatformCommandAPI(PlatformSession session)
                                                throws BonitaHomeNotSetException,
                                                       ServerAPIException,
                                                       UnknownAPITypeException

Parameters:

session - a PlatformSession created using the PlatformLoginAPI

Returns:

the PlatformCommandAPI

Throws:

BonitaHomeNotSetException

ServerAPIException

UnknownAPITypeException

InvalidSessionException