au.com.mountainpass.hyperstate.core

Class Action<T extends Entity>

java.lang.Object

au.com.mountainpass.hyperstate.core.Titled

au.com.mountainpass.hyperstate.core.Action<T>

Type Parameters:

T - the type returned by invoking the action

Direct Known Subclasses:

JavaAction

public abstract class Action<T extends Entity>
extends Titled

Actions represent available behaviours an entity exposes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Action()
	Action(java.lang.String name, Address address, Parameter... parameters)

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.concurrent.CompletableFuture<T>	doInvoke(java.util.Map<java.lang.String,java.lang.Object> filteredParameters)
Address	getAddress()
java.lang.String	getName()
abstract org.springframework.http.HttpMethod	getNature()
java.util.Set<java.lang.String>	getParameterKeys()
java.util.List<Parameter>	getParameters()
java.util.concurrent.CompletableFuture<T>	invoke(java.util.Map<java.lang.String,java.lang.Object> context)

Methods inherited from class au.com.mountainpass.hyperstate.core.Titled

getClasses, getTitle, hasNature, setClasses, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

Action

protected Action()

Action

public Action(java.lang.String name,
              Address address,
              Parameter... parameters)

Method Detail

doInvoke

protected abstract java.util.concurrent.CompletableFuture<T> doInvoke(java.util.Map<java.lang.String,java.lang.Object> filteredParameters)

getName

public java.lang.String getName()

Returns:

the identifier

getAddress

public Address getAddress()

getNature

public abstract org.springframework.http.HttpMethod getNature()

Returns:

the nature

getParameterKeys

public java.util.Set<java.lang.String> getParameterKeys()

getParameters

public java.util.List<Parameter> getParameters()

Returns:

the parameters

invoke

public java.util.concurrent.CompletableFuture<T> invoke(java.util.Map<java.lang.String,java.lang.Object> context)

Parameters:

context - name value pairs representing the parameters the action is being invoked with

Returns:

a future representing the result from a successful invocation of the action. The invocation may be a network operation, so the caller should not make assumptions about the timeliness of the response.