org.apache.struts.config
public class ForwardConfig extends Object implements Serializable
A JavaBean representing the configuration information of a
<forward>
element from a Struts
configuration file.
Since: Struts 1.1
Version: $Rev: 55980 $ $Date: 2004-10-29 16:34:55 +0100 (Fri, 29 Oct 2004) $
Field Summary | |
---|---|
protected boolean | configured
Has this component been completely configured? |
protected boolean | contextRelative
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? |
protected String | module The prefix of the module to which this |
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 |
protected boolean | redirect
Should a redirect be used to transfer control to the specified path? |
Constructor Summary | |
---|---|
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, boolean contextRelative)
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. |
Method Summary | |
---|---|
void | freeze()
Freeze the configuration of this component. |
boolean | getContextRelative() |
String | getModule() |
String | getName() |
String | getPath() |
boolean | getRedirect() |
void | setContextRelative(boolean contextRelative) |
void | setModule(String module) |
void | setName(String name) |
void | setPath(String path) |
void | setRedirect(boolean redirect) |
String | toString()
Return a String representation of this object. |
Deprecated: Use module property instead; will be removed in a release following 1.2.0.
Should the value of thepath
property be considered
context-relative if it starts with a slash (and therefore not
prefixed with the module prefix?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.
Action
classes.The URL to which this ForwardConfig
entry points,
which must start with a slash ("/") character. It is
interpreted according to the following rules:
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.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
.Parameters: name Name of this forward path Path to which control should be forwarded or redirected redirect Should we do a redirect?
Deprecated: Use module rather than contextRelative
Construct a new instance with the specified values.Parameters: name Name of this forward path Path to which control should be forwarded or redirected redirect Should we do a redirect? contextRelative Is this path context relative?
Construct a new instance with the specified values.
Parameters: name Name of this forward path Path to which control should be forwarded or redirected redirect Should we do a redirect? module Module prefix, if any
Deprecated: Use module property instead; will be removed in a release following 1.2.0.
Deprecated: Use module property instead; will be removed in a release following 1.2.0.