A B C D E F G H I M N O P R S U

A

AbstractHandlerHook - Class in io.cdap.http

A base implementation of HandlerHook that provides no-op for both HandlerHook.preCall(HttpRequest, HttpResponder, HandlerInfo) and HandlerHook.postCall(HttpRequest, HttpResponseStatus, HandlerInfo) methods.

AbstractHandlerHook() - Constructor for class io.cdap.http.AbstractHandlerHook

AbstractHttpHandler - Class in io.cdap.http

A base implementation of HttpHandler that provides a method for sending a request to other handlers that exist in the same server.

AbstractHttpHandler() - Constructor for class io.cdap.http.AbstractHttpHandler

AbstractHttpResponder - Class in io.cdap.http

Base implementation of HttpResponder to simplify child implementations.

AbstractHttpResponder() - Constructor for class io.cdap.http.AbstractHttpResponder

addContentTypeIfMissing(HttpHeaders, String) - Method in class io.cdap.http.AbstractHttpResponder

AuthHandler - Interface in io.cdap.http

Basic interface for implementing an AuthHandler.

B

BodyConsumer - Class in io.cdap.http

HttpHandler would extend this abstract class and implement methods to stream the body directly.

BodyConsumer() - Constructor for class io.cdap.http.BodyConsumer

BodyProducer - Class in io.cdap.http

Class for producing response body in streaming fashion.

BodyProducer() - Constructor for class io.cdap.http.BodyProducer

build() - Method in class io.cdap.http.NettyHttpService.Builder

build() - Method in class io.cdap.http.SSLConfig.Builder

builder(String) - Static method in class io.cdap.http.NettyHttpService

Creates a NettyHttpService.Builder for creating new instance of NettyHttpService.

Builder(String) - Constructor for class io.cdap.http.NettyHttpService.Builder

builder(File, String) - Static method in class io.cdap.http.SSLConfig

Creates a builder for the SSLConfig.

C

ChannelPipelineModifier - Class in io.cdap.http

This class allows user modify a ChannelPipeline when it gets initialized, which happens on every new channel

ChannelPipelineModifier() - Constructor for class io.cdap.http.ChannelPipelineModifier

chunk(ByteBuf, HttpResponder) - Method in class io.cdap.http.BodyConsumer

Http request content will be streamed directly to this method.

ChunkResponder - Interface in io.cdap.http

A responder for sending chunk-encoded response

close() - Method in interface io.cdap.http.ChunkResponder

Closes this responder which signals the end of the chunk response.

create(ByteBufAllocator) - Method in class io.cdap.http.SSLHandlerFactory

Creates an SslHandler

D

destroy(HandlerContext) - Method in class io.cdap.http.AbstractHttpHandler

destroy(HandlerContext) - Method in interface io.cdap.http.HttpHandler

destroy method will be called before shutdown.

E

enableSSL(SSLConfig) - Method in class io.cdap.http.NettyHttpService.Builder

Enable SSL by using the provided SSL information.

enableSSL(SSLHandlerFactory) - Method in class io.cdap.http.NettyHttpService.Builder

Enable SSL by using the given SSLHandlerFactory to create SslHandler.

ExceptionHandler - Class in io.cdap.http

Handles exceptions and provides a response via the HttpResponder.

ExceptionHandler() - Constructor for class io.cdap.http.ExceptionHandler

F

finished(HttpResponder) - Method in class io.cdap.http.BodyConsumer

This is called on the receipt of the last HttpChunk.

finished() - Method in class io.cdap.http.BodyProducer

This method will get called after the last chunk of the body get sent successfully.

flush() - Method in interface io.cdap.http.ChunkResponder

Flushes all the chunks writen so far to the client asynchronously.

G

getBindAddress() - Method in class io.cdap.http.NettyHttpService

getCertificatePassword() - Method in class io.cdap.http.SSLConfig

getContentLength() - Method in class io.cdap.http.BodyProducer

Returns the size of the content in bytes that this producer is going to produce.

getHttpResourceHandler() - Method in interface io.cdap.http.HandlerContext

getKeyStore() - Method in class io.cdap.http.SSLConfig

getKeyStorePassword() - Method in class io.cdap.http.SSLConfig

getServiceName() - Method in class io.cdap.http.NettyHttpService

getTrustKeyStore() - Method in class io.cdap.http.SSLConfig

getTrustKeyStorePassword() - Method in class io.cdap.http.SSLConfig

getWWWAuthenticateHeader() - Method in interface io.cdap.http.AuthHandler

Returns the value for the WWW-Authenticate header field that will be set for requests which were rejected by AuthHandler.isAuthenticated(HttpRequest) or AuthHandler.hasRoles(HttpRequest, String[]).

H

handle(Throwable, HttpRequest, HttpResponder) - Method in class io.cdap.http.ExceptionHandler

handleError(Throwable) - Method in class io.cdap.http.BodyConsumer

When there is exception on netty while streaming, it will be propagated to handler so the handler can do the cleanup.

handleError(Throwable) - Method in class io.cdap.http.BodyProducer

This method will get called if there is any error raised when sending body chunks.

HandlerContext - Interface in io.cdap.http

Place holder for information about the environment.

HandlerHook - Interface in io.cdap.http

Interface that needs to be implemented to intercept handler method calls.

hasRoles(HttpRequest, String[]) - Method in interface io.cdap.http.AuthHandler

This method is responsible for deciding whether a request meets the role requirement.

HttpHandler - Interface in io.cdap.http

Interface that needs to be implemented for handling HTTP methods.

HttpResponder - Interface in io.cdap.http

HttpResponder is used to send response back to clients.

I

init(HandlerContext) - Method in class io.cdap.http.AbstractHttpHandler

init(HandlerContext) - Method in interface io.cdap.http.HttpHandler

init method will be called before the netty pipeline is setup.

io.cdap.http - package io.cdap.http

Service and components to build Netty based Http web service.

isAuthenticated(HttpRequest) - Method in interface io.cdap.http.AuthHandler

This method is responsible for deciding whether a request is authenticated.

isSSLEnabled() - Method in class io.cdap.http.NettyHttpService

M

modify(ChannelPipeline) - Method in class io.cdap.http.ChannelPipelineModifier

Modifies the given ChannelPipeline.

N

NettyHttpService - Class in io.cdap.http

Webservice implemented using the netty framework.

NettyHttpService.Builder - Class in io.cdap.http

Builder to help create the NettyHttpService.

nextChunk() - Method in class io.cdap.http.BodyProducer

Returns a ByteBuf representing the next chunk of bytes to send.

O

OCTET_STREAM_TYPE - Static variable in class io.cdap.http.AbstractHttpResponder

P

postCall(HttpRequest, HttpResponseStatus, HandlerInfo) - Method in class io.cdap.http.AbstractHandlerHook

postCall(HttpRequest, HttpResponseStatus, HandlerInfo) - Method in interface io.cdap.http.HandlerHook

postCall is run after a handler method call is made.

preCall(HttpRequest, HttpResponder, HandlerInfo) - Method in class io.cdap.http.AbstractHandlerHook

preCall(HttpRequest, HttpResponder, HandlerInfo) - Method in interface io.cdap.http.HandlerHook

preCall is run before a handler method call is made.

R

RequiredRoles - Annotation Type in io.cdap.http

Indicates that the annotated method should only be called if the requesting HttpRequest was deemed authorized by the registered's AuthHandler.hasRoles(io.netty.handler.codec.http.HttpRequest, String[]) method.

rewrite(HttpRequest, HttpResponder) - Method in interface io.cdap.http.URLRewriter

Implement this to rewrite URL of an incoming request.

S

Secured - Annotation Type in io.cdap.http

Indicates that the annotated method should only be called if the requesting HttpRequest was deemed authenticated by the registered's AuthHandler.isAuthenticated(io.netty.handler.codec.http.HttpRequest) method.

sendByteArray(HttpResponseStatus, byte[], HttpHeaders) - Method in class io.cdap.http.AbstractHttpResponder

sendByteArray(HttpResponseStatus, byte[], HttpHeaders) - Method in interface io.cdap.http.HttpResponder

Send a response containing raw bytes.

sendBytes(HttpResponseStatus, ByteBuffer, HttpHeaders) - Method in class io.cdap.http.AbstractHttpResponder

sendBytes(HttpResponseStatus, ByteBuffer, HttpHeaders) - Method in interface io.cdap.http.HttpResponder

Sends a response containing raw bytes.

sendChunk(ByteBuffer) - Method in interface io.cdap.http.ChunkResponder

Adds a chunk of data to the response.

sendChunk(ByteBuf) - Method in interface io.cdap.http.ChunkResponder

Adds a chunk of data to the response.

sendChunkStart(HttpResponseStatus) - Method in class io.cdap.http.AbstractHttpResponder

sendChunkStart(HttpResponseStatus) - Method in interface io.cdap.http.HttpResponder

Respond to the client saying the response will be in chunks.

sendChunkStart(HttpResponseStatus, HttpHeaders) - Method in interface io.cdap.http.HttpResponder

Respond to the client saying the response will be in chunks.

sendContent(HttpResponseStatus, ByteBuf, HttpHeaders) - Method in interface io.cdap.http.HttpResponder

Send response back to client.

sendContent(HttpResponseStatus, BodyProducer, HttpHeaders) - Method in interface io.cdap.http.HttpResponder

Sends response back to client.

sendFile(File) - Method in class io.cdap.http.AbstractHttpResponder

sendFile(File) - Method in interface io.cdap.http.HttpResponder

Sends a file content back to client with response status 200 with content type as "application/octet-stream".

sendFile(File, HttpHeaders) - Method in interface io.cdap.http.HttpResponder

Sends a file content back to client with response status 200.

sendInternalRequest(HttpRequest) - Method in class io.cdap.http.AbstractHttpHandler

Send a request to another handler internal to the server, getting back the response body and response code.

sendJson(HttpResponseStatus, String) - Method in class io.cdap.http.AbstractHttpResponder

sendJson(HttpResponseStatus, String) - Method in interface io.cdap.http.HttpResponder

Sends json response back to the client.

sendStatus(HttpResponseStatus) - Method in class io.cdap.http.AbstractHttpResponder

sendStatus(HttpResponseStatus, HttpHeaders) - Method in class io.cdap.http.AbstractHttpResponder

sendStatus(HttpResponseStatus) - Method in interface io.cdap.http.HttpResponder

Send only a status code back to client without any content.

sendStatus(HttpResponseStatus, HttpHeaders) - Method in interface io.cdap.http.HttpResponder

Send only a status code back to client without any content.

sendString(HttpResponseStatus, String) - Method in class io.cdap.http.AbstractHttpResponder

sendString(HttpResponseStatus, String, HttpHeaders) - Method in class io.cdap.http.AbstractHttpResponder

sendString(HttpResponseStatus, String) - Method in interface io.cdap.http.HttpResponder

Send a string response in UTF-8 encoding back to the http client.

sendString(HttpResponseStatus, String, HttpHeaders) - Method in interface io.cdap.http.HttpResponder

Send a string response in UTF-8 encoding back to the http client.

setAuthHandler(AuthHandler) - Method in class io.cdap.http.NettyHttpService.Builder

Add the AuthHandler that performs the checks for methods annotated by Secured and RequiredRoles.

setBossThreadPoolSize(int) - Method in class io.cdap.http.NettyHttpService.Builder

Set size of bossThreadPool in netty default value is 1 if it is not set.

setCertificatePassword(String) - Method in class io.cdap.http.SSLConfig.Builder

Set the certificate password for KeyStore.

setChannelConfig(ChannelOption<?>, Object) - Method in class io.cdap.http.NettyHttpService.Builder

Sets channel configuration for the netty service.

setChannelPipelineModifier(ChannelPipelineModifier) - Method in class io.cdap.http.NettyHttpService.Builder

Sets the ChannelPipelineModifier to use for modifying ChannelPipeline on new Channel registration.

setChildChannelConfig(ChannelOption<?>, Object) - Method in class io.cdap.http.NettyHttpService.Builder

Sets channel configuration for the child socket channel for the netty service.

setConnectionBacklog(int) - Method in class io.cdap.http.NettyHttpService.Builder

Set size of backlog in netty service - size of accept queue of the TCP stack.

setExceptionHandler(ExceptionHandler) - Method in class io.cdap.http.NettyHttpService.Builder

Set the ExceptionHandler for the service.

setExecThreadKeepAliveSeconds(long) - Method in class io.cdap.http.NettyHttpService.Builder

Set the maximum time that excess idle threads will wait for new tasks before terminating.

setExecThreadPoolSize(int) - Method in class io.cdap.http.NettyHttpService.Builder

Set size of executorThreadPool in netty default value is 60 if it is not set.

setHandlerHooks(Iterable<? extends HandlerHook>) - Method in class io.cdap.http.NettyHttpService.Builder

Set HandlerHooks to be executed pre and post handler calls.

setHost(String) - Method in class io.cdap.http.NettyHttpService.Builder

Set the bindAddress for the service.

setHttpChunkLimit(int) - Method in class io.cdap.http.NettyHttpService.Builder

Set the HTTP chunk limit.

setHttpHandlers(Iterable<? extends HttpHandler>) - Method in class io.cdap.http.NettyHttpService.Builder

Add HttpHandlers that service the request.

setHttpHandlers(HttpHandler...) - Method in class io.cdap.http.NettyHttpService.Builder

Add HttpHandlers that service the request.

setPort(int) - Method in class io.cdap.http.NettyHttpService.Builder

Set the port on which the service should listen to.

setRejectedExecutionHandler(RejectedExecutionHandler) - Method in class io.cdap.http.NettyHttpService.Builder

Set RejectedExecutionHandler - rejection policy for executor.

setTrustKeyStore(File) - Method in class io.cdap.http.SSLConfig.Builder

Set trust KeyStore file.

setTrustKeyStorePassword(String) - Method in class io.cdap.http.SSLConfig.Builder

Set trust KeyStore password.

setUrlRewriter(URLRewriter) - Method in class io.cdap.http.NettyHttpService.Builder

Set URLRewriter to re-write URL of an incoming request before any handlers or their hooks are called.

setWorkerThreadPoolSize(int) - Method in class io.cdap.http.NettyHttpService.Builder

Set size of workerThreadPool in netty default value is 10 if it is not set.

SSLConfig - Class in io.cdap.http

A class that encapsulates SSLContext configuration.

SSLConfig.Builder - Class in io.cdap.http

Builder to help create the SSLConfig.

SSLHandlerFactory - Class in io.cdap.http

A class that encapsulates SSL Certificate Information.

SSLHandlerFactory(SSLConfig) - Constructor for class io.cdap.http.SSLHandlerFactory

SSLHandlerFactory(SslContext) - Constructor for class io.cdap.http.SSLHandlerFactory

start() - Method in class io.cdap.http.NettyHttpService

Starts the HTTP service.

stop() - Method in class io.cdap.http.NettyHttpService

Stops the HTTP service gracefully and release all resources.

stop(long, long, TimeUnit) - Method in class io.cdap.http.NettyHttpService

Stops the HTTP service gracefully and release all resources.

U

URLRewriter - Interface in io.cdap.http

Re-writes URL of an incoming request before any handlers or their hooks are called.

A B C D E F G H I M N O P R S U