com.raspoid.network

Class Router

java.lang.Object

com.raspoid.network.Router

public class Router
extends java.lang.Object

A router is used to map a route with an action to execute on your project.

The main advantage is that each router can easily be used with each of our servers:

• SocketServer,
• MessageLikeSocketServer,
• Pushbullet,
• ...

All you need to do is create a Router, add some routes to this Router, and then link your Router to each intended server.

There exists 2 types of routes:

• routes without parameters
• routes with parameters

For each route, you can then easily define the response to send back to the client.

Note: a default "hello" route is added to each router. You can then easily test your installation by sending an "hello" request to your server(s).

See Also:

GeneralExample

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Router.Response Java 8 interface used to represent a response to a request without parameters.
static interface	Router.ResponseWithParams Interface used to represent a response to a request with parameters.

Constructor Summary

Constructors

Constructor and Description
Router() Constructor for a basic router.

Method Summary

Modifier and Type	Method and Description
void	addRoute(java.lang.String route, Router.Response response) Adds a new route WITHOUT parameters to the router.
void	addRouteWithParams(java.lang.String route, int nbParams, Router.ResponseWithParams response) Adds a new route WITH parameters to the router.
java.lang.String	getResponse(java.lang.String route, java.lang.String[] params) Checks the validity of the request, and then evaluate the response to send back to the client.
java.util.Map<java.lang.String,Router.Response>	getRoutesWithoutParams() Get the list of requests without parameters contained in this router.
java.util.Map<java.lang.String,com.raspoid.network.Pair<java.lang.Integer,Router.ResponseWithParams>>	getRoutesWithParams() Get the list of requests with parameters contained in this router.
boolean	routeIsValid(java.lang.String route, java.lang.String[] params) Checks if the route is valid and contains a correspondance in the router.

Methods inherited from class java.lang.Object

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

Constructor Detail

Router

public Router()

Constructor for a basic router.

A default "hello" route is added to each router. You can then easily test your installation by sending an "hello" request to your server(s).

Method Detail

addRoute

public void addRoute(java.lang.String route,
                     Router.Response response)

Adds a new route WITHOUT parameters to the router.

Parameters:

route - the command corresponding to this route.

response - the response to execute when the request will be triggered.

addRouteWithParams

public void addRouteWithParams(java.lang.String route,
                               int nbParams,
                               Router.ResponseWithParams response)

Adds a new route WITH parameters to the router.

Parameters:

route - the command corresponding to this route.

nbParams - the number of parameters that form the request.

response - the response to execute when the request will be triggered.

routeIsValid

public boolean routeIsValid(java.lang.String route,
                            java.lang.String[] params)

Checks if the route is valid and contains a correspondance in the router.

Parameters:

route - the route to analyze.

params - the input parameters of the route to analyze. null if no parameters.

Returns:

true if the route is valid. False otherwise.

getResponse

public java.lang.String getResponse(java.lang.String route,
                                    java.lang.String[] params)

Checks the validity of the request, and then evaluate the response to send back to the client.

This method always returns a comprehensive response String, even if the request is invalid.

Parameters:

route - the route to analyze.

params - the input parameters to use with the route. null if route without parameters.

Returns:

the String representation of the response to send back to the client.

getRoutesWithoutParams

public java.util.Map<java.lang.String,Router.Response> getRoutesWithoutParams()

Get the list of requests without parameters contained in this router.

Returns:

the list of requests without parameters contained in this router.

getRoutesWithParams

public java.util.Map<java.lang.String,com.raspoid.network.Pair<java.lang.Integer,Router.ResponseWithParams>> getRoutesWithParams()

Get the list of requests with parameters contained in this router.

Returns:

the list of requests with parameters contained in this router.