spark

Class Filter

java.lang.Object

spark.AbstractRoute

spark.Filter

public abstract class Filter
extends AbstractRoute

A Filter is built up by a path (for url-matching) and the implementation of the 'handle' method. When a request is made, if present, the matching routes 'handle' method is invoked.

Author:

Per Wendel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Filter() Constructs a filter that matches on everything
protected	Filter(String path) Constructor
protected	Filter(String path, String acceptType)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAcceptType()
abstract void	handle(Request request, Response response) Invoked when a request is made on this filter's corresponding path e.g.

Methods inherited from class spark.AbstractRoute

halt, halt, halt, halt

Methods inherited from class java.lang.Object

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

Constructor Detail

Filter

protected Filter()

Constructs a filter that matches on everything

Filter

protected Filter(String path)

Constructor

Parameters:

path - The filter path which is used for matching. (e.g. /hello, users/:name)

Filter

protected Filter(String path,
      String acceptType)

Method Detail

handle

public abstract void handle(Request request,
          Response response)

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

Parameters:

request - The request object providing information about the HTTP request

response - The response object providing functionality for modifying the response

getAcceptType

public String getAcceptType()