com.github.wuic.engine.core

Class HtmlInspectorEngine

java.lang.Object

com.github.wuic.engine.Engine

com.github.wuic.engine.NodeEngine

com.github.wuic.engine.core.HtmlInspectorEngine

All Implemented Interfaces:

NutFilterHolder, Comparable<Engine>

@EngineService(injectDefaultToWorkflow=true,
               isCoreEngine=true)
public class HtmlInspectorEngine
extends NodeEngine
implements NutFilterHolder

This engine is able to parse an HTML to collect all CSS and JS scripts, refer them through a heap and set reference to associated workflow URL in DOM.

Note that version number is based on content hash because this is the unique strategy that applies to inline scripts.

When a ConvertibleNut is parsed, the registered a transformer which is able to cache transformation operations is added for future usages.

If the result of the transformation performed by this engine is not served by WUIC, it means that some information like caching or hints won't be specified in the HTTP response headers. In that case, this engines fallback to the Application cache and the "link" tags mechanism by modifying the HTML content.

Since:

0.4.4

Version:

1.1

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HtmlInspectorEngine.ParseInfo Provides information from collected data in a HTML content.

Constructor Summary

Constructors

Constructor and Description
HtmlInspectorEngine(Boolean inspect, String cs, Boolean sh) Builds a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
EngineType	getEngineType() Gets the type of engine.
List<NutType>	getNutTypes() Gets the all types supported by this engine.
List<ConvertibleNut>	internalParse(EngineRequest request) Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.
void	setNutFilter(List<NutFilter> nutFilters) Sets the filter.
Boolean	works() Returns a flag indicating if the engine is configured to do something or not.

Methods inherited from class com.github.wuic.engine.NodeEngine

callNextEngine, chain, getNext, getPrevious, parse, setNext

Methods inherited from class com.github.wuic.engine.Engine

compareTo

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlInspectorEngine

@ConfigConstructor
public HtmlInspectorEngine(@BooleanConfigParam(defaultValue=true,propertyKey="c.g.wuic.engine.inspect")
                                     Boolean inspect,
                                     @StringConfigParam(defaultValue="UTF-8",propertyKey="c.g.wuic.engine.charset")
                                     String cs,
                                     @BooleanConfigParam(defaultValue=true,propertyKey="c.g.wuic.engine.serverHint")
                                     Boolean sh)

Builds a new instance.

Parameters:

inspect - activate inspection or not

cs - files charset

sh - activate server hint or not

Method Detail

internalParse

public List<ConvertibleNut> internalParse(EngineRequest request)
                                   throws WuicException

Internal method that parses eventually called by NodeEngine.parse(EngineRequest) method during its invocation.

Specified by:

internalParse in class Engine

Parameters:

request - the request with files to parse

Returns:

the parsed files

Throws:

WuicException - if any kind of error occurs

getNutTypes

public List<NutType> getNutTypes()

Gets the all types supported by this engine.

Specified by:

getNutTypes in class NodeEngine

Returns:

the NutType

getEngineType

public EngineType getEngineType()

Gets the type of engine.

Specified by:

getEngineType in class Engine

Returns:

the type of process done by with engine

works

public Boolean works()

Returns a flag indicating if the engine is configured to do something or not.

Specified by:

works in class Engine

Returns:

true is something will be done, false otherwise

setNutFilter

public void setNutFilter(List<NutFilter> nutFilters)

Sets the filter.

Specified by:

setNutFilter in interface NutFilterHolder

Parameters:

nutFilters - the filters