server/io.spine.server.event.model/SubscriberMethod

SubscriberMethod

public abstract class SubscriberMethod extends AbstractHandlerMethod<T, M, C, E, R> implements VoidMethod<T, C, E>, SelectiveHandler<T, C, E, R>

A method annotated with the @Subscribe annotation.

Such a method may have side effects, but provides no visible output.

Inheritors

StateSubscriberMethod

EventSubscriberMethod

Constructors

SubscriberMethod

protected void SubscriberMethod(Method method, ParameterSpec<EventEnvelope> parameterSpec)

Functions

createFilter

protected abstract ArgumentFilter createFilter()

Creates the filter for messages handled by this method.

filter

public final ArgumentFilter filter()

Obtains the filter to apply to the messages received by this method.

messageClass

public EventClass messageClass()

Obtains the type of the incoming message class.

params

public MethodParams params()

Obtains parameters of the method.

Inherited functions

attributes

public final Set<Attribute<? extends Object>> attributes()

Obtains the set of method attributes configured for this method.

attributeSuppliers

protected Set<Function<Method, Attribute<? extends Object>>> attributeSuppliers()

Obtains a set of functions for getting method attributes by a raw method value.

checkAttributesMatch

protected void checkAttributesMatch(E envelope)

Allows to make sure that the passed envelope matches the annotation attributes of a method.

discoverAttributes

public final void discoverAttributes()

Initializes attributes by obtaining values via functions provided by attributeSuppliers.

ensureExternalMatch

public void ensureExternalMatch(boolean expectedValue)

Ensures that the external attribute of the method is the one expected.

equals

public boolean equals(Object obj)

firstParamType

protected static Class<M> firstParamType<M extends Message>(Method handler)

Returns the class of the first parameter of the passed handler method object.

getFullName

public String getFullName()

Returns a full name of the handler method.

handleRejection

protected Optional<Success> handleRejection(ThrowableMessage throwableMessage, T target, E origin)

hashCode

public int hashCode()

invoke

public DispatchOutcome invoke(T target, E envelope)

Feeds the given envelope to the given target and returns the outcome.

isDomestic

public boolean isDomestic()

Tells if the passed method is domestic, that is not marked as external).

isExternal

public boolean isExternal()

Tells if the passed method is external.

isPrivate

protected final boolean isPrivate()

Returns true if the method is declared private, false otherwise.

isPublic

protected final boolean isPublic()

Returns true if the method is declared public, false otherwise.

key

public DispatchKey key()

Creates a handler method dispatch key out of the message class.

parameterSpec

protected ParameterSpec<E> parameterSpec()

Obtains the specification of parameters for this method.

producedMessages

public final Set<R> producedMessages()

Retrieves the message classes produced by this handler method.

rawMessageClass

protected Class<? extends M> rawMessageClass()

rawMethod

public final Method rawMethod()

Obtains the handling method.

toString

public String toString()

Obtains the full name of the handler method.

toSuccessfulOutcome

public abstract Success toSuccessfulOutcome(Object rawResult, T target, E handledSignal)

public Success toSuccessfulOutcome(Object result, T target, E handledSignal)

Converts the raw method result to a successful propagation outcome.

SubscriberMethod

See also

Inheritors

Constructors

Functions

Inherited functions