net.oneandone.concierge

Class Concierge

java.lang.Object

io.dropwizard.Application<ApiGatewayConfiguration>

net.oneandone.concierge.Concierge

public class Concierge
extends io.dropwizard.Application<ApiGatewayConfiguration>

The Concierge will help you to create an API gateway easily.

The idea is pretty simple. We defined a resource identifier pattern which you can learn in the documentation of the ResourceIdentifier. As you will learn, there are three kinds of resources:

• elements
• groups
• and extensions

To resolve these resources you can implement the resolvers. There are GroupResolver to resolve elements, and ExtensionResolver to resolve extensions for elements.

These resolvers will be dynamically created by the configuration specified in start(URL). As this implementation is based on Dropwizard, you can learn more about the configuration file format in their user manual.

The additional properties for the configuration file are defined in ApiGatewayConfiguration. Basically these properties are list of class names for the resolver implementations you want to use.

You'll find an example implementation on GitHub.

Constructor Summary

Constructors

Constructor and Description
Concierge()

Method Summary

Modifier and Type	Method and Description
void	run(ApiGatewayConfiguration configuration, io.dropwizard.setup.Environment environment)
static Concierge	start(java.net.URL configurationFile) Starts the concierge web server with the specified configuration.
void	stop() Stops this concierge web server instance.

Methods inherited from class io.dropwizard.Application

getConfigurationClass, getName, initialize, run

Methods inherited from class java.lang.Object

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

Constructor Detail

Concierge

public Concierge()

Method Detail

run

public void run(ApiGatewayConfiguration configuration,
                io.dropwizard.setup.Environment environment)
         throws java.lang.Exception

Specified by:

run in class io.dropwizard.Application<ApiGatewayConfiguration>

Throws:

java.lang.Exception

start

public static Concierge start(java.net.URL configurationFile)
                       throws java.lang.Exception

Starts the concierge web server with the specified configuration.

The call of this method is not blocking.

Parameters:

configurationFile - the configuration file URL

Returns:

the concierge web server instance

Throws:

java.lang.Exception - thrown on any exception

stop

public void stop()
          throws java.lang.Exception

Stops this concierge web server instance.

Throws:

java.lang.IllegalStateException - if the server wasn't started

java.lang.Exception