Package rife.engine

Class Gate

java.lang.Object

rife.engine.Gate

public class Gate
extends Object

Main entry class into the RIFE2 web engine, used both by the servlet engine and the out of container testing API.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
Gate()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Tears down the gate and the associated Site.
Site	getSite()	Retrieves the Site of this gate.
boolean	handleRequest(String gateUrl, String elementUrl, Request request, Response response)	Handle the web request with the provided arguments.
void	setup(HierarchicalProperties properties, Site site)	Set up the gate with the provided Site.

Methods inherited from class java.lang.Object

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

Constructor Details

Gate

public Gate()

Method Details

setup

public void setup(HierarchicalProperties properties,
 Site site)

Set up the gate with the provided Site.

Parameters:

properties - the parent hierarchical properties

site - the site that will handle the requests

Since:

1.0

destroy

public void destroy()

Tears down the gate and the associated Site.

Since:

1.6.1

getSite

public Site getSite()

Retrieves the Site of this gate.

Returns:

this gate's site

Since:

1.6.1

handleRequest

public boolean handleRequest(String gateUrl,
 String elementUrl,
 Request request,
 Response response)

Handle the web request with the provided arguments.

Parameters:

gateUrl - the part of the URL that corresponds to the root of the gate, typically the webapp context URL

elementUrl - the part of the URL after the gateUrl that will be resolved to find the execution element

request - the request instance of this web request

response - the response instance of this web request

Returns:

true if the request was successfully handled; or false otherwise

Since:

1.0