org.flmelody.core

Class Windward

java.lang.Object

org.flmelody.core.Windward

All Implemented Interfaces:

Router

public class Windward
extends Object
implements Router

Author:

esotericman

Method Summary

Modifier and Type	Method and Description
Windward	delete(String relativePath, Consumer<SimpleWindwardContext> consumer) register function with delete method
Windward	delete(String relativePath, Function<EnhancedWindwardContext,?> function) register function with delete method
<R> Windward	delete(String relativePath, Supplier<R> supplier) register function with delete method
static List<ExceptionHandler>	exceptionHandlers() get exception handlers
static List<Filter>	filters() get filters
static <I> FunctionMetaInfo<I>	findRouter(String relativePath, String method) find out registered function by specific path
Windward	get(String relativePath, Consumer<SimpleWindwardContext> consumer) register function with get method
Windward	get(String relativePath, Function<EnhancedWindwardContext,?> function) register function with get method
<R> Windward	get(String relativePath, Supplier<R> supplier) register function with get method
String	getContextPath()
String	getResourceRoot()
RouterGroup<Windward>	group(String relativePath) define new router with specific relativePath
Windward	http(HttpMethod httpMethod, String relativePath, Consumer<SimpleWindwardContext> consumer) register function with specific method
Windward	http(HttpMethod httpMethod, String relativePath, Function<EnhancedWindwardContext,?> function) register function with specific method
<R> Windward	http(HttpMethod httpMethod, String relativePath, Supplier<R> supplier) register function with specific method
static <T extends Plugin> T	plugin(Class<T> clazz) get plugin
static <T extends Plugin> List<T>	plugins(Class<T> clazz) get plugins by super or self
Windward	post(String relativePath, Consumer<SimpleWindwardContext> consumer) register function with post method
Windward	post(String relativePath, Function<EnhancedWindwardContext,?> function) register function with post method
<R> Windward	post(String relativePath, Supplier<R> supplier) register function with post method
Windward	put(String relativePath, Consumer<SimpleWindwardContext> consumer) register function with put method
Windward	put(String relativePath, Function<EnhancedWindwardContext,?> function) register function with put method
<R> Windward	put(String relativePath, Supplier<R> supplier) register function with put method
Windward	registerExceptionHandler(ExceptionHandler... exceptionHandlers) register exception handler
Windward	registerFilter(Filter... filters) register filter
Windward	registerPlugin(Class<? extends Plugin> clazz, Plugin plugin) register plugin or overwrite existed
void	run() run server
static Windward	setup()
static Windward	setup(int port, Filter... filters) prepare core engine of Windward
static Windward	setup(int port, String contextPath, Filter... filters) prepare core engine of Windward
static Windward	setup(int port, String contextPath, String resourceRoot, Filter... filters) prepare core engine of Windward
Windward	then()
Windward	ws(String relativePath, Consumer<WebSocketWindwardContext> consumer) register websocket function

Methods inherited from class java.lang.Object

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

Method Detail

setup

public static Windward setup()

setup

public static Windward setup(int port,
                             Filter... filters)

prepare core engine of Windward

Parameters:

port - server port

filters - request filters

Returns:

core engine of Windward

setup

public static Windward setup(int port,
                             String contextPath,
                             Filter... filters)

prepare core engine of Windward

Parameters:

port - server port

contextPath - path of root

filters - request filters

Returns:

core engine of Windward

setup

public static Windward setup(int port,
                             String contextPath,
                             String resourceRoot,
                             Filter... filters)

prepare core engine of Windward

Parameters:

port - server port

contextPath - path of root

resourceRoot - root for resource

filters - request filters

Returns:

core engine of Windward

run

public void run()
         throws ServerException

run server

Throws:

ServerException - exception

group

public RouterGroup<Windward> group(String relativePath)

define new router with specific relativePath

Parameters:

relativePath - relativePath

Returns:

routerGroup

registerFilter

public Windward registerFilter(Filter... filters)

register filter

Parameters:

filters - filter

Returns:

current windward

registerExceptionHandler

public Windward registerExceptionHandler(ExceptionHandler... exceptionHandlers)

register exception handler

Parameters:

exceptionHandlers - exception handler

Returns:

current windward

registerPlugin

public Windward registerPlugin(Class<? extends Plugin> clazz,
                               Plugin plugin)

register plugin or overwrite existed

Parameters:

clazz - plugin class

plugin - plugin

Returns:

current windward

findRouter

public static <I> FunctionMetaInfo<I> findRouter(String relativePath,
                                                 String method)

find out registered function by specific path

Type Parameters:

I - routers metadata

Parameters:

relativePath - relativePath

method - http methods name

Returns:

registered function

filters

public static List<Filter> filters()

get filters

Returns:

filters

exceptionHandlers

public static List<ExceptionHandler> exceptionHandlers()

get exception handlers

Returns:

exception handlers

plugin

public static <T extends Plugin> T plugin(Class<T> clazz)

get plugin

Type Parameters:

T - plugin type

Parameters:

clazz - class of plugin

Returns:

plugin

plugins

public static <T extends Plugin> List<T> plugins(Class<T> clazz)

get plugins by super or self

Type Parameters:

T - class type

Parameters:

clazz - super or self class

Returns:

plugins

getContextPath

public String getContextPath()

getResourceRoot

public String getResourceRoot()

then

public Windward then()

http

public <R> Windward http(HttpMethod httpMethod,
                         String relativePath,
                         Supplier<R> supplier)

register function with specific method

Specified by:

http in interface Router

Type Parameters:

R - response data

Parameters:

httpMethod - http method

relativePath - relative path

supplier - supplier

Returns:

this

http

public Windward http(HttpMethod httpMethod,
                     String relativePath,
                     Consumer<SimpleWindwardContext> consumer)

register function with specific method

Specified by:

http in interface Router

Parameters:

httpMethod - http method

relativePath - relative path

consumer - function to consume

Returns:

this

http

public Windward http(HttpMethod httpMethod,
                     String relativePath,
                     Function<EnhancedWindwardContext,?> function)

register function with specific method

Specified by:

http in interface Router

Parameters:

httpMethod - method of http

relativePath - relative path

function - function to consume

Returns:

this

get

public <R> Windward get(String relativePath,
                        Supplier<R> supplier)

register function with get method

Specified by:

get in interface Router

Type Parameters:

R - response data

Parameters:

relativePath - relative path

supplier - supplier

Returns:

this

get

public Windward get(String relativePath,
                    Consumer<SimpleWindwardContext> consumer)

register function with get method

Specified by:

get in interface Router

Parameters:

relativePath - relativePath

consumer - function to consume

Returns:

this

get

public Windward get(String relativePath,
                    Function<EnhancedWindwardContext,?> function)

register function with get method

Specified by:

get in interface Router

Parameters:

relativePath - relative path

function - function to consume

Returns:

this

put

public <R> Windward put(String relativePath,
                        Supplier<R> supplier)

register function with put method

Specified by:

put in interface Router

Type Parameters:

R - response data

Parameters:

relativePath - relative path

supplier - supplier

Returns:

this

put

public Windward put(String relativePath,
                    Consumer<SimpleWindwardContext> consumer)

register function with put method

Specified by:

put in interface Router

Parameters:

relativePath - relative path

consumer - function to consume

Returns:

this

put

public Windward put(String relativePath,
                    Function<EnhancedWindwardContext,?> function)

register function with put method

Specified by:

put in interface Router

Parameters:

relativePath - relative path

function - function to consume

Returns:

this

post

public <R> Windward post(String relativePath,
                         Supplier<R> supplier)

register function with post method

Specified by:

post in interface Router

Type Parameters:

R - response data

Parameters:

relativePath - relative path

supplier - supplier

Returns:

this

post

public Windward post(String relativePath,
                     Consumer<SimpleWindwardContext> consumer)

register function with post method

Specified by:

post in interface Router

Parameters:

relativePath - relative path

consumer - function to consume

Returns:

this

post

public Windward post(String relativePath,
                     Function<EnhancedWindwardContext,?> function)

register function with post method

Specified by:

post in interface Router

Parameters:

relativePath - relative path

function - function to consume

Returns:

this

delete

public <R> Windward delete(String relativePath,
                           Supplier<R> supplier)

register function with delete method

Specified by:

delete in interface Router

Type Parameters:

R - response data

Parameters:

relativePath - relative path

supplier - supplier

Returns:

this

delete

public Windward delete(String relativePath,
                       Consumer<SimpleWindwardContext> consumer)

register function with delete method

Specified by:

delete in interface Router

Parameters:

relativePath - relative path

consumer - function to consume

Returns:

this

delete

public Windward delete(String relativePath,
                       Function<EnhancedWindwardContext,?> function)

register function with delete method

Specified by:

delete in interface Router

Parameters:

relativePath - relative path

function - function to consume

Returns:

this

ws

public Windward ws(String relativePath,
                   Consumer<WebSocketWindwardContext> consumer)

register websocket function

Specified by:

ws in interface Router

Parameters:

relativePath - relative path

consumer - function to consume

Returns:

this