org.jooby.assets

Class AssetProcessor

java.lang.Object

org.jooby.assets.AssetOptions

org.jooby.assets.AssetProcessor

Direct Known Subclasses:

Props, Replace

public abstract class AssetProcessor
extends AssetOptions

asset processor

Checks, validate and/or modify asset contents. An AssetProcessor is usually provided as a separated dependency.

how to use it?

First thing to do is to add the dependency:

   <dependency>
     <groupId>org.jooby</groupId>
     <artifactId>jooby-assets-my-processor</artifactId>
     <scope>provided</scope>
   </dependency>
 

Did you see the provided scope? We just need the processor for development, because assets are processed on the fly. For prod, assets are processed at built-time via Maven/Gradle plugin, at runtime we don't need this. This also, helps to keep our dependencies and the jar size small.

Now we have the dependency all we have to do is to add it to our pipeline:

 assets {
   pipeline: {
     dev: [my-processor]
   }
 }
 

configuration

It is possible to configure or set options too:

 assets {
   pipeline: {
     dev: [my-processor]
     dist: [my-processor]
   }

   my-processor {
     foo: bar
   }
 }
 

Previous example, set a foo property to bar! Options can be set per environment too:

 assets {
   pipeline: {
     dev: [my-processor]
     dist: [my-processor]
   }

   my-processor {
     dev {
       bar: bar
     }
     dist {
       foo: bar
     }
     foo: foo
   }
 }
 

Here, in dev processor has two properties: foo:foo and bar:bar, while in dist the processor only has foo:bar

binding

The my-processor will be resolved it to: org.jooby.assets.MyProcessor class. The processor name is converted to MyProcessor, it converts the hyphenated name to upper camel and by default processors are defined in the org.jooby.assets package.

A custom binding is provided via the class property:

 assets {
   pipeline: {
     dev: [my-processor]
     dist: [my-processor]
   }

   my-processor {
     class: whatever.i.Want
   }
 }
 

Since:

0.11.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
AssetProcessor()

Method Summary

Modifier and Type	Method and Description
abstract boolean	matches(MediaType type)
String	name()
String	process(String filename, String source, com.typesafe.config.Config conf) Method that processes the provided source and returns the processed contents.
abstract String	process(String filename, String source, com.typesafe.config.Config conf, ClassLoader loader) Method that processes the provided source and returns the processed contents, with access to the ClassLoader.
AssetProcessor	set(com.typesafe.config.Config options)
AssetProcessor	set(EngineFactory factory) This method is executed by the AssetCompiler at processor creation time.
AssetProcessor	set(String name, Object value)
String	toString()

Methods inherited from class org.jooby.assets.AssetOptions

excludes, get, options

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AssetProcessor

public AssetProcessor()

Method Detail

name

public String name()

set

public AssetProcessor set(String name,
                          Object value)

Overrides:

set in class AssetOptions

set

public AssetProcessor set(com.typesafe.config.Config options)

Overrides:

set in class AssetOptions

matches

public abstract boolean matches(MediaType type)

process

public String process(String filename,
                      String source,
                      com.typesafe.config.Config conf)
               throws Exception

Method that processes the provided source and returns the processed contents.

Parameters:

filename - name of the file

source - contents of the file

conf - application configuration

Returns:

the processed file contents

Throws:

Exception - if any error occurred

process

public abstract String process(String filename,
                               String source,
                               com.typesafe.config.Config conf,
                               ClassLoader loader)
                        throws Exception

Method that processes the provided source and returns the processed contents, with access to the ClassLoader.

Parameters:

filename - name of the file

source - contents of the file

conf - application configuration

loader - loader to use if any additional files need to be loaded from disk

Returns:

the processed file contents

Throws:

Exception - if any error occurred

set

public AssetProcessor set(EngineFactory factory)

This method is executed by the AssetCompiler at processor creation time.

Parameters:

factory - Factory or null.

Returns:

Asset processor.

toString

public String toString()

Overrides:

toString in class Object