Express (Java Express 0.0.10 API)

java.lang.Object
- express.Express

All Implemented Interfaces:

Router
```
public class Express
extends Object
implements Router
```
Author:

Simon Reinisch Core class of java-express

Constructor Summary

Constructors
Constructor and Description
`Express()` Default, will bind the server to "localhost"
`Express(com.sun.net.httpserver.HttpsConfigurator httpsConfigurator)` Default, will bind the server to "localhost"
`Express(String hostname)` Create an express instance and bind the server to an hostname.
`Express(String hostname, com.sun.net.httpserver.HttpsConfigurator httpsConfigurator)` Create an express instance and bind the server to an hostname.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Express`	`all(HttpRequestHandler request)` Add an listener for all request methods and contexts.
`Express`	`all(String context, HttpRequestHandler request)` Adds an handler for a specific context.
`Express`	`all(String context, String requestMethod, HttpRequestHandler request)` Adds an handler for a specific context and method.
`Express`	`bind(Object... objects)` Binds a or multiple objects with request-handler methods on this express instance.
`Express`	`delete(String context, HttpRequestHandler request)` Add an listener for DELETE request's.
`Object`	`get(String key)` Returns the value which was allocated by this key.
`Express`	`get(String context, HttpRequestHandler request)` Add an listener for GET request's.
`ConcurrentHashMap<String,HttpRequestHandler>`	`getParameterListener()`
`boolean`	`isSecure()`
`void`	`listen()` Start the HTTP-Server on port 80.
`void`	`listen(ExpressListener onStart)` Start the HTTP-Server on port 80.
`void`	`listen(ExpressListener onStart, int port)` Start the HTTP-Server on a specific port.
`void`	`listen(int port)` Start the HTTP-Server on a specific port This method is asynchronous so be sure to add an listener or keep it in mind!
`Express`	`onParam(String param, HttpRequestHandler request)` Add a listener which will be called when an url with this parameter is called.
`Express`	`patch(String context, HttpRequestHandler request)` Add an listener for PATCH request's.
`Express`	`post(String context, HttpRequestHandler request)` Add an listener for POST request's.
`Express`	`put(String context, HttpRequestHandler request)` Add an listener for PUT request's.
`Object`	`set(String key, String val)` Add an key-val pair to the express app, can be used to store data.
`void`	`setExecutor(Executor executor)` Set an executor service.
`void`	`stop()` Stop express
`Express`	`use(ExpressRouter router)` Add an routing object.
`Express`	`use(HttpRequestHandler middleware)` Add an middleware which will be called before each request-type listener will be fired.
`Express`	`use(String root, ExpressRouter router)` Add an routing object with an specific root root.
`Express`	`use(String context, HttpRequestHandler middleware)` Add an middleware which will be called before each request-type listener will be fired.
`Express`	`use(String context, String requestMethod, HttpRequestHandler middleware)` Add an middleware which will be called before each request-type listener will be fired.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Express
```
public Express(String hostname)
```
    Create an express instance and bind the server to an hostname. Default is "Localhost"
    
    Parameters:
    
    hostname - The host name
  - Express
```
public Express(com.sun.net.httpserver.HttpsConfigurator httpsConfigurator)
```
    Default, will bind the server to "localhost"
    
    Parameters:
    
    httpsConfigurator - The HttpsConfigurator for https
  - Express
```
public Express(String hostname,
               com.sun.net.httpserver.HttpsConfigurator httpsConfigurator)
```
    Create an express instance and bind the server to an hostname. Default is "Localhost"
    
    Parameters:
    
    hostname - The host name
    
    httpsConfigurator - The HttpsConfigurator for https
  - Express
```
public Express()
```
    Default, will bind the server to "localhost"
- Method Detail
  - isSecure
```
public boolean isSecure()
```
    Returns:
    
    True if the server uses https.
  - onParam
```
public Express onParam(String param,
                       HttpRequestHandler request)
```
    Add a listener which will be called when an url with this parameter is called.
    
    Parameters:
    
    param - The parameter name.
    
    request - An request handler.
    
    Returns:
    
    Express this express instance
  - getParameterListener
```
public ConcurrentHashMap<String,HttpRequestHandler> getParameterListener()
```
  - set
```
public Object set(String key,
                  String val)
```
    Add an key-val pair to the express app, can be used to store data. Uses ConcurrentHashMap so it's thread save.
    
    Parameters:
    
    key - The key
    
    val - The value
    
    Returns:
    
    The last value which was attached by this key, can be null.
  - get
```
public Object get(String key)
```
    Returns the value which was allocated by this key.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    The value.
  - setExecutor
```
public void setExecutor(Executor executor)
                 throws IOException
```
    Set an executor service. Default is CachedThreadPool Can only changed if the server isn't already stardet.
    
    Parameters:
    
    executor - The new executor.
    
    Throws:
    
    IOException - If the server is currently running
  - use
```
public Express use(ExpressRouter router)
```
    Add an routing object.
    
    Parameters:
    
    router - The router.
    
    Returns:
    
    Express this express instance
  - use
```
public Express use(String root,
                   ExpressRouter router)
```
    Add an routing object with an specific root root.
    
    Parameters:
    
    root - The root path for all request to this router.
    
    router - The router.
    
    Returns:
    
    Express this express instance
  - use
```
public Express use(HttpRequestHandler middleware)
```
    Description copied from interface: Router
    
    Add an middleware which will be called before each request-type listener will be fired.
    
    Specified by:
    
    use in interface Router
    
    Parameters:
    
    middleware - An middleware which will be fired on every request-method and path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - use
```
public Express use(String context,
                   HttpRequestHandler middleware)
```
    Description copied from interface: Router
    
    Add an middleware which will be called before each request-type listener will be fired.
    
    Specified by:
    
    use in interface Router
    
    Parameters:
    
    context - The context where the middleware should listen.
    
    middleware - An middleware which will be fired if the context matches the request-path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - use
```
public Express use(String context,
                   String requestMethod,
                   HttpRequestHandler middleware)
```
    Description copied from interface: Router
    
    Add an middleware which will be called before each request-type listener will be fired.
    
    Specified by:
    
    use in interface Router
    
    Parameters:
    
    context - The context where the middleware should listen for the request handler..
    
    requestMethod - And type of request-method eg. GET, POST etc.
    
    middleware - An middleware which will be fired if the context matches the request-method- and path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - all
```
public Express all(HttpRequestHandler request)
```
    Description copied from interface: Router
    
    Add an listener for all request methods and contexts.
    
    Specified by:
    
    all in interface Router
    
    Parameters:
    
    request - Will be fired on all requests.
    
    Returns:
    
    The router itself to allow method call chaining.
  - all
```
public Express all(String context,
                   HttpRequestHandler request)
```
    Description copied from interface: Router
    
    Adds an handler for a specific context.
    
    Specified by:
    
    all in interface Router
    
    Parameters:
    
    context - The context.
    
    request - An listener which will be fired if the context matches the request-path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - all
```
public Express all(String context,
                   String requestMethod,
                   HttpRequestHandler request)
```
    Description copied from interface: Router
    
    Adds an handler for a specific context and method. You can use a star '*' to match every context / request-method.
    
    Specified by:
    
    all in interface Router
    
    Parameters:
    
    context - The context.
    
    requestMethod - The request method.
    
    request - An listener which will be fired if the context matches the request-path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - get
```
public Express get(String context,
                   HttpRequestHandler request)
```
    Description copied from interface: Router
    
    Add an listener for GET request's.
    
    Specified by:
    
    get in interface Router
    
    Parameters:
    
    context - The context.
    
    request - An listener which will be fired if the context matches the request-path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - post
```
public Express post(String context,
                    HttpRequestHandler request)
```
    Description copied from interface: Router
    
    Add an listener for POST request's.
    
    Specified by:
    
    post in interface Router
    
    Parameters:
    
    context - The context.
    
    request - An listener which will be fired if the context matches the request-path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - put
```
public Express put(String context,
                   HttpRequestHandler request)
```
    Description copied from interface: Router
    
    Add an listener for PUT request's.
    
    Specified by:
    
    put in interface Router
    
    Parameters:
    
    context - The context for the request handler..
    
    request - An listener which will be fired if the context matches the request-path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - delete
```
public Express delete(String context,
                      HttpRequestHandler request)
```
    Description copied from interface: Router
    
    Add an listener for DELETE request's.
    
    Specified by:
    
    delete in interface Router
    
    Parameters:
    
    context - The context.
    
    request - An listener which will be fired if the context matches the request-path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - patch
```
public Express patch(String context,
                     HttpRequestHandler request)
```
    Description copied from interface: Router
    
    Add an listener for PATCH request's.
    
    Specified by:
    
    patch in interface Router
    
    Parameters:
    
    context - The context.
    
    request - An listener which will be fired if the context matches the request-path.
    
    Returns:
    
    The router itself to allow method call chaining.
  - bind
```
public Express bind(Object... objects)
```
    Binds a or multiple objects with request-handler methods on this express instance. With the use of the DynExpress Annotation handler can be declared with a annotation on a compatible method which has as parameter a Request and Response object.
    
    Parameters:
    
    objects - Object with proper request handler methods.
    
    Returns:
    
    This express instance.
  - listen
```
public void listen()
```
    Start the HTTP-Server on port 80. This method is asynchronous so be sure to add an listener or keep it in mind!
  - listen
```
public void listen(int port)
```
    Start the HTTP-Server on a specific port This method is asynchronous so be sure to add an listener or keep it in mind!
    
    Parameters:
    
    port - The port.
  - listen
```
public void listen(ExpressListener onStart)
```
    Start the HTTP-Server on port 80. This method is asynchronous so be sure to add an listener or keep it in mind!
    
    Parameters:
    
    onStart - An listener which will be fired after the server is stardet.
  - listen
```
public void listen(ExpressListener onStart,
                   int port)
```
    Start the HTTP-Server on a specific port. This method is asynchronous so be sure to add an listener or keep it in mind.
    
    Parameters:
    
    onStart - An listener which will be fired after the server is stardet.
    
    port - The port.
  - stop
```
public void stop()
```
    Stop express

Class Express

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Express

Express

Express

Express

Method Detail

isSecure

onParam

getParameterListener

set

get

setExecutor

use

use

use

use

use

all

all

all

get

post

put

delete

patch

bind

listen

listen

listen

listen

stop