com.bonitasoft.engine.api

Class PlatformAPIAccessor

java.lang.Object

com.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
• PlatformMonitoringAPI
• PlatformLoginAPI

Author:

Matthieu Chaffotte

Constructor Summary

Constructors

Constructor and Description
PlatformAPIAccessor()

Method Summary

Modifier and Type	Method and Description
static NodeAPI	getNodeAPI()
static PlatformAPI	getPlatformAPI(PlatformSession session)
static PlatformCommandAPI	getPlatformCommandAPI(PlatformSession session)
static PlatformLoginAPI	getPlatformLoginAPI()
static PlatformMonitoringAPI	getPlatformMonitoringAPI(PlatformSession session)
static void	refresh()

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()

getPlatformLoginAPI

public static PlatformLoginAPI getPlatformLoginAPI()
                                            throws BonitaHomeNotSetException,
                                                   ServerAPIException,
                                                   UnknownAPITypeException

Throws:

BonitaHomeNotSetException

ServerAPIException

UnknownAPITypeException

getPlatformAPI

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

Throws:

BonitaHomeNotSetException

ServerAPIException

UnknownAPITypeException

getPlatformMonitoringAPI

public static PlatformMonitoringAPI getPlatformMonitoringAPI(PlatformSession session)
                                                      throws BonitaHomeNotSetException,
                                                             ServerAPIException,
                                                             UnknownAPITypeException

Throws:

BonitaHomeNotSetException

ServerAPIException

UnknownAPITypeException

getPlatformCommandAPI

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

Throws:

BonitaHomeNotSetException

ServerAPIException

UnknownAPITypeException

getNodeAPI

public static NodeAPI getNodeAPI()
                          throws BonitaHomeNotSetException,
                                 ServerAPIException,
                                 UnknownAPITypeException

Throws:

BonitaHomeNotSetException

ServerAPIException

UnknownAPITypeException