org.apache.struts.config
Class ForwardConfig
java.lang.Object
org.apache.struts.config.ForwardConfig
- Serializable
public class ForwardConfig
extends java.lang.Object
implements Serializable
A JavaBean representing the configuration information of a
<forward>
element from a Struts
configuration file.
Version:
- Struts 1.1
protected boolean | configured - Has this component been completely configured?
|
protected boolean | contextRelative - Use module property instead; will be removed in a release following 1.2.0.
|
protected String | module - The prefix of the module to which this
ForwardConfig entry points,
which must start with a slash ("/") character.
|
protected String | name - The unique identifier of this forward, which is used to reference it
in
Action classes.
|
protected String | path - The URL to which this
ForwardConfig entry points,
which must start with a slash ("/") character.
|
protected boolean | redirect - Should a redirect be used to transfer control to the specified path?
|
ForwardConfig() - Construct a new instance with default values.
|
ForwardConfig(String name, String path, boolean redirect) - Construct a new instance with the specified values.
|
ForwardConfig(String name, String path, boolean redirect, String module) - Construct a new instance with the specified values.
|
ForwardConfig(String name, String path, boolean redirect, boolean contextRelative) - Use module rather than contextRelative
|
configured
protected boolean configured
Has this component been completely configured?
contextRelative
protected boolean contextRelative
Use module property instead; will be removed in a release following 1.2.0.
Should the value of the path
property be considered
context-relative if it starts with a slash (and therefore not
prefixed with the module prefix?
module
protected String module
The prefix of the module to which this
ForwardConfig
entry points,
which must start with a slash ("/") character.
Usage note: If a forward config is used in a hyperlink,
and a module is specified, the path must lead to another
action and not directly to a page. This is in keeping with
rule that in a modular application all links must be to
an action rather than a page.
name
protected String name
The unique identifier of this forward, which is used to reference it
in Action
classes.
path
protected String path
The URL to which this
ForwardConfig
entry points,
which must start with a slash ("/") character. It is
interpreted according to the following rules:
- If
contextRelative
property is true
, the
path is considered to be context-relative within the current web
application (even if we are in a named module). It will be
prefixed by the context path to create a server-relative URL.
- If the
contextRelative
property is false, the path is
considered to be the module-relative portion of the URL.
It will be used as the replacement for the $P
marker in the forwardPattern
property defined on the
ControllerConfig
element for our current module.
For the default forwardPattern
value of
$C$M$P
, the resulting server-relative URL will be
the concatenation of the context path, the module prefix,
and the path
from this ForwardConfig
.
redirect
protected boolean redirect
Should a redirect be used to transfer control to the specified path?
ForwardConfig
public ForwardConfig()
Construct a new instance with default values.
ForwardConfig
public ForwardConfig(String name,
String path,
boolean redirect)
Construct a new instance with the specified values.
name
- Name of this forwardpath
- Path to which control should be forwarded or redirectedredirect
- Should we do a redirect?
ForwardConfig
public ForwardConfig(String name,
String path,
boolean redirect,
String module)
Construct a new instance with the specified values.
name
- Name of this forwardpath
- Path to which control should be forwarded or redirectedredirect
- Should we do a redirect?module
- Module prefix, if any
ForwardConfig
public ForwardConfig(String name,
String path,
boolean redirect,
boolean contextRelative)
Use module rather than contextRelative
Construct a new instance with the specified values.
name
- Name of this forwardpath
- Path to which control should be forwarded or redirectedredirect
- Should we do a redirect?contextRelative
- Is this path context relative?
freeze
public void freeze()
Freeze the configuration of this component.
getContextRelative
public boolean getContextRelative()
Use module property instead; will be removed in a release following 1.2.0.
getModule
public String getModule()
getName
public String getName()
getPath
public String getPath()
getRedirect
public boolean getRedirect()
setContextRelative
public void setContextRelative(boolean contextRelative)
Use module property instead; will be removed in a release following 1.2.0.
setModule
public void setModule(String module)
setName
public void setName(String name)
setPath
public void setPath(String path)
setRedirect
public void setRedirect(boolean redirect)
toString
public String toString()
Return a String representation of this object.
Copyright © 2000-2005 - The Apache Software Foundation