Package dev.getelements.elements.rt.annotation

Annotation Interface RemoteScope

@Target(TYPE)
@Retention(RUNTIME)
public @interface RemoteScope

Provides scoping metadata for an exposed service. For an object to be remotely exposed, it must bear one of these annotations or it will be forbidden based on the container configuration.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	protocol	Indicates the protocol of the service.
String	scope	Indicates the scope of the service.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
DeprecationDefinition	deprecated	Indicates if this service is deprecated.
CodeStyle	style	Indicates the module's code style.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_SCOPE	The core Elements scope.
static final String	ELEMENTS_JSON_RPC_PROTOCOL	The JSON-RPC Protocol tunneled via HTTP.
static final String	ELEMENTS_RT_PROTOCOL	The Elements Native RT Protocol
static final String	MASTER_SCOPE	The master node scope.
static final String	REMOTE_PROTOCOL	Indicates the protocol for remote dispatch
static final String	REMOTE_SCOPE	Indicates the scope for remote dispatch
static final String	WORKER_SCOPE	The worker node scope.

Field Details

API_SCOPE

static final String API_SCOPE

The core Elements scope.

See Also:

• Constant Field Values

MASTER_SCOPE

static final String MASTER_SCOPE

The master node scope.

See Also:

• Constant Field Values

WORKER_SCOPE

static final String WORKER_SCOPE

The worker node scope.

See Also:

• Constant Field Values

ELEMENTS_RT_PROTOCOL

static final String ELEMENTS_RT_PROTOCOL

The Elements Native RT Protocol

See Also:

• Constant Field Values

ELEMENTS_JSON_RPC_PROTOCOL

static final String ELEMENTS_JSON_RPC_PROTOCOL

The JSON-RPC Protocol tunneled via HTTP.

See Also:

• Constant Field Values

REMOTE_SCOPE

static final String REMOTE_SCOPE

Indicates the scope for remote dispatch

See Also:

• Constant Field Values

REMOTE_PROTOCOL

static final String REMOTE_PROTOCOL

Indicates the protocol for remote dispatch

See Also:

• Constant Field Values

Element Details

scope

String scope

Indicates the scope of the service. Note scopes prefixed with "eci" are reserved for system use.

Returns:

the scope.

protocol

String protocol

Indicates the protocol of the service. Note protocols prefixed with "eci" are reserved for system use.

Returns:

the scope.

style

CodeStyle style

Indicates the module's code style. By default this enforces natural code style.

Returns:

the CodeStyle

Default:

@dev.getelements.elements.rt.annotation.CodeStyle(methodCaseFormat=NATURAL, constantCaseFormat=NATURAL, parameterCaseFormat=NATURAL)

deprecated

DeprecationDefinition deprecated

Indicates if this service is deprecated.

Returns:

the DeprecationDefinition

Default:

@dev.getelements.elements.rt.annotation.DeprecationDefinition(deprecated=false)