|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.wiki.ui.AbstractCommand
org.apache.wiki.ui.RedirectCommand
public final class RedirectCommand
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.
This class is not final
; it may be extended in
the future.
Field Summary | |
---|---|
static Command |
REDIRECT
|
Method Summary | |
---|---|
String |
getName()
Returns the human-friendly name for this command. |
Permission |
requiredPermission()
No-op; always returns null . |
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 |
---|
allCommands, getContentTemplate, getJSP, getJSPFriendlyName, getRequestContext, getTarget, getURLPattern, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final Command REDIRECT
Method Detail |
---|
public Command targetedCommand(Object target)
target
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 with http://
or
https://
), it will be "passed through" without
conversion, and the URL pattern will be null
.
targetedCommand
in interface Command
targetedCommand
in class AbstractCommand
target
- the object to combine
IllegalArgumentException
- if the target is not of the correct typeCommand.targetedCommand(Object)
public String getName()
Command
getName
in interface Command
getName
in class AbstractCommand
Command.getName()
public Permission requiredPermission()
null
.
null
if not requiredCommand.requiredPermission()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |