Brian Moseley > Wombat > Wombat::Mapper

Download:
Wombat-0.7.1.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Wombat::Mapper - internal mapper interface

SYNOPSIS ^

DESCRIPTION ^

This interface specifies a component that selects a subordinate Container to continue processing a Request for a parent Container, modifying the properties of the Request to reflect the selections made.

A Container may be associated with a single Mapper that processes all requests to that Container or a Mapper for each request protocol that the Container supports.

ACCESSOR METHODS ^

getContainer()

Return the Container with which the Mapper is associated.

setContainer($container)

Set the Container with which the Mapper is associated.

Parameters:

$container

the Wombat::Container used for processing Requests

Throws:

Servlet::Util::IllegalArgumentException

if the Container is not acceptable to this Mapper

getProtocol()

Return the protocol for which this Mapper is responsible.

setProtocol($protocol)

Set the protocol for which this Mapper is responsible.

Parameters:

$protocol

the protocol

PUBLIC METHODS ^

map($request)

Return the child Container that should be used to process the Request, or undef f no such child Container can be identified.

Parameters:

$request

the Wombat::Request being processed

SEE ALSO ^

Wombat::Container, Wombat::Request

AUTHOR ^

Brian Moseley, bcm@maz.org

syntax highlighting: