Package org.apache.wiki.ui
Class RedirectCommand
java.lang.Object
org.apache.wiki.ui.AbstractCommand
org.apache.wiki.ui.RedirectCommand
- All Implemented Interfaces:
Command
public final class RedirectCommand extends AbstractCommand
Defines Commands for redirections to off-site special pages. RedirectCommands do not have associated permissions; the
requiredPermission()
method will always return null
. When combined with a supplied String url,
the AbstractCommand.getTarget()
method will return a String, the AbstractCommand.getURLPattern()
method will return the supplied target URL,
and AbstractCommand.getJSP()
method will return the "cleansed" URL.
- Since:
- 2.4.22
-
Field Summary
-
Method Summary
Modifier and Type Method Description String
getName()
Returns the human-friendly name for this command.Permission
requiredPermission()
No-op; always returnsnull
.Command
targetedCommand(Object target)
Creates and returns a targeted Command by combining a URL (as String) with this Command.Methods inherited from class org.apache.wiki.ui.AbstractCommand
getContentTemplate, getJSP, getJSPFriendlyName, getRequestContext, getTarget, getURLPattern, toString
-
Field Details
-
REDIRECT
-
-
Method Details
-
targetedCommand
Creates and returns a targeted Command by combining a URL (as String) with this Command. The suppliedtarget
object must be non-null
and of type String. The URL passed to the constructor is actually an URL pattern, but it will be converted to a JSP page if it is a partial URL. If it is a full URL (beginning withhttp://
orhttps://
), it will be "passed through" without conversion, and the URL pattern will benull
.- Specified by:
targetedCommand
in interfaceCommand
- Specified by:
targetedCommand
in classAbstractCommand
- Parameters:
target
- the object to combine- Returns:
- the new, targeted Command
- Throws:
IllegalArgumentException
- if the target is not of the correct type- See Also:
Command.targetedCommand(Object)
-
getName
Description copied from interface:Command
Returns the human-friendly name for this command.- Specified by:
getName
in interfaceCommand
- Specified by:
getName
in classAbstractCommand
- Returns:
- the name
- See Also:
Command.getName()
-
requiredPermission
No-op; always returnsnull
.- Returns:
- the required permission, or
null
if not required - See Also:
Command.requiredPermission()
-