Package de.iip_ecosphere.platform.support.rest

Class Rest

java.lang.Object

de.iip_ecosphere.platform.support.rest.Rest

public abstract class Rest
extends Object

Generic access to Rest (server). Requires an implementing plugin of type Rest or an active RestProviderDescriptor. Simplified interface akin to Spark.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Rest.ExceptionHandler	Represents an exception handler, can be used to uniformly handle exceptions.
static interface	Rest.Filter	Represents a route filter.
static interface	Rest.Request	Request interface.
static interface	Rest.Response	Response interface.
static interface	Rest.RestServer	Represents a rest server.
static interface	Rest.Route	Represents a route (function).

Field Summary

Fields

Modifier and Type	Field	Description
private static Rest	instance

Constructor Summary

Constructors

Constructor	Description
Rest()

Method Summary

Modifier and Type	Method	Description
abstract Rest.RestServer	createServer(int port)	Creates a server instance.
Rest.RestServer	createServer(de.iip_ecosphere.platform.support.ServerAddress addr)	Creates a server instance.
abstract RestTarget	createTarget(String uri)	Creates a web/REST target to call operations on, a kind of REST client.
static Rest	getInstance()	Returns the Rest instance.
static void	setInstance(Rest rest)	Manually sets the instance.

Methods inherited from class java.lang.Object

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

Field Details

instance

private static Rest instance

Constructor Details

Rest

public Rest()

Method Details

getInstance

public static Rest getInstance()

Returns the Rest instance.

Returns:

the instance

setInstance

public static void setInstance(Rest rest)

Manually sets the instance. Shall not be needed, but may be required in some tests.

Parameters:

rest - the Rest instance

createServer

public abstract Rest.RestServer createServer(int port)

Creates a server instance.

Parameters:

port - the port to use

Returns:

the server instance

createServer

public Rest.RestServer createServer(de.iip_ecosphere.platform.support.ServerAddress addr)

Creates a server instance.

Parameters:

addr - the server address (port taken)

Returns:

the server instance

createTarget

public abstract RestTarget createTarget(String uri)

Creates a web/REST target to call operations on, a kind of REST client.

Parameters:

uri - web resource URI. May contain template parameters. Must not be null.

Returns:

the rest target instance

Throws:

IllegalArgumentException - in case the supplied string is not a valid URI template

NullPointerException - in case the supplied argument is null.