org.mmbase.bridge.jsp.taglib
Class CloudTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byjavax.servlet.jsp.tagext.BodyTagSupport
          extended byorg.mmbase.bridge.jsp.taglib.ContextReferrerTag
              extended byorg.mmbase.bridge.jsp.taglib.CloudTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, CloudProvider, javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag, TagIdentifier

public class CloudTag
extends ContextReferrerTag
implements CloudProvider

Creates a cloud object (pulling it from if session necessary). While creating a cloud object one also has to authenticate itself, so this functionality is also in this tag.

Version:
$Id: CloudTag.java,v 1.94.2.6 2004/07/05 17:19:56 michiel Exp $
Author:
Pierre van Rooden, Michiel Meeuwissen, Vincent van der Locht
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag
contextId, EVAL_BODY, helper, id, pageContextTag, referid, writerid
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
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
CloudTag()
           
 
Method Summary
 int doAfterBody()
           
 int doEndTag()
           
 int doStartTag()
          Sets the cloud variable considering all requirements.
protected  java.lang.String getAuthenticate()
           
 Cloud getCloudVar()
           
 CloudContext getDefaultCloudContext()
           
protected  int getMethod()
           
protected  java.lang.String getName()
           
protected  Rank getRank()
          Gives the configured rank as a Rank object
 java.lang.String getSessionName()
          Return the name of session variable in which the cloud is stored.
 void setAuthenticate(java.lang.String authenticate)
           
 void setCloudVar(Cloud c)
           
 void setJspvar(java.lang.String jv)
           
 void setLoginpage(java.lang.String loginpage)
           
 void setLogon(java.lang.String l)
           
 void setMethod(java.lang.String mm)
           
 void setName(java.lang.String name)
           
 void setOnfail(java.lang.String of)
           
 void setPageContext(javax.servlet.jsp.PageContext pc)
          request and response can be determined once a page..
 void setPassword(java.lang.String pwd)
          Synonym for setPwd.
 void setPwd(java.lang.String pwd)
           
 void setRank(java.lang.String r)
           
 void setSessionname(java.lang.String s)
           
 void setUri(java.lang.String uri)
           
 void setUsername(java.lang.String l)
          Synonym for setLogon.
 
Methods inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag
findParentTag, findParentTag, findParentTag, findParentTag, findWriter, findWriter, getAttribute, getAttributeBoolean, getAttributeInteger, getAttributeInteger, getAttributeValue, getContentTag, getContextProvider, getContextTag, getId, getLocale, getObject, getPageContext, getReferid, getString, getWriterValue, haveBody, release, setContext, setEscape, setId, setReferid, setVartype, setWrite, setWriter
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getParent, getValue, getValues, removeValue, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.mmbase.bridge.jsp.taglib.TagIdentifier
getId
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setParent
 

Constructor Detail

CloudTag

public CloudTag()
Method Detail

getDefaultCloudContext

public CloudContext getDefaultCloudContext()
                                    throws javax.servlet.jsp.JspTagException
Returns:
the default cloud context
Throws:
javax.servlet.jsp.JspTagException

setUri

public void setUri(java.lang.String uri)
            throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

setName

public void setName(java.lang.String name)
             throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

getName

protected java.lang.String getName()
                            throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

setLogon

public void setLogon(java.lang.String l)
              throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

setPwd

public void setPwd(java.lang.String pwd)
            throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

setUsername

public void setUsername(java.lang.String l)
                 throws javax.servlet.jsp.JspTagException
Synonym for setLogon. Don't mix.

Throws:
javax.servlet.jsp.JspTagException

setPassword

public void setPassword(java.lang.String pwd)
                 throws javax.servlet.jsp.JspTagException
Synonym for setPwd. Don't mix.

Throws:
javax.servlet.jsp.JspTagException

setRank

public void setRank(java.lang.String r)
             throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

getRank

protected Rank getRank()
                throws javax.servlet.jsp.JspTagException
Gives the configured rank as a Rank object

Throws:
javax.servlet.jsp.JspTagException

setOnfail

public void setOnfail(java.lang.String of)
               throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException
Since:
MMBase-1.7

setJspvar

public void setJspvar(java.lang.String jv)
Overrides:
setJspvar in class ContextReferrerTag

setAuthenticate

public void setAuthenticate(java.lang.String authenticate)
                     throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

getAuthenticate

protected java.lang.String getAuthenticate()
                                    throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

setMethod

public void setMethod(java.lang.String mm)
               throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

getMethod

protected int getMethod()
                 throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

getCloudVar

public Cloud getCloudVar()
Specified by:
getCloudVar in interface CloudProvider
Returns:
the cloud contained in the tag

setCloudVar

public void setCloudVar(Cloud c)

setSessionname

public void setSessionname(java.lang.String s)
                    throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

setLoginpage

public void setLoginpage(java.lang.String loginpage)
                  throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException

getSessionName

public java.lang.String getSessionName()
                                throws javax.servlet.jsp.JspTagException
Return the name of session variable in which the cloud is stored. This is on default "cloud_mmbase" but this can be influenced with the sessionname attribute. If two pages have different sessionnames for the cloud, they can be logged in simultaniously with different clouds, but in the same session. If no sessionname is given or an empty sessionname, it returns the defaultvalue.

Throws:
javax.servlet.jsp.JspTagException

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext pc)
request and response can be determined once a page..

Specified by:
setPageContext in interface javax.servlet.jsp.tagext.Tag
Overrides:
setPageContext in class ContextReferrerTag

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspTagException
Sets the cloud variable considering all requirements. SKIP_BODY if this can not be done.

Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Throws:
javax.servlet.jsp.JspTagException

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspTagException
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class ContextReferrerTag
Throws:
javax.servlet.jsp.JspTagException

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspTagException
Specified by:
doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
Throws:
javax.servlet.jsp.JspTagException


MMBase build 1.7.1.20041002