io.crossbar.autobahn.wamp

Class Session

java.lang.Object

io.crossbar.autobahn.wamp.Session

All Implemented Interfaces:

ISession, ITransportHandler

public class Session
extends java.lang.Object
implements ISession, ITransportHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.crossbar.autobahn.wamp.interfaces.ISession

ISession.OnConnectListener, ISession.OnDisconnectListener, ISession.OnJoinListener, ISession.OnLeaveListener, ISession.OnReadyListener, ISession.OnUserErrorListener

Constructor Summary

Constructors

Constructor and Description
Session()
Session(java.util.concurrent.ExecutorService executor)

Method Summary

Modifier and Type	Method and Description
ISession.OnConnectListener	addOnConnectListener(ISession.OnConnectListener listener)
ISession.OnDisconnectListener	addOnDisconnectListener(ISession.OnDisconnectListener listener)
ISession.OnJoinListener	addOnJoinListener(ISession.OnJoinListener listener)
ISession.OnLeaveListener	addOnLeaveListener(ISession.OnLeaveListener listener)
ISession.OnUserErrorListener	addOnUserErrorListener(ISession.OnUserErrorListener listener)
ISession.OnReadyListener	adOnReadyListener(ISession.OnReadyListener listener)
java.util.concurrent.CompletableFuture<CallResult>	call(java.lang.String procedure, java.util.List<java.lang.Object> args, java.util.Map<java.lang.String,java.lang.Object> kwargs, CallOptions options) Call a remote procedure.
<T> java.util.concurrent.CompletableFuture<T>	call(java.lang.String procedure, java.util.List<java.lang.Object> args, java.util.Map<java.lang.String,java.lang.Object> kwargs, com.fasterxml.jackson.core.type.TypeReference<T> resultType, CallOptions options) Call a remote procedure where the result needs to be resolved to a POJO.
<T> java.util.concurrent.CompletableFuture<T>	call(java.lang.String procedure, com.fasterxml.jackson.core.type.TypeReference<T> resultType, CallOptions options, java.lang.Object... args) Call a remote procedure where the result needs to be resolved to a POJO.
long	getID() Returns the ID of the current session, 0 otherwise.
boolean	isConnected()
java.util.concurrent.CompletableFuture<SessionDetails>	join(java.lang.String realm, java.util.List<java.lang.String> authMethods) Join a realm on the WAMP router
void	leave(java.lang.String reason, java.lang.String message) Leave the currently joined WAMP session.
void	onConnect(ITransport transport, ISerializer serializer)
void	onDisconnect(boolean wasClean)
void	onMessage(byte[] payload, boolean isBinary)
java.util.concurrent.CompletableFuture<Publication>	publish(java.lang.String topic) Publishes to a previously registered WAMP topic that takes no arguments.
java.util.concurrent.CompletableFuture<Publication>	publish(java.lang.String topic, java.util.List<java.lang.Object> args, java.util.Map<java.lang.String,java.lang.Object> kwargs, PublishOptions options) Publishes to a previously registered WAMP topic
java.util.concurrent.CompletableFuture<Publication>	publish(java.lang.String topic, java.lang.Object... args) Publishes to a previously registered WAMP topic that takes multiple positional arguments.
java.util.concurrent.CompletableFuture<Publication>	publish(java.lang.String topic, java.lang.Object arg, PublishOptions options) Publishes to a previously registered WAMP topic that takes a single argument.
java.util.concurrent.CompletableFuture<Publication>	publish(java.lang.String topic, PublishOptions options) Publishes to a previously registered WAMP topic that takes no arguments.
java.util.concurrent.CompletableFuture<Publication>	publish(java.lang.String topic, PublishOptions options, java.lang.Object... args) Publishes to a previously registered WAMP topic that takes multiple positional arguments.
<T> java.util.concurrent.CompletableFuture<Registration>	register(java.lang.String procedure, java.util.function.BiFunction<T,InvocationDetails,java.util.concurrent.CompletableFuture<InvocationResult>> endpoint, RegisterOptions options) Registers a WAMP procedure.
<T> java.util.concurrent.CompletableFuture<Registration>	register(java.lang.String procedure, java.util.function.Function<T,java.util.concurrent.CompletableFuture<InvocationResult>> endpoint, RegisterOptions options) Registers a WAMP procedure.
java.util.concurrent.CompletableFuture<Registration>	register(java.lang.String procedure, IInvocationHandler endpoint, RegisterOptions options) Registers a WAMP procedure.
java.util.concurrent.CompletableFuture<Registration>	register(java.lang.String procedure, java.util.function.Supplier endpoint, RegisterOptions options) Registers a WAMP procedure.
<T,U> java.util.concurrent.CompletableFuture<Registration>	register(java.lang.String procedure, TriFunction<T,U,InvocationDetails,java.util.concurrent.CompletableFuture<InvocationResult>> endpoint, RegisterOptions options) Registers a WAMP procedure.
void	removeOnConnectListener(ISession.OnConnectListener listener)
void	removeOnDisconnectListener(ISession.OnDisconnectListener listener)
void	removeOnJoinListener(ISession.OnJoinListener listener)
void	removeOnLeaveListener(ISession.OnLeaveListener listener)
void	removeOnReadyListener(ISession.OnReadyListener listener)
void	removeOnUserErrorListener(ISession.OnUserErrorListener listener)
<T> java.util.concurrent.CompletableFuture<Subscription>	subscribe(java.lang.String topic, java.util.function.BiConsumer<T,EventDetails> handler, SubscribeOptions options) Subscribes to a WAMP topic.
<T> java.util.concurrent.CompletableFuture<Subscription>	subscribe(java.lang.String topic, java.util.function.BiFunction<T,EventDetails,java.util.concurrent.CompletableFuture<ReceptionResult>> handler, SubscribeOptions options) Subscribes to a WAMP topic.
<T> java.util.concurrent.CompletableFuture<Subscription>	subscribe(java.lang.String topic, java.util.function.Consumer<T> handler, SubscribeOptions options) Subscribes to a WAMP topic
<T> java.util.concurrent.CompletableFuture<Subscription>	subscribe(java.lang.String topic, java.util.function.Function<T,java.util.concurrent.CompletableFuture<ReceptionResult>> handler, SubscribeOptions options) Subscribes to a WAMP topic.
<T,U> java.util.concurrent.CompletableFuture<Subscription>	subscribe(java.lang.String topic, TriConsumer<T,U,EventDetails> handler, SubscribeOptions options) Subscribes to a WAMP topic.
<T,U> java.util.concurrent.CompletableFuture<Subscription>	subscribe(java.lang.String topic, TriFunction<T,U,EventDetails,java.util.concurrent.CompletableFuture<ReceptionResult>> handler, SubscribeOptions options) Subscribes to a WAMP topic.

Methods inherited from class java.lang.Object

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

Constructor Detail

Session

public Session()

Session

public Session(java.util.concurrent.ExecutorService executor)

Method Detail

getID

public long getID()

Returns the ID of the current session, 0 otherwise.

Returns:

The session ID

onConnect

public void onConnect(ITransport transport,
                      ISerializer serializer)
               throws java.lang.Exception

Specified by:

onConnect in interface ITransportHandler

Throws:

java.lang.Exception

onMessage

public void onMessage(byte[] payload,
                      boolean isBinary)
               throws java.lang.Exception

Specified by:

onMessage in interface ITransportHandler

Throws:

java.lang.Exception

onDisconnect

public void onDisconnect(boolean wasClean)

Specified by:

onDisconnect in interface ITransportHandler

isConnected

public boolean isConnected()

Specified by:

isConnected in interface ISession

Specified by:

isConnected in interface ITransportHandler

subscribe

public <T> java.util.concurrent.CompletableFuture<Subscription> subscribe(java.lang.String topic,
                                                                          java.util.function.Consumer<T> handler,
                                                                          SubscribeOptions options)

Subscribes to a WAMP topic

Specified by:

subscribe in interface ISession

Parameters:

topic - URI of the topic to subscribe

handler - callback method for results of publication to the topic.

options - options for the subscribe

Returns:

a CompletableFuture that resolves to an instance of Subscription

subscribe

public <T> java.util.concurrent.CompletableFuture<Subscription> subscribe(java.lang.String topic,
                                                                          java.util.function.Function<T,java.util.concurrent.CompletableFuture<ReceptionResult>> handler,
                                                                          SubscribeOptions options)

Subscribes to a WAMP topic. This is a convenience method that takes a callback method with simplified signature

Specified by:

subscribe in interface ISession

Parameters:

topic - URI of the topic to subscribe

handler - callback method for results of publication to the topic.

options - options for the subscribe

Returns:

a CompletableFuture that resolves to an instance of Subscription

subscribe

public <T> java.util.concurrent.CompletableFuture<Subscription> subscribe(java.lang.String topic,
                                                                          java.util.function.BiConsumer<T,EventDetails> handler,
                                                                          SubscribeOptions options)

Subscribes to a WAMP topic. This is a convenience method that takes a callback method with simplified signature that does not return anything

Specified by:

subscribe in interface ISession

Parameters:

topic - URI of the topic to subscribe

handler - callback method for results of publication to the topic.

options - options for the subscribe

Returns:

a CompletableFuture that resolves to an instance of Subscription

subscribe

public <T> java.util.concurrent.CompletableFuture<Subscription> subscribe(java.lang.String topic,
                                                                          java.util.function.BiFunction<T,EventDetails,java.util.concurrent.CompletableFuture<ReceptionResult>> handler,
                                                                          SubscribeOptions options)

Subscribes to a WAMP topic. This is a convenience method that takes a callback method with simplified signature

Specified by:

subscribe in interface ISession

Parameters:

topic - URI of the topic to subscribe

handler - callback method for results of publication to the topic.

options - options for the subscribe

Returns:

a CompletableFuture that resolves to an instance of Subscription

subscribe

public <T,U> java.util.concurrent.CompletableFuture<Subscription> subscribe(java.lang.String topic,
                                                                            TriConsumer<T,U,EventDetails> handler,
                                                                            SubscribeOptions options)

Subscribes to a WAMP topic. This is a convenience method that takes a callback method with simplified signature

Specified by:

subscribe in interface ISession

Parameters:

topic - URI of the topic to subscribe

handler - callback method for results of publication to the topic.

options - options for the subscribe

Returns:

a CompletableFuture that resolves to an instance of Subscription

subscribe

public <T,U> java.util.concurrent.CompletableFuture<Subscription> subscribe(java.lang.String topic,
                                                                            TriFunction<T,U,EventDetails,java.util.concurrent.CompletableFuture<ReceptionResult>> handler,
                                                                            SubscribeOptions options)

Subscribes to a WAMP topic. This is a convenience method that takes a callback method with simplified signature

Specified by:

subscribe in interface ISession

Parameters:

topic - URI of the topic to subscribe

handler - callback method for results of publication to the topic.

options - options for the subscribe

Returns:

a CompletableFuture that resolves to an instance of Subscription

publish

public java.util.concurrent.CompletableFuture<Publication> publish(java.lang.String topic,
                                                                   java.util.List<java.lang.Object> args,
                                                                   java.util.Map<java.lang.String,java.lang.Object> kwargs,
                                                                   PublishOptions options)

Publishes to a previously registered WAMP topic

Specified by:

publish in interface ISession

Parameters:

topic - URI of the topic

args - positional arguments for the topic

kwargs - keyword arguments for the topic

options - options for the publication

Returns:

a CompletableFuture that resolves to an instance of Publication

publish

public java.util.concurrent.CompletableFuture<Publication> publish(java.lang.String topic,
                                                                   java.lang.Object arg,
                                                                   PublishOptions options)

Publishes to a previously registered WAMP topic that takes a single argument.

Specified by:

publish in interface ISession

Parameters:

topic - URI of the topic

arg - positional argument for the topic

options - options for the publication

Returns:

a CompletableFuture that resolves to an instance of Publication

publish

public java.util.concurrent.CompletableFuture<Publication> publish(java.lang.String topic,
                                                                   PublishOptions options,
                                                                   java.lang.Object... args)

Publishes to a previously registered WAMP topic that takes multiple positional arguments.

Specified by:

publish in interface ISession

Parameters:

topic - URI of the topic

options - options for the publication

args - positional arguments for the topic

Returns:

a CompletableFuture that resolves to an instance of Publication

publish

public java.util.concurrent.CompletableFuture<Publication> publish(java.lang.String topic,
                                                                   java.lang.Object... args)

Publishes to a previously registered WAMP topic that takes multiple positional arguments.

Specified by:

publish in interface ISession

Parameters:

topic - URI of the topic

args - positional arguments for the topic

Returns:

a CompletableFuture that resolves to an instance of Publication

publish

public java.util.concurrent.CompletableFuture<Publication> publish(java.lang.String topic,
                                                                   PublishOptions options)

Publishes to a previously registered WAMP topic that takes no arguments.

Specified by:

publish in interface ISession

Parameters:

topic - URI of the topic

options - options for the publication

Returns:

a CompletableFuture that resolves to an instance of Publication

publish

public java.util.concurrent.CompletableFuture<Publication> publish(java.lang.String topic)

Publishes to a previously registered WAMP topic that takes no arguments.

Specified by:

publish in interface ISession

Parameters:

topic - URI of the topic

Returns:

a CompletableFuture that resolves to an instance of Publication

register

public java.util.concurrent.CompletableFuture<Registration> register(java.lang.String procedure,
                                                                     java.util.function.Supplier endpoint,
                                                                     RegisterOptions options)

Registers a WAMP procedure.

Specified by:

register in interface ISession

Parameters:

procedure - name of the procedure

endpoint - the callee for the remote procedure

options - options for the procedure registration

Returns:

a CompletableFuture that resolves to an instance of Registration

register

public java.util.concurrent.CompletableFuture<Registration> register(java.lang.String procedure,
                                                                     IInvocationHandler endpoint,
                                                                     RegisterOptions options)

Registers a WAMP procedure.

Specified by:

register in interface ISession

Parameters:

procedure - name of the procedure

endpoint - the callee for the remote procedure

options - options for the procedure registration

Returns:

a CompletableFuture that resolves to an instance of Registration

register

public <T> java.util.concurrent.CompletableFuture<Registration> register(java.lang.String procedure,
                                                                         java.util.function.Function<T,java.util.concurrent.CompletableFuture<InvocationResult>> endpoint,
                                                                         RegisterOptions options)

Registers a WAMP procedure.

Specified by:

register in interface ISession

Parameters:

procedure - name of the procedure

endpoint - the callee for the remote procedure

options - options for the procedure registration

Returns:

a CompletableFuture that resolves to an instance of Registration

register

public <T> java.util.concurrent.CompletableFuture<Registration> register(java.lang.String procedure,
                                                                         java.util.function.BiFunction<T,InvocationDetails,java.util.concurrent.CompletableFuture<InvocationResult>> endpoint,
                                                                         RegisterOptions options)

Registers a WAMP procedure.

Specified by:

register in interface ISession

Parameters:

procedure - name of the procedure

endpoint - the callee for the remote procedure

options - options for the procedure registration

Returns:

a CompletableFuture that resolves to an instance of Registration

register

public <T,U> java.util.concurrent.CompletableFuture<Registration> register(java.lang.String procedure,
                                                                           TriFunction<T,U,InvocationDetails,java.util.concurrent.CompletableFuture<InvocationResult>> endpoint,
                                                                           RegisterOptions options)

Registers a WAMP procedure.

Specified by:

register in interface ISession

Parameters:

procedure - name of the procedure

endpoint - the callee for the remote procedure

options - options for the procedure registration

Returns:

a CompletableFuture that resolves to an instance of Registration

call

public java.util.concurrent.CompletableFuture<CallResult> call(java.lang.String procedure,
                                                               java.util.List<java.lang.Object> args,
                                                               java.util.Map<java.lang.String,java.lang.Object> kwargs,
                                                               CallOptions options)

Call a remote procedure.

Specified by:

call in interface ISession

Parameters:

procedure - URI of the procedure to call

args - positional arguments for the procedure

kwargs - keyword arguments for the procedure

options - options for the WAMP call

Returns:

a CompletableFuture that resolves to an instance of CallResult

call

public <T> java.util.concurrent.CompletableFuture<T> call(java.lang.String procedure,
                                                          java.util.List<java.lang.Object> args,
                                                          java.util.Map<java.lang.String,java.lang.Object> kwargs,
                                                          com.fasterxml.jackson.core.type.TypeReference<T> resultType,
                                                          CallOptions options)

Call a remote procedure where the result needs to be resolved to a POJO.

Specified by:

call in interface ISession

Parameters:

procedure - URI of the procedure to call

args - positional arguments for the procedure

kwargs - keyword arguments for the procedure

resultType - TypeReference encapsulating the class that the returned CompletableFuture should resolve to

options - options for the WAMP call

Returns:

a CompletableFuture that resolves to an instance of the class provided with resultType

call

public <T> java.util.concurrent.CompletableFuture<T> call(java.lang.String procedure,
                                                          com.fasterxml.jackson.core.type.TypeReference<T> resultType,
                                                          CallOptions options,
                                                          java.lang.Object... args)

Call a remote procedure where the result needs to be resolved to a POJO. This is a convenience method to pass positional arguments directly to the method call.

Specified by:

call in interface ISession

Parameters:

procedure - URI of the procedure to call

resultType - TypeReference encapsulating the class that the returned CompletableFuture should resolve to

options - options for the WAMP call

args - positional arguments for the procedure

Returns:

a CompletableFuture that resolves to an instance of the class provided with resultType

join

public java.util.concurrent.CompletableFuture<SessionDetails> join(java.lang.String realm,
                                                                   java.util.List<java.lang.String> authMethods)

Join a realm on the WAMP router

Specified by:

join in interface ISession

Parameters:

realm - name of the realm to join

authMethods - list of authentication methods to try

Returns:

a CompletableFuture that resolves to an instance of SessionDetails

leave

public void leave(java.lang.String reason,
                  java.lang.String message)

Leave the currently joined WAMP session.

Specified by:

leave in interface ISession

Parameters:

reason - URI representing the reason to leave

message - the leave message

addOnJoinListener

public ISession.OnJoinListener addOnJoinListener(ISession.OnJoinListener listener)

removeOnJoinListener

public void removeOnJoinListener(ISession.OnJoinListener listener)

adOnReadyListener

public ISession.OnReadyListener adOnReadyListener(ISession.OnReadyListener listener)

removeOnReadyListener

public void removeOnReadyListener(ISession.OnReadyListener listener)

addOnLeaveListener

public ISession.OnLeaveListener addOnLeaveListener(ISession.OnLeaveListener listener)

removeOnLeaveListener

public void removeOnLeaveListener(ISession.OnLeaveListener listener)

addOnConnectListener

public ISession.OnConnectListener addOnConnectListener(ISession.OnConnectListener listener)

removeOnConnectListener

public void removeOnConnectListener(ISession.OnConnectListener listener)

addOnDisconnectListener

public ISession.OnDisconnectListener addOnDisconnectListener(ISession.OnDisconnectListener listener)

removeOnDisconnectListener

public void removeOnDisconnectListener(ISession.OnDisconnectListener listener)

addOnUserErrorListener

public ISession.OnUserErrorListener addOnUserErrorListener(ISession.OnUserErrorListener listener)

removeOnUserErrorListener

public void removeOnUserErrorListener(ISession.OnUserErrorListener listener)