org.mmbase.bridge.jsp.taglib

Class ContentTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.mmbase.bridge.jsp.taglib.ContextReferrerTag

org.mmbase.bridge.jsp.taglib.CloudReferrerTag

org.mmbase.bridge.jsp.taglib.LocaleTag

org.mmbase.bridge.jsp.taglib.ContentTag

All Implemented Interfaces:

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

public class ContentTag
extends LocaleTag

Provides environmental information to its body's tags.

Since:

MMBase-1.7

Version:

$Id$

Author:

Michiel Meeuwissen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static CharTransformer	COPY
(package private) static ContentTag	DEFAULT
static String	ENCODEURLS_KEY
static String	ESCAPER_KEY

Fields inherited from class org.mmbase.bridge.jsp.taglib.LocaleTag

cloud, KEY, locale, prevCloudLocale, prevJstlLocale, SCOPE, TZ_KEY, varyHeaders

Fields inherited from class org.mmbase.bridge.jsp.taglib.CloudReferrerTag

cloudId

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

Constructors

Constructor and Description
ContentTag()

Method Summary

Modifier and Type	Method and Description
protected void	addNoCacheHeaders(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, long expire) The code first sets the Expires header to a date in the past.
protected void	determineLocale()
int	doAfterBody()
int	doEndTag()
int	doStartTag()
static CharTransformer	getCharTransformer(String id, ContextReferrerTag tag) Gets a CharTransformer identified by id, which possibly can also be list of id's in which case a chain of chartransformers will be returned.
String	getEncoding()
protected CharTransformer	getPostProcessor()
protected static CharTransformer	getSimpleCharTransformer(String id, ContextReferrerTag tag) Gets a CharTransformer identified by id, withouth trying to create chains of them.
static ParameterizedTransformerFactory	getTransformerFactory(String id) Returns transformer factory with given id or throws exception if there is none
String	getType()
CharTransformer	getWriteEscaper() Called by children
protected static void	readXML(InputSource escapersSource)
void	setDisposition(String d)
void	setEncodeurls(String u)
void	setEncoding(String e)
void	setEscaper(String e)
void	setExpires(String e)
void	setPostprocessor(String e)
void	setType(String ct)
void	setUnacceptable(String u)
(package private) void	setUser(UserContext newUser) Sets a user.
void	setVaries(String v)
protected void	setWriteEscaper()
protected void	unsetWriteEscaper()

Methods inherited from class org.mmbase.bridge.jsp.taglib.LocaleTag

addVary, determineFromCloudProvider, determineLocaleFromAttributes, doFinally, getLocale, setCountry, setJspvar, setLanguage, setTimezone, setVariant

Methods inherited from class org.mmbase.bridge.jsp.taglib.CloudReferrerTag

fillStandardParameters, findCloudProvider, findCloudProvider, getCloudContext, getCloudVar, getNode, getNodeOrNull, setCloud

Methods inherited from class org.mmbase.bridge.jsp.taglib.ContextReferrerTag

appendMoreParameters, doCatch, findLoopOrQuery, findParentTag, findParentTag, findWriter, findWriter, getAttribute, getAttribute, getAttributeBoolean, getAttributeInteger, getAttributeInteger, getAttributeValue, getContentTag, getContextProvider, getContextTag, getCurrentBlock, getDefaultLocale, getEscapedValue, getFormTag, getId, getLocaleFromContext, getObject, getObjectConditional, getPageContext, getPageContextTag, getQuery, getReferid, getString, getTaglibVersion, getThreadPageContext, getTimer, getTimeZone, getWriterValue, haveBody, release, setContext, setEscape, setId, setListdelimiter, setPageContext, setPageContextOnly, 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 javax.servlet.jsp.tagext.Tag

getParent, setParent

Field Detail

COPY

static final CharTransformer COPY

ESCAPER_KEY

public static final String ESCAPER_KEY

See Also:

Constant Field Values

ENCODEURLS_KEY

public static final String ENCODEURLS_KEY

See Also:

Constant Field Values

DEFAULT

static final ContentTag DEFAULT

Constructor Detail

ContentTag

public ContentTag()

Method Detail

readXML

protected static void readXML(InputSource escapersSource)

setType

public void setType(String ct)
             throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

setEncoding

public void setEncoding(String e)
                 throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

setEscaper

public void setEscaper(String e)
                throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

setPostprocessor

public void setPostprocessor(String e)
                      throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

setExpires

public void setExpires(String e)
                throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

setDisposition

public void setDisposition(String d)
                    throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.8.5

setVaries

public void setVaries(String v)
               throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.9.1

getType

public String getType()
               throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

setUnacceptable

public void setUnacceptable(String u)
                     throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.8.5

setEncodeurls

public void setEncodeurls(String u)
                   throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

Since:

MMBase-1.9.4

getPostProcessor

protected CharTransformer getPostProcessor()
                                    throws javax.servlet.jsp.JspTagException

Returns:

A CharTransformer or null if no postprocessing needed

Throws:

javax.servlet.jsp.JspTagException - can occur if taglibcontent.xml is misconfigured

getEncoding

public String getEncoding()
                   throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

getSimpleCharTransformer

protected static CharTransformer getSimpleCharTransformer(String id,
                                                          ContextReferrerTag tag)
                                                   throws javax.servlet.jsp.JspTagException

Gets a CharTransformer identified by id, withouth trying to create chains of them.

Throws:

javax.servlet.jsp.JspTagException

getCharTransformer

public static CharTransformer getCharTransformer(String id,
                                                 ContextReferrerTag tag)
                                          throws javax.servlet.jsp.JspTagException

Gets a CharTransformer identified by id, which possibly can also be list of id's in which case a chain of chartransformers will be returned.

Returns:

A CharTransformer

Throws:

javax.servlet.jsp.JspTagException - if not transformer with given id was configured

getTransformerFactory

public static ParameterizedTransformerFactory getTransformerFactory(String id)
                                                             throws javax.servlet.jsp.JspTagException

Returns transformer factory with given id or throws exception if there is none

Throws:

javax.servlet.jsp.JspTagException

getWriteEscaper

public CharTransformer getWriteEscaper()

Called by children

Returns:

A CharTransformer (not null)

setWriteEscaper

protected void setWriteEscaper()
                        throws javax.servlet.jsp.JspTagException

Throws:

javax.servlet.jsp.JspTagException

unsetWriteEscaper

protected void unsetWriteEscaper()

determineLocale

protected void determineLocale()
                        throws javax.servlet.jsp.JspTagException

Overrides:

determineLocale in class LocaleTag

Throws:

javax.servlet.jsp.JspTagException

See Also:

LocaleTag.determineLocale()

doStartTag

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

Specified by:

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

Overrides:

doStartTag in class LocaleTag

Throws:

javax.servlet.jsp.JspTagException

addNoCacheHeaders

protected void addNoCacheHeaders(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 long expire)

The code first sets the Expires header to a date in the past. This indicates to the recipient that the page's content have already expired, as a hint that it's contents should not be cached. The no-cache value for the Pragma header is provided by version 1.0 of the HTTP protocol to further indicate that browsers and proxy servers should not cache a page. Version 1.1 of HTTP replaces this header with a more specific Cache-Control header, but recommends including the Pragma header as well for backward compatibility.

Parameters:

response - - http response

expire - - seconds before content should expire

Since:

MMBase 1.8.1

doEndTag

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

Specified by:

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

Overrides:

doEndTag in class LocaleTag

Throws:

javax.servlet.jsp.JspTagException

setUser

void setUser(UserContext newUser)
      throws javax.servlet.jsp.JspTagException

Sets a user. This is used by cloud-tag.

Throws:

javax.servlet.jsp.JspTagException

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspTagException

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

doAfterBody in class LocaleTag

Throws:

javax.servlet.jsp.JspTagException