de.dytanic.cloudnet.web.server.handler

Class MethodWebHandlerAdapter

java.lang.Object

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

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

de.dytanic.cloudnet.web.server.handler.MethodWebHandlerAdapter

All Implemented Interfaces:

Cloneable

public class MethodWebHandlerAdapter
extends MethodWebHandler

Adapter for the method web handler. Returns null by default.

Field Summary

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

path

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
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.
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	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.
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.
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.
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.
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.
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.MethodWebHandler

handleRequest

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

MethodWebHandlerAdapter

protected MethodWebHandlerAdapter(String path)

Constructs a new method web handler adapter for a given path.

Parameters:

path - the path where this handler is available.

Method Detail

connect

public 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

Description copied from class: MethodWebHandler

Handle a CONNECT request to the configured path.

Specified by:

connect in class MethodWebHandler

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

Description copied from class: MethodWebHandler

Handle a DELETE request to the configured path.

Specified by:

delete in class MethodWebHandler

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

Description copied from class: MethodWebHandler

Handle a GET request to the configured path.

Specified by:

get in class MethodWebHandler

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

Description copied from class: MethodWebHandler

Handle a PUT request to the configured path.

Specified by:

put in class MethodWebHandler

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

Description copied from class: MethodWebHandler

Handle a HEAD request to the configured path.

Specified by:

head in class MethodWebHandler

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

Description copied from class: MethodWebHandler

Handle a OPTIONS request to the configured path.

Specified by:

options in class MethodWebHandler

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

Description copied from class: MethodWebHandler

Handle a PATCH request to the configured path.

Specified by:

patch in class MethodWebHandler

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

Description copied from class: MethodWebHandler

Handle a TRACE request to the configured path.

Specified by:

trace in class MethodWebHandler

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

Description copied from class: MethodWebHandler

Handle a POST request to the configured path.

Specified by:

post in class MethodWebHandler

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