Package spark

Class FilterImpl

java.lang.Object

spark.FilterImpl

All Implemented Interfaces:

Filter, Wrapper

public abstract class FilterImpl
extends java.lang.Object
implements Filter, Wrapper

FilterImpl is created from a path, acceptType and Filter. This is encapsulate the information needed in the route matcher in a single container.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	acceptType
(package private) static java.lang.String	DEFAULT_ACCEPT_TYPE
private Filter	delegate
private java.lang.String	path

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FilterImpl(java.lang.String path, java.lang.String acceptType)
protected	FilterImpl(java.lang.String path, java.lang.String acceptType, Filter filter)

Method Summary

Modifier and Type	Method	Description
(package private) static FilterImpl	create(java.lang.String path, java.lang.String acceptType, Filter filter)	Wraps the filter in FilterImpl
(package private) static FilterImpl	create(java.lang.String path, Filter filter)	Wraps the filter in FilterImpl
java.lang.Object	delegate()
java.lang.String	getAcceptType()
java.lang.String	getPath()	Returns this route's path
abstract void	handle(Request request, Response response)	Invoked when a request is made on this filter's corresponding path e.g.
FilterImpl	withPrefix(java.lang.String prefix)	Prefix the path (used for Service.path(java.lang.String, spark.RouteGroup))

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ACCEPT_TYPE

static final java.lang.String DEFAULT_ACCEPT_TYPE

See Also:

Constant Field Values

path

private java.lang.String path

acceptType

private java.lang.String acceptType

delegate

private Filter delegate

Constructor Detail

FilterImpl

protected FilterImpl(java.lang.String path,
                     java.lang.String acceptType)

FilterImpl

protected FilterImpl(java.lang.String path,
                     java.lang.String acceptType,
                     Filter filter)

Method Detail

withPrefix

public FilterImpl withPrefix(java.lang.String prefix)

Prefix the path (used for Service.path(java.lang.String, spark.RouteGroup))

Parameters:

prefix - the prefix

Returns:

itself for easy chaining

create

static FilterImpl create(java.lang.String path,
                         Filter filter)

Wraps the filter in FilterImpl

Parameters:

path - the path

filter - the filter

Returns:

the wrapped route

create

static FilterImpl create(java.lang.String path,
                         java.lang.String acceptType,
                         Filter filter)

Wraps the filter in FilterImpl

Parameters:

path - the path

acceptType - the accept type

filter - the filter

Returns:

the wrapped route

handle

public abstract void handle(Request request,
                            Response response)
                     throws java.lang.Exception

Invoked when a request is made on this filter's corresponding path e.g. '/hello'

Specified by:

handle in interface Filter

Parameters:

request - The request object providing information about the HTTP request

response - The response object providing functionality for modifying the response

Throws:

java.lang.Exception - when handle fails

getAcceptType

public java.lang.String getAcceptType()

getPath

public java.lang.String getPath()

Returns this route's path

delegate

public java.lang.Object delegate()

Specified by:

delegate in interface Wrapper

Returns:

the filter used to create the filter implementation