| java.lang.Object
 org.apache.struts.config.BaseConfig
org.apache.struts.config.ForwardConfig
All known Subclasses: org.apache.struts.action.ActionForward,
| ForwardConfig | | public class ForwardConfig extends BaseConfig (Code) | | A JavaBean representing the configuration information of a
<forward> element from a Struts configuration file.
version:
$Rev: 471754 $ $Date: 2005-08-14 17:24:39 -0400 (Sun, 14 Aug 2005)
version:
$
since:
Struts 1.1 |
| Field Summary | |
| protected String | catalog
The name of a commons-chain catalog in which
command should be looked up. | | protected String | command
| | protected boolean | extensionProcessed
| | protected String | inherit
The name of the ForwardConfig that this object should inherit
properties from. | | 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
|
| catalog | | protected String catalog(Code) | | The name of a commons-chain catalog in which
command should be looked up. If this value is undefined,
then the command will be looked up in the "default" catalog. This
value has no meaning except in the context of the command
property.
|
| command | | protected String command(Code) | | The name of a commons-chain command which should be
looked up and executed before Struts dispatches control to the view
represented by this config.
|
| extensionProcessed | | protected boolean extensionProcessed(Code) | | Have the inheritance values for this class been applied?
|
| inherit | | protected String inherit(Code) | | The name of the ForwardConfig that this object should inherit
properties from.
|
| module | | protected String module(Code) | | 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(Code) | | The unique identifier of this forward, which is used to reference it in
Action classes.
|
| path | | protected String path(Code) | | 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(Code) | | Should a redirect be used to transfer control to the specified path?
|
| ForwardConfig | | public ForwardConfig()(Code) | | Construct a new instance with default values.
|
| ForwardConfig | | public ForwardConfig(String name, String path, boolean redirect)(Code) | | Construct a new instance with the specified values.
Parameters:
name - Name of this forward
Parameters:
path - Path to which control should be forwarded orredirected
Parameters:
redirect - Should we do a redirect? |
| ForwardConfig | | public ForwardConfig(String name, String path, boolean redirect, String module)(Code) | | Construct a new instance with the specified values.
Parameters:
name - Name of this forward
Parameters:
path - Path to which control should be forwarded orredirected
Parameters:
redirect - Should we do a redirect?
Parameters:
module - Module prefix, if any |
| ForwardConfig | | public ForwardConfig(ForwardConfig copyMe)(Code) | | Construct a new instance based on the values of another
ForwardConfig.
Parameters:
copyMe - A ForwardConfig instance to copy
since:
Struts 1.3.6 |
| checkCircularInheritance | | protected boolean checkCircularInheritance(ModuleConfig moduleConfig, ActionConfig actionConfig)(Code) | | Traces the hierarchy of this object to check if any of the ancestors
are extending this instance.
Parameters:
moduleConfig - The ModuleConfig that this config is from.
Parameters:
actionConfig - The ActionConfig that this config is from,if applicable. This parameter must be null if thisforward config is a global forward. true if circular inheritance was detected. |
| getRedirect | | public boolean getRedirect()(Code) | | |
| inheritFrom | | public void inheritFrom(ForwardConfig config) throws ClassNotFoundException, IllegalAccessException, InstantiationException, InvocationTargetException(Code) | | Inherit values that have not been overridden from the provided
config object. Subclasses overriding this method should verify that
the given parameter is of a class that contains a property it is trying
to inherit:
if (config instanceof MyCustomConfig) {
MyCustomConfig myConfig =
(MyCustomConfig) config;
if (getMyCustomProp() == null) {
setMyCustomProp(myConfig.getMyCustomProp());
}
}
If the given config is extending another object, those
extensions should be resolved before it's used as a parameter to this
method.
Parameters:
config - The object that this instance will be inheriting itsvalues from.
See Also: ForwardConfig.processExtends(ModuleConfig,ActionConfig) |
| isExtensionProcessed | | public boolean isExtensionProcessed()(Code) | | |
| setRedirect | | public void setRedirect(boolean redirect)(Code) | | |
| toString | | public String toString()(Code) | | Return a String representation of this object.
|
| Fields inherited from org.apache.struts.config.BaseConfig | protected boolean configured(Code)(Java Doc)
|
|
|