Package org.bonitasoft.engine.api

Enum Class ApiAccessType

java.lang.Object

java.lang.Enum<ApiAccessType>

org.bonitasoft.engine.api.ApiAccessType

All Implemented Interfaces:

Serializable, Comparable<ApiAccessType>, Constable

public enum ApiAccessType
extends Enum<ApiAccessType>

Enum that defines how APIs should be accessed

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HTTP	Access a remote engine using through a servlet.
LOCAL	Local access to the api, it means that the local JVM is running the engine.

Method Summary

Modifier and Type	Method	Description
static ApiAccessType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiAccessType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LOCAL

public static final ApiAccessType LOCAL

Local access to the api, it means that the local JVM is running the engine.

HTTP

public static final ApiAccessType HTTP

Access a remote engine using through a servlet. The remote engine should have the HTTP_API env property set to true.

Method Details

values

public static ApiAccessType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ApiAccessType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null