org.kohsuke.stapler.jelly

Class JellyFacet

java.lang.Object

org.kohsuke.stapler.Facet

org.kohsuke.stapler.jelly.JellyFacet

All Implemented Interfaces:

JellyCompatibleFacet

@MetaInfServices(value=org.kohsuke.stapler.Facet.class)
public class JellyFacet
extends Facet
implements JellyCompatibleFacet

Facet that adds Jelly as the view.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
ResourceBundleFactory	resourceBundleFactory Used to load ResourceBundles.
ScriptInvoker	scriptInvoker Used to invoke Jelly script.
static boolean	TRACE This flag will activate the Jelly evaluation trace.

Fields inherited from class org.kohsuke.stapler.Facet

ALLOW_VIEW_NAME_PATH_TRAVERSAL, LOGGER

Constructor Summary

Constructors

Constructor and Description
JellyFacet()

Method Summary

Modifier and Type	Method and Description
void	buildIndexDispatchers(MetaClass owner, List<Dispatcher> dispatchers)
void	buildViewDispatchers(MetaClass owner, List<Dispatcher> dispatchers)
javax.servlet.RequestDispatcher	createRequestDispatcher(RequestImpl request, Klass<?> type, Object it, String viewName)
Collection<Class<JellyClassTearOff>>	getClassTearOffTypes()
protected String	getExtensionSuffix()
Collection<String>	getScriptExtensions() Gets the list of view script extensions, such as ".jelly".
boolean	handleIndexRequest(RequestImpl req, ResponseImpl rsp, Object node, MetaClass nodeMetaClass)
static void	setExpressionFactory(javax.servlet.ServletContextEvent event, org.apache.commons.jelly.expression.ExpressionFactory factory) Sets the Jelly ExpressionFactory to be used to parse views.

Methods inherited from class org.kohsuke.stapler.Facet

buildFallbackDispatchers, createRequestDispatcher, createRequestDispatcher, createValidatingDispatcher, discover, discoverExtensions, getKlass, handleIndexRequest, isBasename

Methods inherited from class java.lang.Object

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

Field Detail

scriptInvoker

public volatile ScriptInvoker scriptInvoker

Used to invoke Jelly script. Can be replaced to the custom object.

resourceBundleFactory

public volatile ResourceBundleFactory resourceBundleFactory

Used to load ResourceBundles.

TRACE

public static boolean TRACE

This flag will activate the Jelly evaluation trace. It generates extra comments into HTML, indicating where the fragment was rendered.

Constructor Detail

JellyFacet

public JellyFacet()

Method Detail

buildViewDispatchers

public void buildViewDispatchers(MetaClass owner,
                                 List<Dispatcher> dispatchers)

Specified by:

buildViewDispatchers in class Facet

buildIndexDispatchers

public void buildIndexDispatchers(MetaClass owner,
                                  List<Dispatcher> dispatchers)

Overrides:

buildIndexDispatchers in class Facet

getExtensionSuffix

@Nonnull
protected String getExtensionSuffix()

Overrides:

getExtensionSuffix in class Facet

getClassTearOffTypes

public Collection<Class<JellyClassTearOff>> getClassTearOffTypes()

Specified by:

getClassTearOffTypes in interface JellyCompatibleFacet

getScriptExtensions

public Collection<String> getScriptExtensions()

Description copied from interface: JellyCompatibleFacet

Gets the list of view script extensions, such as ".jelly".

Specified by:

getScriptExtensions in interface JellyCompatibleFacet

createRequestDispatcher

public javax.servlet.RequestDispatcher createRequestDispatcher(RequestImpl request,
                                                               Klass<?> type,
                                                               Object it,
                                                               String viewName)
                                                        throws IOException

Overrides:

createRequestDispatcher in class Facet

Throws:

IOException

handleIndexRequest

public boolean handleIndexRequest(RequestImpl req,
                                  ResponseImpl rsp,
                                  Object node,
                                  MetaClass nodeMetaClass)
                           throws IOException,
                                  javax.servlet.ServletException

Specified by:

handleIndexRequest in class Facet

Throws:

IOException

javax.servlet.ServletException

setExpressionFactory

public static void setExpressionFactory(javax.servlet.ServletContextEvent event,
                                        org.apache.commons.jelly.expression.ExpressionFactory factory)

Sets the Jelly ExpressionFactory to be used to parse views.

This method should be invoked from your implementation of ServletContextListener.contextInitialized(ServletContextEvent).

Once views are parsed, they won't be re-parsed just because you called this method to override the expression factory.

The primary use case of this feature is to customize the behavior of JEXL evaluation.