services.moleculer.context

Class Context

java.lang.Object

services.moleculer.context.Context

public class Context
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Eventbus	eventbus
java.lang.String	id Unique context ID
int	level Request level (in nested-calls) - the first level is 1
java.lang.String	name Action name
CallOptions.Options	opts Calling options
io.datatree.Tree	params Request parameters (including meta)
java.lang.String	parentID Parent context ID (in nested-calls)
java.lang.String	requestID Request ID (= first context ID)
protected ServiceInvoker	serviceInvoker
long	startTime Context creation time

Constructor Summary

Constructors

Constructor and Description
Context(ServiceInvoker serviceInvoker, Eventbus eventbus, java.lang.String id, java.lang.String name, io.datatree.Tree params, CallOptions.Options opts)
Context(ServiceInvoker serviceInvoker, Eventbus eventbus, java.lang.String id, java.lang.String name, io.datatree.Tree params, CallOptions.Options opts, int level, java.lang.String requestID, java.lang.String parentID)
Context(java.lang.String id, java.lang.String name, io.datatree.Tree params, CallOptions.Options opts, Context parent)

Method Summary

Modifier and Type	Method and Description
void	broadcast(java.lang.String name, java.lang.Object... params) Emits an event to ALL listeners from ALL (or the specified) event group(s), who are listening this event.
void	broadcast(java.lang.String name, io.datatree.Tree payload) Emits an event to ALL listeners from ALL event groups, who are listening this event.
void	broadcast(java.lang.String name, io.datatree.Tree payload, Groups groups) Emits an event to ALL listeners from the specified event group(s), who are listening this event.
void	broadcastLocal(java.lang.String name, java.lang.Object... params) Emits a LOCAL event to ALL listeners from ALL (or the specified) event group(s), who are listening this event.
void	broadcastLocal(java.lang.String name, io.datatree.Tree payload) Emits a LOCAL event to ALL listeners from ALL event groups, who are listening this event.
void	broadcastLocal(java.lang.String name, io.datatree.Tree payload, Groups groups) Emits a LOCAL event to ALL listeners from the specified event group(s), who are listening this event.
io.datatree.Promise	call(java.lang.String name, java.lang.Object... params) Calls an action (local or remote).
io.datatree.Promise	call(java.lang.String name, io.datatree.Tree params) Calls an action (local or remote).
io.datatree.Promise	call(java.lang.String name, io.datatree.Tree params, CallOptions.Options opts) Calls an action (local or remote).
void	emit(java.lang.String name, java.lang.Object... params) Emits an event to ONE listener from ALL (or the specified) event group(s), who are listening this event.
void	emit(java.lang.String name, io.datatree.Tree payload) Emits an event to ONE listener from ALL event groups, who are listening this event.
void	emit(java.lang.String name, io.datatree.Tree payload, Groups groups) Emits an event to ONE listener from the specified event group(s), who are listening this event.

Methods inherited from class java.lang.Object

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

Field Detail

id

public final java.lang.String id

Unique context ID

name

public final java.lang.String name

Action name

params

public final io.datatree.Tree params

Request parameters (including meta)

level

public final int level

Request level (in nested-calls) - the first level is 1

parentID

public final java.lang.String parentID

Parent context ID (in nested-calls)

requestID

public final java.lang.String requestID

Request ID (= first context ID)

opts

public final CallOptions.Options opts

Calling options

startTime

public final long startTime

Context creation time

serviceInvoker

protected final ServiceInvoker serviceInvoker

eventbus

protected final Eventbus eventbus

Constructor Detail

Context

public Context(ServiceInvoker serviceInvoker,
               Eventbus eventbus,
               java.lang.String id,
               java.lang.String name,
               io.datatree.Tree params,
               CallOptions.Options opts)

Context

public Context(java.lang.String id,
               java.lang.String name,
               io.datatree.Tree params,
               CallOptions.Options opts,
               Context parent)

Context

public Context(ServiceInvoker serviceInvoker,
               Eventbus eventbus,
               java.lang.String id,
               java.lang.String name,
               io.datatree.Tree params,
               CallOptions.Options opts,
               int level,
               java.lang.String requestID,
               java.lang.String parentID)

Method Detail

call

public io.datatree.Promise call(java.lang.String name,
                                java.lang.Object... params)

Calls an action (local or remote). Sample code:

broker.call("service.action").then(ctx -> {

// Nested call:
return ctx.call("math.add", "a", 1, "b", 2);

});

...or with CallOptions:

return ctx.call("math.add", "a", 1, "b", 2, CallOptions.nodeID("node2"));

Parameters:

name - action name (eg. "math.add" in "service.action" syntax)

params - list of parameter name-value pairs and an optional CallOptions

Returns:

response Promise

call

public io.datatree.Promise call(java.lang.String name,
                                io.datatree.Tree params)

Calls an action (local or remote). Sample code:

broker.call("service.action").then(ctx -> {

// Nested call:
Tree params = new Tree();
params.put("a", true);
params.putList("b").add(1).add(2).add(3);
rerturn ctx.call("math.add", params);

});

Parameters:

name - action name (eg. "math.add" in "service.action" syntax)

params - Tree structure (input parameters of the method call)

Returns:

response Promise

call

public io.datatree.Promise call(java.lang.String name,
                                io.datatree.Tree params,
                                CallOptions.Options opts)

Calls an action (local or remote). Sample code:

broker.call("service.action").then(ctx -> {

// Nested call:
Tree params = new Tree();
params.put("a", true);
params.putList("b").add(1).add(2).add(3);
return ctx.call("math.add", params, CallOptions.nodeID("node2"));

});

Parameters:

name - action name (eg. "math.add" in "service.action" syntax)

params - Tree structure (input parameters of the method call)

opts - calling options (target nodeID, call timeout, number of retries)

Returns:

response Promise

emit

public void emit(java.lang.String name,
                 java.lang.Object... params)

Emits an event to ONE listener from ALL (or the specified) event group(s), who are listening this event. The service broker uses the default strategy of the broker for event redirection and node selection. Sample code:

ctx.emit("user.deleted", "a", 1, "b", 2);

...or send event to (one or more) listener group(s):

ctx.emit("user.deleted", "a", 1, "b", 2, Groups.of("logger"));

Parameters:

name - name of event (eg. "user.deleted")

params - list of parameter name-value pairs and an optional event group container

emit

public void emit(java.lang.String name,
                 io.datatree.Tree payload,
                 Groups groups)

Emits an event to ONE listener from the specified event group(s), who are listening this event. The service broker uses the default strategy of the broker for event redirection and node selection. Sample code:

Tree params = new Tree();
params.put("a", true);
params.putList("b").add(1).add(2).add(3);
ctx.emit("user.created", params, Groups.of("group1", "group2"));

Parameters:

name - name of event (eg. "user.modified")

payload - Tree structure (payload of the event)

groups - event group container

emit

public void emit(java.lang.String name,
                 io.datatree.Tree payload)

Emits an event to ONE listener from ALL event groups, who are listening this event. The service broker uses the default strategy of the broker for event redirection and node selection. Sample code:

Tree params = new Tree();
params.put("a", true);
params.putList("b").add(1).add(2).add(3);
ctx.emit("user.modified", params);

Parameters:

name - name of event (eg. "user.created")

payload - Tree structure (payload of the event)

broadcast

public void broadcast(java.lang.String name,
                      java.lang.Object... params)

Emits an event to ALL listeners from ALL (or the specified) event group(s), who are listening this event. Sample code:

ctx.broadcast("user.deleted", "a", 1, "b", 2);

...or send event to (one or more) listener group(s):

ctx.broadcast("user.deleted", "a", 1, "b", 2, Groups.of("logger"));

Parameters:

name - name of event (eg. "user.deleted")

params - list of parameter name-value pairs and an optional event group container

broadcast

public void broadcast(java.lang.String name,
                      io.datatree.Tree payload,
                      Groups groups)

Emits an event to ALL listeners from the specified event group(s), who are listening this event. Sample code:

Tree params = new Tree();
params.put("a", true);
params.putList("b").add(1).add(2).add(3);
ctx.broadcast("user.created", params, Groups.of("group1", "group2"));

Parameters:

name - name of event (eg. "user.modified")

payload - Tree structure (payload of the event)

groups - event group container

broadcast

public void broadcast(java.lang.String name,
                      io.datatree.Tree payload)

Emits an event to ALL listeners from ALL event groups, who are listening this event. Sample code:

Tree params = new Tree();
params.put("a", true);
params.putList("b").add(1).add(2).add(3);
ctx.broadcast("user.modified", params);

Parameters:

name - name of event (eg. "user.created")

payload - Tree structure (payload of the event)

broadcastLocal

public void broadcastLocal(java.lang.String name,
                           java.lang.Object... params)

Emits a LOCAL event to ALL listeners from ALL (or the specified) event group(s), who are listening this event. Sample code:

ctx.broadcastLocal("user.deleted", "a", 1, "b", 2);

...or send event to (one or more) local listener group(s):

ctx.broadcastLocal("user.deleted", "a", 1, "b", 2, Groups.of("logger"));

Parameters:

name - name of event (eg. "user.deleted")

params - list of parameter name-value pairs and an optional event group container

broadcastLocal

public void broadcastLocal(java.lang.String name,
                           io.datatree.Tree payload,
                           Groups groups)

Emits a LOCAL event to ALL listeners from the specified event group(s), who are listening this event. Sample code:

Tree params = new Tree();
params.put("a", true);
params.putList("b").add(1).add(2).add(3);
ctx.broadcastLocal("user.created", params, Groups.of("group1", "group2"));

Parameters:

name - name of event (eg. "user.modified")

payload - Tree structure (payload of the event)

groups - event group container

broadcastLocal

public void broadcastLocal(java.lang.String name,
                           io.datatree.Tree payload)

Emits a LOCAL event to ALL listeners from ALL event groups, who are listening this event. Sample code:

Tree params = new Tree();
params.put("a", true);
params.putList("b").add(1).add(2).add(3);
ctx.broadcastLocal("user.modified", params);

Parameters:

name - name of event (eg. "user.created")

payload - Tree structure (payload of the event)