org.springframework.extensions.surf.taglib

Class ResourceTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.springframework.web.servlet.tags.RequestContextAwareTag

org.springframework.extensions.surf.taglib.RenderServiceTag

org.springframework.extensions.surf.taglib.ResourceTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

public class ResourceTag
extends RenderServiceTag

Outputs the requested url representation of a resource. Named Resource Examples:

• <alf:resource name="resourceName" />
• <alf:resource id="<protocol>://<endpoint>/<object id>" />
• <alf:resource protocol="<protocol>" endpoint="<endpoint>" object="<object id>" />
• <alf:resource name="resourceName" payload="metadata" />
• <alf:resource name="resourceName" payload="content" />

Author:

David Draper, muzquiano

See Also:

Serialized Form

Field Summary

Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

REQUEST_CONTEXT_PAGE_ATTRIBUTE

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

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

Constructors

Constructor and Description
ResourceTag()

Method Summary

Methods

Modifier and Type	Method and Description
String	getEndpoint()
String	getId()
String	getName()
String	getObject()
String	getPayload()
String	getProtocol()
protected int	invokeRenderService(RenderService renderService, RequestContext renderContext, ModelObject modelObject) This method should be implemented to invoke the required method of the RenderService that the subclass needs to render its output
void	release() The life-cycle of a custom JSP tag is that the class is is instantiated when it is first required and then re-used for all subsequent invocations.
void	setEndpoint(String endpoint)
void	setId(String id)
void	setName(String name)
void	setObject(String object)
void	setPayload(String payload)
void	setProtocol(String protocol)

Methods inherited from class org.springframework.extensions.surf.taglib.RenderServiceTag

doStartTagInternal

Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

doCatch, doFinally, doStartTag, getRequestContext

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

doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceTag

public ResourceTag()

Method Detail

setName

public void setName(String name)

getName

public String getName()

setId

public void setId(String id)

Overrides:

setId in class javax.servlet.jsp.tagext.TagSupport

getId

public String getId()

Overrides:

getId in class javax.servlet.jsp.tagext.TagSupport

setProtocol

public void setProtocol(String protocol)

getProtocol

public String getProtocol()

setEndpoint

public void setEndpoint(String endpoint)

getEndpoint

public String getEndpoint()

setObject

public void setObject(String object)

getObject

public String getObject()

setPayload

public void setPayload(String payload)

getPayload

public String getPayload()

release

public void release()

The life-cycle of a custom JSP tag is that the class is is instantiated when it is first required and then re-used for all subsequent invocations. When a JSP has non-mandatory properties it means that the setters for those properties will not be called if the properties are not provided and the old values will still be available which can corrupt the behaviour of the code. In order to prevent this from happening we should override the release method to ensure that all instance variables are reset to their initial state.

Specified by:

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

Overrides:

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

invokeRenderService

protected int invokeRenderService(RenderService renderService,
                      RequestContext renderContext,
                      ModelObject modelObject)
                           throws RequestDispatchException

Description copied from class: RenderServiceTag

This method should be implemented to invoke the required method of the RenderService that the subclass needs to render its output

Specified by:

invokeRenderService in class RenderServiceTag

Parameters:

renderService - RenderService

renderContext - RequestContext

modelObject - ModelObject

Returns:

The appropriate return code to pass on (e.g. SKIP_BODY, EVAL_BODY_INCLUDE, etc).

Throws:

RequestDispatchException