de.dytanic.cloudnet.web.server.handler

Class MethodDynamicWebHandler

java.lang.Object

de.dytanic.cloudnet.web.server.handler.DynamicWebHandler

de.dytanic.cloudnet.web.server.handler.MethodDynamicWebHandler

Direct Known Subclasses:

MethodDynamicWebHandlerAdapter

public abstract class MethodDynamicWebHandler
extends DynamicWebHandler

Dynamic web handler that handles requests with methods for each of the common HTTP methods.

Constructor Summary

Constructors

Constructor and Description
MethodDynamicWebHandler()

Method Summary

Modifier and Type	Method and Description
abstract io.netty.handler.codec.http.FullHttpResponse	connect(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic CONNECT request to the configured path.
abstract io.netty.handler.codec.http.FullHttpResponse	delete(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic DELETE request to the configured path.
abstract io.netty.handler.codec.http.FullHttpResponse	get(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic GET request to the configured path.
io.netty.handler.codec.http.FullHttpResponse	handleRequest(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider path, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic request.
abstract io.netty.handler.codec.http.FullHttpResponse	head(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic HEAD request to the configured path.
abstract io.netty.handler.codec.http.FullHttpResponse	options(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic OPTIONS request to the configured path.
abstract io.netty.handler.codec.http.FullHttpResponse	patch(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic PATCH request to the configured path.
abstract io.netty.handler.codec.http.FullHttpResponse	post(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic POST request to the configured path.
abstract io.netty.handler.codec.http.FullHttpResponse	put(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic PUT request to the configured path.
abstract io.netty.handler.codec.http.FullHttpResponse	trace(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a dynamic TRACE request to the configured path.

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodDynamicWebHandler

public MethodDynamicWebHandler()

Method Detail

handleRequest

public final io.netty.handler.codec.http.FullHttpResponse handleRequest(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                        QueryDecoder queryDecoder,
                                                                        PathProvider path,
                                                                        io.netty.handler.codec.http.HttpRequest httpRequest)
                                                                 throws Exception

Description copied from class: DynamicWebHandler

Handle a dynamic request.

Specified by:

handleRequest in class DynamicWebHandler

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

path - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request

connect

public abstract io.netty.handler.codec.http.FullHttpResponse connect(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                     QueryDecoder queryDecoder,
                                                                     PathProvider pathProvider,
                                                                     io.netty.handler.codec.http.HttpRequest httpRequest)
                                                              throws Exception

Handle a dynamic CONNECT request to the configured path.

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

pathProvider - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request

delete

public abstract io.netty.handler.codec.http.FullHttpResponse delete(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                    QueryDecoder queryDecoder,
                                                                    PathProvider pathProvider,
                                                                    io.netty.handler.codec.http.HttpRequest httpRequest)
                                                             throws Exception

Handle a dynamic DELETE request to the configured path.

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

pathProvider - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request

get

public abstract io.netty.handler.codec.http.FullHttpResponse get(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                 QueryDecoder queryDecoder,
                                                                 PathProvider pathProvider,
                                                                 io.netty.handler.codec.http.HttpRequest httpRequest)
                                                          throws Exception

Handle a dynamic GET request to the configured path.

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

pathProvider - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request

put

public abstract io.netty.handler.codec.http.FullHttpResponse put(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                 QueryDecoder queryDecoder,
                                                                 PathProvider pathProvider,
                                                                 io.netty.handler.codec.http.HttpRequest httpRequest)
                                                          throws Exception

Handle a dynamic PUT request to the configured path.

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

pathProvider - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request

head

public abstract io.netty.handler.codec.http.FullHttpResponse head(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                  QueryDecoder queryDecoder,
                                                                  PathProvider pathProvider,
                                                                  io.netty.handler.codec.http.HttpRequest httpRequest)
                                                           throws Exception

Handle a dynamic HEAD request to the configured path.

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

pathProvider - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request

options

public abstract io.netty.handler.codec.http.FullHttpResponse options(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                     QueryDecoder queryDecoder,
                                                                     PathProvider pathProvider,
                                                                     io.netty.handler.codec.http.HttpRequest httpRequest)
                                                              throws Exception

Handle a dynamic OPTIONS request to the configured path.

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

pathProvider - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request

patch

public abstract io.netty.handler.codec.http.FullHttpResponse patch(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                   QueryDecoder queryDecoder,
                                                                   PathProvider pathProvider,
                                                                   io.netty.handler.codec.http.HttpRequest httpRequest)
                                                            throws Exception

Handle a dynamic PATCH request to the configured path.

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

pathProvider - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request

trace

public abstract io.netty.handler.codec.http.FullHttpResponse trace(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                   QueryDecoder queryDecoder,
                                                                   PathProvider pathProvider,
                                                                   io.netty.handler.codec.http.HttpRequest httpRequest)
                                                            throws Exception

Handle a dynamic TRACE request to the configured path.

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

pathProvider - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request

post

public abstract io.netty.handler.codec.http.FullHttpResponse post(io.netty.channel.ChannelHandlerContext channelHandlerContext,
                                                                  QueryDecoder queryDecoder,
                                                                  PathProvider pathProvider,
                                                                  io.netty.handler.codec.http.HttpRequest httpRequest)
                                                           throws Exception

Handle a dynamic POST request to the configured path.

Parameters:

channelHandlerContext - the Netty context this request originates from

queryDecoder - a decoder for possible query parameters

pathProvider - a path provider with the provided parameters

httpRequest - the HTTP request that was received and should be handled

Returns:

the full response to the HTTP client

Throws:

Exception - when any error occurred during the handling of the request