org.bonitasoft.engine.util

Class APITypeManager

java.lang.Object

org.bonitasoft.engine.util.APITypeManager

public class APITypeManager
extends Object

Specify how the client communicate with the engine. There are three ways of doing it:

• Using Java System Properties
• Programmatically
• DEPRECATED: using a file inside bonita-home. See online documentation.

Using Java System Properties

Use System property -Dorg.bonitasoft.engine.api-type=

• LOCAL:

  connect to the server in the local JVM (default). No other configuration is necessary.

• HTTP

  connect to the server using HTTP. You must also specify:

  • -Dorg.bonitasoft.engine.api-type.server.url=HTTP_SERVER_URL, e.g. http://localhost:8080
  • -Dorg.bonitasoft.engine.api-type.application.name=WEBAPP_NAME, this is the name of the web application, e.g. bonita

• EJB3

  connect to the server using EJB3. You must also specify
  For JBoss AS 7 :

  • -Djava.naming.factory.url.pkgs=org.jboss.ejb.client.naming
  • -Dorg.bonitasoft.engine.ejb.naming.reference=ejb:bonita-ear/bonita-ejb/serverAPIBean!org.bonitasoft.engine.api.internal.ServerAPI

• TCP

  not recommended, only for testing purpose.

Programmatically

• LOCAL access:

  APITypeManager.setAPITypeAndParams(ApiAccessType.LOCAL, null);

• HTTP access:

   HashMap parameters = new HashMap<>();
   parameters.put("server.url", "http://myserver.com:8080");
   parameters.put("application.name", "bonita-application");
   APITypeManager.setAPITypeAndParams(ApiAccessType.HTTP, parameters);
   

• EJB3 access:

   HashMap parameters= new HashMap<>();
   parameters.put("java.naming.factory.url.pkgs", "org.jboss.ejb.client.naming");
   parameters.put("org.bonitasoft.engine.ejb.naming.reference","ejb:bonita-ear/bonita-ejb/serverAPIBean!org.bonitasoft.engine.api.internal.ServerAPI");
   APITypeManager.setAPITypeAndParams(ApiAccessType.EJB3, parameters);
   

Author:

Baptiste Mesta, Elias Ricken de Medeiros, Matthieu Chaffotte

See Also:

Online documentation on Client configuration

Constructor Summary

Constructors

Constructor and Description
APITypeManager()

Method Summary

Methods

Modifier and Type	Method and Description
static ApiAccessType	getAPIType()
static Map<String,String>	getAPITypeParameters()
static void	refresh()
static void	setAPITypeAndParams(ApiAccessType type, Map<String,String> parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

APITypeManager

public APITypeManager()

Method Detail

getAPIType

public static ApiAccessType getAPIType()
                                throws ServerAPIException,
                                       UnknownAPITypeException,
                                       IOException

Throws:

ServerAPIException

UnknownAPITypeException

IOException

getAPITypeParameters

public static Map<String,String> getAPITypeParameters()
                                               throws ServerAPIException,
                                                      IOException

Throws:

ServerAPIException

IOException

setAPITypeAndParams

public static void setAPITypeAndParams(ApiAccessType type,
                       Map<String,String> parameters)

refresh

public static void refresh()