de.dytanic.cloudnet.web.server.handler

Class WebHandler

java.lang.Object

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

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

MethodWebHandler

public abstract class WebHandler
extends Object
implements Cloneable

Abstract class that handles web requests for a given path.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	path

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
WebHandler	clone()
String	getPath()
abstract io.netty.handler.codec.http.FullHttpResponse	handleRequest(io.netty.channel.ChannelHandlerContext channelHandlerContext, QueryDecoder queryDecoder, PathProvider pathProvider, io.netty.handler.codec.http.HttpRequest httpRequest) Handle a request to the configured path.
io.netty.handler.codec.http.FullHttpResponse	newResponse(io.netty.handler.codec.http.HttpVersion httpVersion) Deprecated.
io.netty.handler.codec.http.FullHttpResponse	newResponse(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.buffer.ByteBuf content) Creates and returns a new HTTP 404 - Not found response with content

Methods inherited from class java.lang.Object

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

Field Detail

path

protected final String path

Constructor Detail

WebHandler

protected WebHandler(String path)

Constructs a new web handler for a given path.

Parameters:

path - the path where this handler is available.

Method Detail

getPath

public String getPath()

handleRequest

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

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

newResponse

@Deprecated
public io.netty.handler.codec.http.FullHttpResponse newResponse(io.netty.handler.codec.http.HttpVersion httpVersion)

Deprecated.

Creates and returns a new HTTP 404 - Not found response without content

Parameters:

httpVersion - the HTTP version to use

Returns:

an HTTP 404 response

newResponse

public io.netty.handler.codec.http.FullHttpResponse newResponse(io.netty.handler.codec.http.HttpVersion httpVersion,
                                                                io.netty.buffer.ByteBuf content)

Creates and returns a new HTTP 404 - Not found response with content

Parameters:

httpVersion - the HTTP version to use

content - the content to put inside the code 404 response

Returns:

an HTTP 404 response with content

clone

public WebHandler clone()
                 throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException