de.dytanic.cloudnet.web.server.handler

Class MethodWebHandler

java.lang.Object

de.dytanic.cloudnet.web.server.handler.WebHandler

de.dytanic.cloudnet.web.server.handler.MethodWebHandler

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

MethodWebHandlerAdapter

public abstract class MethodWebHandler
extends WebHandler

Abstract web handler that uses separate methods for each of the common HTTP methods.

Field Summary

Fields inherited from class de.dytanic.cloudnet.web.server.handler.WebHandler

path

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MethodWebHandler(String path) Constructs a new method web handler for a given path.

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 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 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 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 request to the configured path.
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 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 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 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 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 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 TRACE request to the configured path.

Methods inherited from class de.dytanic.cloudnet.web.server.handler.WebHandler

clone, getPath, newResponse, newResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodWebHandler

protected MethodWebHandler(String path)

Constructs a new method web handler for a given path.

Parameters:

path - the path where this handler is available.

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: WebHandler

Handle a request to the configured path.

Specified by:

handleRequest in class WebHandler

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