io.spine.client

Class Subscriptions

java.lang.Object

io.spine.client.Subscriptions

All Implemented Interfaces:

io.spine.logging.Logging

public final class Subscriptions
extends java.lang.Object
implements io.spine.logging.Logging

Maintains the list of the active subscriptions created by the Client.

Subscriptions are created when a client application:

• subscribes to events;
• subscribes to entity states;
• posts a command.

The subscriptions should be cancelled after an update is delivered to the client and no further updates are expected.

All remaining subscriptions are cancelled by the Client when it closes.

See Also:

ClientRequest.subscribeTo(Class), ClientRequest.subscribeToEvent(Class), CommandRequest.post()

Method Summary

Modifier and Type	Method and Description
boolean	cancel(io.spine.client.Subscription s) Requests cancellation the passed subscription.
void	cancelAll() Requests cancellation of all subscriptions.
static io.spine.client.Subscription	from(io.spine.client.Topic topic) Creates a new subscription with the given Topic and a random ID.
static io.spine.client.SubscriptionId	generateId() Generates a new subscription identifier.
boolean	isEmpty() Verifies if there are any active subscriptions.
static io.spine.client.SubscriptionId	newId(java.lang.String value) Wraps a given String as a subscription identifier.
static java.lang.String	toShortString(io.spine.client.Subscription s) Deprecated. please use SubscriptionMixin.toShortString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spine.logging.Logging

_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

Method Detail

generateId

public static io.spine.client.SubscriptionId generateId()

Generates a new subscription identifier.

The result is based upon UUID generation.

Returns:

new subscription identifier.

newId

public static io.spine.client.SubscriptionId newId(java.lang.String value)

Wraps a given String as a subscription identifier.

Should not be used in production. Use automatic generation instead.

Returns:

new subscription identifier.

from

public static io.spine.client.Subscription from(io.spine.client.Topic topic)

Creates a new subscription with the given Topic and a random ID.

Parameters:

topic - subscription topic

Returns:

new subscription

toShortString

@Deprecated
public static java.lang.String toShortString(io.spine.client.Subscription s)

Deprecated. please use SubscriptionMixin.toShortString()

Obtains a short printable form of subscription.

Standard AbstractMessage.toString() includes all subscription data and thus its output is too huge to use in short log messages and stack traces.

Returns:

a printable String with core subscription data

cancel

@CanIgnoreReturnValue
public boolean cancel(io.spine.client.Subscription s)

Requests cancellation the passed subscription.

The cancellation of the subscription is done asynchronously.

Returns:

true if the subscription was previously made

cancelAll

public void cancelAll()

Requests cancellation of all subscriptions.

isEmpty

public boolean isEmpty()

Verifies if there are any active subscriptions.