org.figure8.join.control.taglib
Class ResolveUserTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.figure8.join.control.taglib.ContextTag
              org.figure8.join.control.taglib.ResolveUserTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class ResolveUserTag
extends ContextTag

Retrieve a user's summary from the users cache using its identifier.
This tag operates in one of two major modes, depending on whether or not the userId attribute is specified. If it is included, this attribute is used as the identifier for retrieving a user's summary. If it is not included, name and property attributes must be provided.
name must be the name of the JSP bean (in page scope) containing the user's identifier. property must be the propery of this bean used to access identifier.
The additional link boolean attribute can be set in order to display (or not) a link to the page displaying user's details. Default is true.

Version:

$Revision: 1.2 $

Author:

Laurent Broudoux

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, 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

ResolveUserTag()

Method Summary

int	doEndTag() Release any acquired resources.
int	doStartTag() Get the user's summary from Users Cache and write it on output using the page JspWriter.
boolean	getLink()
java.lang.String	getName()
java.lang.String	getProperty()
java.lang.String	getUserId()
void	release() Release any acquired resource.
void	setLink(boolean link)
void	setName(java.lang.String name)
void	setProperty(java.lang.String property)
void	setUserId(java.lang.String userId)

Methods inherited from class org.figure8.join.control.taglib.ContextTag

findBeanInScope, storeBeanInScope

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Constructor Detail

ResolveUserTag

public ResolveUserTag()

Method Detail

getUserId

public java.lang.String getUserId()

Returns:

The user to resolve identifier

setUserId

public void setUserId(java.lang.String userId)

Parameters:

userId - The user to resolve identifier

getName

public java.lang.String getName()

Returns:

The name of the bean containing userId

setName

public void setName(java.lang.String name)

Parameters:

name - The name of the bean containing userId

getProperty

public java.lang.String getProperty()

Returns:

The property to apply on bean name

setProperty

public void setProperty(java.lang.String property)

Parameters:

property - The property to apply on bean name

getLink

public boolean getLink()

Returns:

setLink

public void setLink(boolean link)

Parameters:

link -

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Get the user's summary from Users Cache and write it on output using the page JspWriter. Do not throw exception, if error occurs cause not having the user's summary is not lethal ...

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Release any acquired resources.

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

release

public void release()

Release any acquired resource.

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.BodyTagSupport