Package org.apache.turbine.services.pull.tools

Klasse ContentTool

java.lang.Object

org.apache.turbine.services.pull.tools.ContentTool

Alle implementierten Schnittstellen:

ApplicationTool

public class ContentTool
extends Object
implements ApplicationTool

Terribly simple tool to translate URIs into Turbine Links. Equivalent to URIUtils.getAbsoluteLink() in a pull tool.

If you're missing any routines from the 'old' $content tool concerning path_info or query data, you did use the wrong tool then. You should've used the TemplateLink tool which should be available as "$link" in your context.

This is an application pull tool for the template system. You should not use it in a normal application!

Version:

$Id$

Autor:

Henning P. Schmiedehausen, Peter Courcoux

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final boolean	CONTENT_TOOL_ENCODING_DEFAULT	Default Value for CONTENT_TOOL_ENCODING_KEY
static final String	CONTENT_TOOL_ENCODING_KEY	Should this tool add Container Encoding to the URIs returned?
static final String	CONTENT_TOOL_PREFIX	Prefix for Parameters for this tool
static final boolean	CONTENT_TOOL_RELATIVE_DEFAULT	Default Value for CONTENT_TOOL_RELATIVE_KEY
static final String	CONTENT_TOOL_RELATIVE_KEY	Should this tool return relative URIs or absolute?

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ContentTool()	C'tor

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	getAbsoluteURI(String path)	Returns the Turbine URI of a given Path.
String	getRelativeURI(String path)	Returns the Turbine URI of a given Path.
String	getURI(String path)	Returns the Turbine URI of a given Path
void	init(Object data)	This will initialize a ContentTool object that was constructed with the default constructor (ApplicationTool method).
void	refresh()	Refresh method - does nothing

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

CONTENT_TOOL_PREFIX

public static final String CONTENT_TOOL_PREFIX

Prefix for Parameters for this tool

Siehe auch:

• Konstantenfeldwerte

CONTENT_TOOL_ENCODING_KEY

public static final String CONTENT_TOOL_ENCODING_KEY

Should this tool add Container Encoding to the URIs returned? True might cause trouble e.g. if you run with Apache HTTP Daemon / Tomcat Combo. Default is false (like Turbine 2.2)

Siehe auch:

• Konstantenfeldwerte

CONTENT_TOOL_ENCODING_DEFAULT

public static final boolean CONTENT_TOOL_ENCODING_DEFAULT

Default Value for CONTENT_TOOL_ENCODING_KEY

Siehe auch:

• Konstantenfeldwerte

CONTENT_TOOL_RELATIVE_KEY

public static final String CONTENT_TOOL_RELATIVE_KEY

Should this tool return relative URIs or absolute? Default: Absolute.

Siehe auch:

• Konstantenfeldwerte

CONTENT_TOOL_RELATIVE_DEFAULT

public static final boolean CONTENT_TOOL_RELATIVE_DEFAULT

Default Value for CONTENT_TOOL_RELATIVE_KEY

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

ContentTool

public ContentTool()

C'tor

Methodendetails

init

public void init(Object data)

This will initialize a ContentTool object that was constructed with the default constructor (ApplicationTool method).

Angegeben von:

init in Schnittstelle ApplicationTool

Parameter:

data - assumed to be a PipelineData object

refresh

public void refresh()

Refresh method - does nothing

Angegeben von:

refresh in Schnittstelle ApplicationTool

getURI

public String getURI(String path)

Returns the Turbine URI of a given Path

Parameter:

path - The path to translate

Gibt zurück:

Turbine translated absolute path

getAbsoluteURI

public String getAbsoluteURI(String path)

Returns the Turbine URI of a given Path. The result is always an absolute path starting with the server scheme (http/https).

Parameter:

path - The path to translate

Gibt zurück:

Turbine translated absolute path

getRelativeURI

public String getRelativeURI(String path)

Returns the Turbine URI of a given Path. The result is always relative to the context of the application.

Parameter:

path - The path to translate

Gibt zurück:

Turbine translated absolute path