org.jahia.services.render

Class RenderInfo

java.lang.Object

org.jahia.services.render.RenderInfo

public class RenderInfo
extends Object

Represents an object with the information about rendering times of a resource including filter call events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RenderInfo.FilterEvent Represents a single filter call event.

Method Summary

Modifier and Type	Method and Description
static void	addFilterEvent(RenderFilter filter, int type) "Record" a filter call event of the specified type
static String	dump() Performs a dump of the collected data in JSON format and disables the collection of data.
String	getContextConfiguration()
long	getEndTime()
List<RenderInfo.FilterEvent>	getFilterEvents()
Map<String,Serializable>	getModuleParams()
String	getResourcePath()
String	getResourceTemplate()
long	getStartTime()
List<RenderInfo>	getSubResources()
long	getTime()
static boolean	isEnabled() Checks if the rendering data collection is enabled or not.
static void	popResource() Called when the rendering of the resource is finished to measure the ellapsed time.
static void	pushResource(Resource resource) Called on a start resource rendering.
static void	setEnabled(boolean enabled) Enables or disables rendering data collection.

Methods inherited from class java.lang.Object

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

Method Detail

setEnabled

public static void setEnabled(boolean enabled)

Enables or disables rendering data collection.

Parameters:

enabled - true to enable data collection; false to disable it

isEnabled

public static boolean isEnabled()

Checks if the rendering data collection is enabled or not.

Returns:

true if data collection is enabled; false if is it disabled

pushResource

public static void pushResource(Resource resource)

Called on a start resource rendering.

Parameters:

resource - the resource, the recording is started for

popResource

public static void popResource()

Called when the rendering of the resource is finished to measure the ellapsed time.

addFilterEvent

public static void addFilterEvent(RenderFilter filter,
                                  int type)

"Record" a filter call event of the specified type

Parameters:

filter - the filter which is being called

type - the filter call type

dump

public static String dump()

Performs a dump of the collected data in JSON format and disables the collection of data.

Returns:

a string representation of collected data in JSON format

getResourcePath

public String getResourcePath()

getResourceTemplate

public String getResourceTemplate()

getContextConfiguration

public String getContextConfiguration()

getModuleParams

public Map<String,Serializable> getModuleParams()

getTime

public long getTime()

getStartTime

public long getStartTime()

getEndTime

public long getEndTime()

getFilterEvents

public List<RenderInfo.FilterEvent> getFilterEvents()

getSubResources

public List<RenderInfo> getSubResources()