Windward (windward 1.5.3-RELEASE API)

java.lang.Object
- org.flmelody.core.Windward

All Implemented Interfaces:: Router<Windward>

public final class Windward
extends Object
implements Router<Windward>

Author:: esotericman

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Windward`	`delete(String relativePath, Consumer<SimpleWindwardContext> consumer)` Register function with delete method
`<C extends EnhancedWindwardContext & HttpKind> Windward`	`delete(String relativePath, EnhancedFunction<C,?> 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 or resource by specific path
`Windward`	`get(String relativePath, Consumer<SimpleWindwardContext> consumer)` Register function with get method
`<C extends EnhancedWindwardContext & HttpKind> Windward`	`get(String relativePath, EnhancedFunction<C,?> function)` Register function with get method
`<R> Windward`	`get(String relativePath, Supplier<R> supplier)` Register function with get method
`String`	`getContextPath()`
`String`	`getStaticResourceLocation()`
`String`	`getTemplateRoot()`
`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
`<C extends EnhancedWindwardContext & HttpKind> Windward`	`http(HttpMethod httpMethod, String relativePath, EnhancedFunction<C,?> 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
`<C extends EnhancedWindwardContext & HttpKind> Windward`	`post(String relativePath, EnhancedFunction<C,?> function)` Register function with post method
`<R> Windward`	`post(String relativePath, Supplier<R> supplier)` Register function with post method
`Windward`	`publishEvent(Event... events)` Publish event
`Windward`	`put(String relativePath, Consumer<SimpleWindwardContext> consumer)` Register function with put method
`<C extends EnhancedWindwardContext & HttpKind> Windward`	`put(String relativePath, EnhancedFunction<C,?> 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`	`registerListener(Listener... listeners)` Register listener
`Windward`	`registerPlugin(PluginSlot pluginSlot, Plugin plugin)` Register plugin or overwrite existed
`Windward`	`resource(String... pathPatterns)` Register resources path pattern
`Windward`	`resources(String staticResourceLocation, String... pathPatterns)` Register resources path pattern for specific resource location
`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 templateRoot, String staticResourceLocation, Filter... filters)` Prepare core engine of Windward
`Windward`	`sse(HttpMethod httpMethod, String relativePath, EnhancedFunction<SseWindwardContext,SseEjector> function)` Register SSE (server send event)
`Windward`	`sse(String relativePath, EnhancedFunction<SseWindwardContext,SseEjector> function)` Register SSE (server send event)
`Windward`	`then()`
`Windward`	`ws(String relativePath, Consumer<WebSocketWindwardContext> consumer, AuthorizationProvider... authorizationProviders)` 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 templateRoot,
                             String staticResourceLocation,
                             Filter... filters)

Prepare core engine of Windward

Parameters:: port - server port; contextPath - path of root; templateRoot - root for template files; staticResourceLocation - location of static 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

registerListener
```
public Windward registerListener(Listener... listeners)
```
Register listener

Parameters:

listeners - event listeners

Returns:

current windward

registerPlugin

public Windward registerPlugin(PluginSlot pluginSlot,
                               Plugin plugin)

Parameters:: pluginSlot - slot; plugin - plugin
Returns:: current windward

publishEvent
```
public Windward publishEvent(Event... events)
```
Publish event

Parameters:

events - events

Returns:

current windward

findRouter

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

Find out registered function or resource 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()
```

getTemplateRoot
```
public String getTemplateRoot()
```

getStaticResourceLocation

public String getStaticResourceLocation()

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<Windward>

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)

Specified by:: http in interface Router<Windward>
Parameters:: httpMethod - http method; relativePath - relative path; consumer - function to consume
Returns:: this

http

public <C extends EnhancedWindwardContext & HttpKind> Windward http(HttpMethod httpMethod,
                                                                    String relativePath,
                                                                    EnhancedFunction<C,?> function)

Specified by:: http in interface Router<Windward>
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<Windward>

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<Windward>

Parameters:

relativePath - relativePath

consumer - function to consume

Returns:

this

get

public <C extends EnhancedWindwardContext & HttpKind> Windward get(String relativePath,
                                                                   EnhancedFunction<C,?> function)

Specified by:: get in interface Router<Windward>
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<Windward>

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<Windward>

Parameters:

relativePath - relative path

consumer - function to consume

Returns:

this

put

public <C extends EnhancedWindwardContext & HttpKind> Windward put(String relativePath,
                                                                   EnhancedFunction<C,?> function)

Specified by:: put in interface Router<Windward>
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<Windward>

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<Windward>

Parameters:

relativePath - relative path

consumer - function to consume

Returns:

this

post

public <C extends EnhancedWindwardContext & HttpKind> Windward post(String relativePath,
                                                                    EnhancedFunction<C,?> function)

Specified by:: post in interface Router<Windward>
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<Windward>

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<Windward>

Parameters:

relativePath - relative path

consumer - function to consume

Returns:

this

delete

public <C extends EnhancedWindwardContext & HttpKind> Windward delete(String relativePath,
                                                                      EnhancedFunction<C,?> function)

Specified by:: delete in interface Router<Windward>
Parameters:: relativePath - relative path; function - function to consume
Returns:: this

sse
```
public Windward sse(String relativePath,
                    EnhancedFunction<SseWindwardContext,SseEjector> function)
```
Register SSE (server send event)

Specified by:

sse in interface Router<Windward>

Parameters:

relativePath - relative path

function - function to consume

Returns:

this

sse

public Windward sse(HttpMethod httpMethod,
                    String relativePath,
                    EnhancedFunction<SseWindwardContext,SseEjector> function)

Specified by:: sse in interface Router<Windward>
Parameters:: httpMethod - http method; relativePath - relative path; function - function to consume
Returns:: this

ws
```
public Windward ws(String relativePath,
                   Consumer<WebSocketWindwardContext> consumer,
                   AuthorizationProvider... authorizationProviders)
```
Register websocket function

Specified by:

ws in interface Router<Windward>

Parameters:

relativePath - relative path

consumer - function to consume

authorizationProviders - authorizationProviders

Returns:

this

See Also:

ExtensionalWebSocketPlugin

resource
```
public Windward resource(String... pathPatterns)
```
Register resources path pattern

Specified by:

resource in interface Router<Windward>

Parameters:

pathPatterns - resources path pattern

Returns:

this

resources
```
public Windward resources(String staticResourceLocation,
                          String... pathPatterns)
```
Register resources path pattern for specific resource location

Specified by:

resources in interface Router<Windward>

Parameters:

staticResourceLocation - resource location

pathPatterns - resources path pattern

Returns:

this

Class Windward

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setup

setup

setup

setup

run

group

registerFilter

registerExceptionHandler

registerListener

registerPlugin

publishEvent

findRouter

filters

exceptionHandlers

plugin

plugins

getContextPath

getTemplateRoot

getStaticResourceLocation

then

http

http

http

get

get

get

put

put

put

post

post

post

delete

delete

delete

sse

sse

ws

resource

resources