Package com.opensymphony.module.sitemesh.mapper

Class AgentDecoratorMapper

java.lang.Object

com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

com.opensymphony.module.sitemesh.mapper.AgentDecoratorMapper

All Implemented Interfaces:

DecoratorMapper

public class AgentDecoratorMapper
extends AbstractDecoratorMapper

The AgentDecoratorMapper can determine the user-agent (i.e. web-browser) requesting a page, and map to a suitable Decorator.

This can be useful for supplying different versions of the same content for different browsers (e.g. vanilla HTML for Lynx, complex tables and frames for Netscape, extra stuff for IE5, etc).

This can also be used to enhance search-engine ratings by using a 'bait and switch' system - this involves showing a search-engine friendly of the content to spiders only.

When AgentDecoratorMapper is in the chain, it will request the appropriate Decorator from its parent. It will then add an extention to the filename of the Decorator, and if that file exists it shall be used as the Decorator instead. For example, if the Decorator path is /blah.jsp and the detected user-agent is ie, the path /blah-ie.jsp shall be used.

The agent mappings are configured by passing properties with match. as a prefix. For example: 'match.MSIE'=ie , 'match.Lynx'=plain .

Author:

Joe Walnes

See Also:

• DecoratorMapper

Field Summary

Fields inherited from class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

config, parent

Constructor Summary

Constructors

Constructor	Description
AgentDecoratorMapper()

Method Summary

Modifier and Type	Method	Description
Decorator	getDecorator(javax.servlet.http.HttpServletRequest request, Page page)	Return appropriate Decorator for a certain Page.
void	init(Config config, Properties properties, DecoratorMapper parent)	Initialize the mapper.

Methods inherited from class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

getNamedDecorator

Methods inherited from class java.lang.Object

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

Constructor Details

AgentDecoratorMapper

public AgentDecoratorMapper()

Method Details

init

public void init(Config config,
 Properties properties,
 DecoratorMapper parent)
          throws InstantiationException

Description copied from interface: DecoratorMapper

Initialize the mapper. This is always called before the other methods.

Specified by:

init in interface DecoratorMapper

Overrides:

init in class AbstractDecoratorMapper

Parameters:

config - Config supplied by Servlet or Filter.

properties - Any initialization properties (specific to implementation).

parent - the parent

Throws:

InstantiationException - the instantiation exception

getDecorator

public Decorator getDecorator(javax.servlet.http.HttpServletRequest request,
 Page page)

Description copied from interface: DecoratorMapper

Return appropriate Decorator for a certain Page.

The implementation can determine the result based on the actual request or the data of the parsed page. Typically this would call getNamedDecorator() which would delegate to a parent DecoratorMapper.

Specified by:

getDecorator in interface DecoratorMapper

Overrides:

getDecorator in class AbstractDecoratorMapper

Parameters:

request - the request

page - the page

Returns:

the decorator