io.inversion

Class Api

java.lang.Object

io.inversion.Rule<Api>

io.inversion.Api

All Implemented Interfaces:

java.lang.Comparable<Api>

public class Api
extends Rule<Api>

Contains the Collections, Endpoints and Actions that make up a REST API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Api.ApiListener Listener that can be registered with an Api to receive lifecycle, per request and per error callback notifications.

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

Rule.RuleMatcher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Action>	actions Actions that may be selected to run regardless of the matched Endpoint.
protected java.util.List<Collection>	collections The data objects being served by this API.
protected java.util.List<Db>	dbs The underlying data sources for the Api.
protected boolean	debug
protected java.util.List<Endpoint>	endpoints The Request HTTP method/path combinations that map to a distinct set of Actions.
protected java.lang.String	hash
protected java.util.List<Api.ApiListener>	listeners Listeners that receive callbacks on startup/shutdown/request/error.
protected java.lang.String	url

Fields inherited from class io.inversion.Rule

configMap, configStr, excludeMatchers, excludeOn, includeMatchers, includeOn, log, name, order

Constructor Summary

Constructors

Constructor and Description
Api()
Api(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.util.List<Action>	getActions()
java.util.List<Api.ApiListener>	getApiListeners()
Collection	getCollection(java.lang.String name)
java.util.List<Collection>	getCollections()
Db	getDb(java.lang.String name)
java.util.List<Db>	getDbs()
protected Rule.RuleMatcher	getDefaultIncludeMatch() Designed to allow subclasses to provide a default match behavior of no configuration was provided by the developer.
java.util.List<Endpoint>	getEndpoints()
java.lang.String	getHash()
long	getLoadTime()
java.lang.String	getUrl()
boolean	isDebug()
boolean	isStarted()
void	removeExcludes()
void	setDebug(boolean debug)
void	setLoadTime(long loadTime)
Api	withAction(Action action)
Api	withActions(Action... actions) Add Action(s) may be selected to run across multiple Endpoints.
Api	withApiListener(Api.ApiListener listener)
Api	withCollection(Collection coll)
<T extends Db> Api	withDb(Db<T> db)
Api	withDbs(Db... dbs)
Api	withEndpoint(Endpoint... endpoints)
Api	withEndpoint(java.lang.String methods, java.lang.String includePaths, Action... actions)
Api	withHash(java.lang.String hash)
Api	withRelationship(Collection parentCollection, java.lang.String parentPropertyName, Collection childCollection, java.lang.String childPropertyName, Property... childFkProps) Creates a ONE_TO_MANY Relationship from the parent to child collection and the inverse MANY_TO_ONE from the child to the parent.
Api	withRelationship(java.lang.String parentCollectionName, java.lang.String parentPropertyName, java.lang.String childCollectionName, java.lang.String childPropertyName, java.lang.String... childFkProps) This method takes String instead of actual Collections and Properties as a convenience to people hand wiring up an Api.
Api	withUrl(java.lang.String url)

Methods inherited from class io.inversion.Rule

checkLazyConfig, compareTo, doLazyConfig, getAllExcludePaths, getAllIncludePaths, getConfig, getConfig, getConfigKeys, getExcludeMatchers, getIncludeMatchers, getName, getOrder, match, matches, matches, toString, withConfig, withExcludeOn, withExcludeOn, withExcludeOn, withIncludeOn, withIncludeOn, withIncludeOn, withName, withOrder

Methods inherited from class java.lang.Object

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

Field Detail

dbs

protected final java.util.List<Db> dbs

The underlying data sources for the Api.

endpoints

protected final java.util.List<Endpoint> endpoints

The Request HTTP method/path combinations that map to a distinct set of Actions.

A single Endpoint will be selected to run to service a Request. Any additional Path matching rules that exist on these Endpoint's Actions will be interpreted as relative to the end of the selected Endpoint's Path match.

actions

protected final java.util.List<Action> actions

Actions that may be selected to run regardless of the matched Endpoint.

The Action's Path match statements will be considered relative to the Api's base URL NOT relative to the selected Endpoint.

collections

protected final java.util.List<Collection> collections

The data objects being served by this API. In a simple API these may map one-to-one to, for example, database tables from a JdbcDb connecting to a RDBMS such as MySql or SqlServer.

listeners

protected final transient java.util.List<Api.ApiListener> listeners

Listeners that receive callbacks on startup/shutdown/request/error.

hash

protected transient java.lang.String hash

debug

protected boolean debug

url

protected java.lang.String url

Constructor Detail

Api

public Api()

Api

public Api(java.lang.String name)

Method Detail

getDefaultIncludeMatch

protected Rule.RuleMatcher getDefaultIncludeMatch()

Description copied from class: Rule

Designed to allow subclasses to provide a default match behavior of no configuration was provided by the developer.

Overrides:

getDefaultIncludeMatch in class Rule<Api>

Returns:

the default include match "*","*"

isStarted

public boolean isStarted()

removeExcludes

public void removeExcludes()

getHash

public java.lang.String getHash()

withHash

public Api withHash(java.lang.String hash)

withCollection

public Api withCollection(Collection coll)

getCollections

public java.util.List<Collection> getCollections()

getCollection

public Collection getCollection(java.lang.String name)

getDb

public Db getDb(java.lang.String name)

getDbs

public java.util.List<Db> getDbs()

Returns:

the dbs

withDbs

public Api withDbs(Db... dbs)

Parameters:

dbs - the dbs to set

Returns:

this

withDb

public <T extends Db> Api withDb(Db<T> db)

getLoadTime

public long getLoadTime()

setLoadTime

public void setLoadTime(long loadTime)

getEndpoints

public java.util.List<Endpoint> getEndpoints()

withEndpoint

public Api withEndpoint(java.lang.String methods,
                        java.lang.String includePaths,
                        Action... actions)

withEndpoint

public Api withEndpoint(Endpoint... endpoints)

withRelationship

public Api withRelationship(java.lang.String parentCollectionName,
                            java.lang.String parentPropertyName,
                            java.lang.String childCollectionName,
                            java.lang.String childPropertyName,
                            java.lang.String... childFkProps)

This method takes String instead of actual Collections and Properties as a convenience to people hand wiring up an Api. The referenced Collections and Properties actually have to exist already or you will get a NPE.

Parameters:

parentCollectionName - the name of the parent collection

parentPropertyName - the name of the json property for the parent that references the child

childCollectionName - the target child collection name

childPropertyName - the name of hte json property for the child that references the parent

childFkProps - names of the existing Properties that make up the foreign key

Returns:

this

withRelationship

public Api withRelationship(Collection parentCollection,
                            java.lang.String parentPropertyName,
                            Collection childCollection,
                            java.lang.String childPropertyName,
                            Property... childFkProps)

Creates a ONE_TO_MANY Relationship from the parent to child collection and the inverse MANY_TO_ONE from the child to the parent. The Relationship object along with the required Index objects are created.

For collections backed by relational data sources (like a SQL db) the length of childFkProps will generally match the length of parentCollections primary index. If the two don't match, then childFkProps must be 1. In this case, the compound primary index of parentCollection will be encoded as an resourceKey in the single child table property.

Parameters:

parentCollection - the collection to add the relationship to

parentPropertyName - the name of the json property for the parent that references the child

childCollection - the target child collection

childPropertyName - the name of hte json property for the child that references the parent

childFkProps - Properties that make up the foreign key

Returns:

this

getActions

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

withActions

public Api withActions(Action... actions)

Add Action(s) may be selected to run across multiple Endpoints.

Parameters:

actions - actions to match and conditionally run across all Requests

Returns:

this

withAction

public Api withAction(Action action)

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)

getUrl

public java.lang.String getUrl()

withUrl

public Api withUrl(java.lang.String url)

withApiListener

public Api withApiListener(Api.ApiListener listener)

getApiListeners

public java.util.List<Api.ApiListener> getApiListeners()