au.com.mountainpass.hyperstate.core

Class Action<T>

java.lang.Object

au.com.mountainpass.hyperstate.core.Labelled

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 Labelled

Actions represent available behaviours an entity exposes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Action()
	Action(Resolver resolver, java.lang.String identifier, Link link, Parameter... parameters)

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.concurrent.CompletableFuture<T>	doInvoke(Resolver resolver, java.util.Map<java.lang.String,java.lang.Object> filteredParameters)
java.net.URI	getAddress()
java.lang.String	getIdentifier()
Link	getLink()
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.Labelled

getLabel, getNatures, hasNature, setNatures, 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(Resolver resolver,
              java.lang.String identifier,
              Link link,
              Parameter... parameters)

Method Detail

doInvoke

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

getAddress

public java.net.URI getAddress()

getIdentifier

public java.lang.String getIdentifier()

Returns:

the identifier

getLink

public Link getLink()

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.