com.ecyrd.jspwiki.tags
Class PermissionTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by com.ecyrd.jspwiki.tags.WikiTagBase
          extended by com.ecyrd.jspwiki.tags.PermissionTag
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag

public class PermissionTag
extends WikiTagBase

Tells whether the user in the current wiki context possesses a particular permission. The permission is typically a PagePermission (e.g., "edit", "view", "delete", "comment", "upload"). It may also be a wiki-wide WikiPermission ("createPages", "createGroups", "editProfile", "editPreferences", "login") or the administrator permission ("allPermission").

Since:
2.0
Author:
Janne Jalkanen, Andrew Jaquith
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ecyrd.jspwiki.tags.WikiTagBase
ATTR_CONTEXT, m_wikiContext
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
PermissionTag()
           
 
Method Summary
 int doWikiStartTag()
          This method is allowed to do pretty much whatever he wants.
 void initTag()
          This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.
 void setPermission(String permission)
          Sets the permission to look for (case sensitive).
 
Methods inherited from class com.ecyrd.jspwiki.tags.WikiTagBase
doEndTag, doStartTag, setPageContext
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PermissionTag

public PermissionTag()
Method Detail

initTag

public void initTag()
Description copied from class: WikiTagBase
This method is called when the tag is encountered within a new request, but before the setXXX() methods are called. The default implementation does nothing.

Overrides:
initTag in class WikiTagBase

setPermission

public void setPermission(String permission)
Sets the permission to look for (case sensitive).

Parameters:
permission -

doWikiStartTag

public final int doWikiStartTag()
                         throws IOException
Description copied from class: WikiTagBase
This method is allowed to do pretty much whatever he wants. We then catch all mistakes.

Specified by:
doWikiStartTag in class WikiTagBase
Throws:
IOException