Package io.inversion

Class Endpoint

java.lang.Object

io.inversion.Rule<Endpoint>

io.inversion.Endpoint

All Implemented Interfaces:

java.lang.Comparable<Endpoint>

public final class Endpoint
extends Rule<Endpoint>

A single Endpoint, bundling one or more Path match relative Actions, is selected to service a Request.

Nested Class Summary

Nested classes/interfaces inherited from class io.inversion.Rule

Rule.RuleMatcher

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<Action>	actions	The Actions that are 'local' to this request.
protected Api	api
protected boolean	internal	Internal Endpoints can only be called by recursive calls to the engine when Chain.depth() is @gt; 1.

Fields inherited from class io.inversion.Rule

ALL_METHODS, configMap, description, excludeMatchers, excludeOn, includeMatchers, includeOn, log, name, order, params

Constructor Summary

Constructors

Constructor	Description
Endpoint()
Endpoint(Action... actions)
Endpoint(java.lang.String ruleMatcherSpec, Action... actions)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Endpoint o)
Action	getAction(java.lang.String name)
java.util.List<Action>	getActions()
Api	getApi()
boolean	isInternal()
Endpoint	withAction(Action action)
Endpoint	withActions(Action... actions)
Endpoint	withApi(Api api)
Endpoint	withInternal(boolean internal)

Methods inherited from class io.inversion.Rule

afterWiringComplete, checkLazyConfig, compareTo, doLazyConfig, getAllExcludePaths, getAllIncludeMethods, getAllIncludePaths, getDefaultIncludeMatchers, getDescription, getExcludeMatchers, getIncludeMatchers, getName, getOrder, getParams, match, match, matches, matches, toString, withDescription, withExcludeOn, withExcludeOn, withIncludeOn, withIncludeOn, withName, withOrder, withParam, withParams

Methods inherited from class java.lang.Object

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

Field Detail

actions

protected final java.util.List<Action> actions

The Actions that are 'local' to this request.

These Actions are not run each Request automatically.

Compared to Actions that are registered directly with the Api via Api.withAction, these Actions are path matched relative to the Path that matched to select this Endpoint vs a different Endpoint.

internal

protected boolean internal

Internal Endpoints can only be called by recursive calls to the engine when Chain.depth() is @gt; 1. This could have been logically called 'private' but that is a reserved word in Java.

api

protected transient Api api

Constructor Detail

Endpoint

public Endpoint()

Endpoint

public Endpoint(Action... actions)

Endpoint

public Endpoint(java.lang.String ruleMatcherSpec,
                Action... actions)

Method Detail

compareTo

public int compareTo(Endpoint o)

getApi

public Api getApi()

withApi

public Endpoint withApi(Api api)

withInternal

public Endpoint withInternal(boolean internal)

isInternal

public boolean isInternal()

getAction

public Action getAction(java.lang.String name)

getActions

public java.util.List<Action> getActions()

withActions

public Endpoint withActions(Action... actions)

withAction

public Endpoint withAction(Action action)