org.apache.jetspeed.services.forward
Class ForwardTool

java.lang.Object
  org.apache.jetspeed.services.forward.ForwardTool

All Implemented Interfaces:

org.apache.turbine.services.pull.ApplicationTool

public class ForwardTool

extends java.lang.Object

implements org.apache.turbine.services.pull.ApplicationTool

Provides a tool interface to forwards

Version:

$Id: ForwardTool.java,v 1.5 2004/02/23 03:51:09 jford Exp $

Author:

David Sean Taylor

Constructor Summary

ForwardTool()

Method Summary

org.apache.turbine.util.DynamicURI	forward(java.lang.String forwardName) Forward to a specific forward by name.
org.apache.turbine.util.DynamicURI	forward(java.lang.String portlet, java.lang.String target) For the given portlet and given action, forward to the target defined in the forward configuration for the portlet + action.
void	init(java.lang.Object data) This will initialise a JetspeedLink object that was constructed with the default constructor (ApplicationTool method).
void	refresh() Refresh method - does nothing

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardTool

public ForwardTool()

Method Detail

forward

public org.apache.turbine.util.DynamicURI forward(java.lang.String forwardName)

Forward to a specific forward by name.

Returns:

DynamicURI the full link to the referenced page

forward

public org.apache.turbine.util.DynamicURI forward(java.lang.String portlet,
                                                  java.lang.String target)

For the given portlet and given action, forward to the target defined in the forward configuration for the portlet + action.

Parameters:

portlet - The name of the portlet for which we are forwarding.

target - A logical target name. Portlets can have 1 or more targets.

Returns:

DynamicURI the full link to the referenced page

init

public void init(java.lang.Object data)

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

Specified by:

init in interface org.apache.turbine.services.pull.ApplicationTool

Parameters:

data - assumed to be a RunData object

refresh

public void refresh()

Refresh method - does nothing

Specified by:

refresh in interface org.apache.turbine.services.pull.ApplicationTool