me.piggypiglet.framework.http.routes

Class Route

java.lang.Object

me.piggypiglet.framework.http.routes.Route

Direct Known Subclasses:

JsonRoute

public abstract class Route
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<Header>	HEADERS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Route(java.lang.String route, Header... headers) Provide the path of this route, do not include a forward slash at the beginning.

Method Summary

Modifier and Type	Method and Description
java.util.List<Header>	getHeaders() Get headers that this route should declare
java.lang.String	getRoute() Get the value of the route defined in this route
protected abstract java.lang.Object	provide(java.util.Map<java.lang.String,java.util.List<java.lang.String>> params, java.util.List<Header> headers, java.lang.String ip) Process user-inputted params and return a string response
java.lang.Object	run(java.util.Map<java.lang.String,java.util.List<java.lang.String>> params, java.util.List<Header> headers, java.lang.String ip) Process parameters and return a string based on them & the route

Methods inherited from class java.lang.Object

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

Field Detail

HEADERS

protected static final java.util.List<Header> HEADERS

Constructor Detail

Route

protected Route(java.lang.String route,
                Header... headers)

Provide the path of this route, do not include a forward slash at the beginning.

Parameters:

route - Route

headers - Optional headers to append to the page

Method Detail

provide

protected abstract java.lang.Object provide(java.util.Map<java.lang.String,java.util.List<java.lang.String>> params,
                                            java.util.List<Header> headers,
                                            java.lang.String ip)

Process user-inputted params and return a string response

Parameters:

params - Query parameters on the URL

headers - Any headers that were supplied in the request

ip - Client ip

Returns:

Object, will be converted to string

run

public java.lang.Object run(java.util.Map<java.lang.String,java.util.List<java.lang.String>> params,
                            java.util.List<Header> headers,
                            java.lang.String ip)

Process parameters and return a string based on them & the route

Parameters:

params - Map of params and their value(s). Identical to a multimap, example format would be: url/route?test=oof&test=oof2&oof=test which would result in: {test:["oof", "oof2"],oof:["test"]}

headers - List of headers

ip - Client ip

Returns:

Object, will be converted to string

getRoute

public java.lang.String getRoute()

Get the value of the route defined in this route

Returns:

String

getHeaders

public java.util.List<Header> getHeaders()

Get headers that this route should declare

Returns:

List of headers