org.mmbase.servlet

Class JamesServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.mmbase.servlet.MMBaseServlet

org.mmbase.servlet.JamesServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, MMBaseStarter

Direct Known Subclasses:

servdb, servflash, servjumpers, servscan, SimpleFormToMailServlet

public class JamesServlet
extends MMBaseServlet

JamesServlet is a adaptor class. It is used to extend the basic Servlet to provide services not found in suns Servlet API.

Version:

$Id$

Author:

vpro

See Also:

Serialized Form

Application:

SCAN - the cookie code is specific for SCAN

Dependency:

this code relies on HttpAuth for its authorization. This should be done through the MMBase security.

Duplicate:

this code is aimed at the SCAN servlets, and some features (i.e. cookies) do not communicate well with jsp pages. Functionality might need to be moved or adapted so that it uses the MMCI.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	pageLog

Fields inherited from class org.mmbase.servlet.MMBaseServlet

mmbase, retryAfter

Constructor Summary

Constructors

Constructor and Description
JamesServlet()

Method Summary

Modifier and Type	Method and Description
String	getAddress(javax.servlet.http.HttpServletRequest req) Extract hostname from request, get address and determine the proxies between it.
String	getAuthorization(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Try to get the default authorisation
String	getAuthorization(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String server, String level) Authenticates a user, If the user cannot be authenticated a login-popup will appear
String	getCookie(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) This method retrieves the users' MMBase cookie name & value as 'name/value'.
protected Hashtable	getInitParameters() Retrieves all initialization parameters.
protected Object	getModule(String name) Retrieves a module.
String	getParam(javax.servlet.http.HttpServletRequest req, int num) Get the parameter specified.
Vector	getParamVector(javax.servlet.http.HttpServletRequest req) Get the Vector containing all parameters
protected Hashtable	getProperties(String name) Gets properties.
protected String	getProperty(String name, String var) Gets a property out of the Environment.
void	init() Initializes the servlet.

Methods inherited from class org.mmbase.servlet.MMBaseServlet

associateMapping, checkInited, decRefCount, destroy, doGet, getAssociations, getBasePath, getMMBase, getRequestURL, getServletByAssociation, getServletByMapping, getServletInfo, getServletMappings, getServletMappingsByAssociation, incRefCount, service, setInitException, setMMBase

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

pageLog

protected static Logger pageLog

Constructor Detail

JamesServlet

public JamesServlet()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Initializes the servlet.

Overrides:

init in class MMBaseServlet

Throws:

javax.servlet.ServletException

getModule

protected final Object getModule(String name)

Retrieves a module. Creates the module if it hasn't been created yet (but does not initialize).

Parameters:

name - the name of the module to retrieve

Returns:

the Module, or null if it doesn't exist.

To Do:

type returned should be Module

getInitParameters

protected final Hashtable getInitParameters()

Retrieves all initialization parameters. Note: overides the normal way to set init params in javax.

getProperties

protected final Hashtable getProperties(String name)

Gets properties. If allowed.

getProperty

protected final String getProperty(String name,
                                   String var)

Gets a property out of the Environment. If allowed

getAuthorization

public String getAuthorization(javax.servlet.http.HttpServletRequest req,
                               javax.servlet.http.HttpServletResponse res)
                        throws AuthorizationException,
                               NotLoggedInException

Try to get the default authorisation

Parameters:

req - The HttpServletRequest.

res - The HttpServletResponse.

Throws:

AuthorizationException - if the authorization fails.

NotLoggedInException - if the user hasn't logged in yet.

Deprecation-used:

should call Security, not HttpAuth

getAuthorization

public String getAuthorization(javax.servlet.http.HttpServletRequest req,
                               javax.servlet.http.HttpServletResponse res,
                               String server,
                               String level)
                        throws AuthorizationException,
                               NotLoggedInException

Authenticates a user, If the user cannot be authenticated a login-popup will appear

Parameters:

req - The HttpServletRequest.

res - The HttpServletResponse.

server - server-account. (for exameple 'film' or 'www')

level - loginlevel. (for example 'Basic' or 'MD5')

Throws:

AuthorizationException - if the authorization fails.

NotLoggedInException - if the user hasn't logged in yet.

Deprecation-used:

should call Security, not HttpAuth

getCookie

public String getCookie(javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse res)

This method retrieves the users' MMBase cookie name & value as 'name/value'. When the cookie can't be found, a new cookie will be added. The cookies domain will be implicit or explicit depending on the MMBASEROOT.properties value.

Parameters:

req - The HttpServletRequest.

res - The HttpServletResponse.

Returns:

A String with the users' MMBase cookie as 'name/value' or null when MMBase core module can't be found, or when the MMBase cookie is located but can't be retrieved from the cookies list.

Dependency:

org.mmbase.module.builder.Properties should not depend on this builder ?

getParam

public String getParam(javax.servlet.http.HttpServletRequest req,
                       int num)

Get the parameter specified.

Parameters:

req - The HttpServletRequest.

getParamVector

public Vector getParamVector(javax.servlet.http.HttpServletRequest req)

Get the Vector containing all parameters

Parameters:

req - The HttpServletRequest.

getAddress

public String getAddress(javax.servlet.http.HttpServletRequest req)

Extract hostname from request, get address and determine the proxies between it. Needed to determine if user comes from an internal or external host, i.e. when using two streaming servers, one for external users and one for internal users.

Parameters:

req - The HTTP request, which contains hostname as ipaddress

Returns:

a string containing the proxy chain. in the format "clientproxy.clientside.com->dialin07.clientside.com"

Javadoc:

Vpro:

uses VPROProxyName, VPROProxyAddress. Should be made more generic.