ResourceMount (Wicket Merged Resources 4.0.0 API)

java.lang.Object
- org.wicketstuff.mergedresources.ResourceMount

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

RemoteHostResourceMount
```
public class ResourceMount
extends Object
implements Cloneable
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ResourceMount.SuffixMismatchStrategy

Nested Classes
Modifier and Type	Class and Description
`static class`	`ResourceMount.SuffixMismatchStrategy`

Field Summary

Fields
Modifier and Type	Field and Description
`static org.apache.wicket.MetaDataKey<ICssCompressor>`	`CSS_COMPRESSOR_KEY` MetaDataKey used for `CompressedMergedCssResource`
`static int`	`DEFAULT_AGGRESIVE_CACHE_DURATION` Deprecated. typo in name, it's aggressive with ss, use `DEFAULT_AGGRESSIVE_CACHE_DURATION` instead
`static int`	`DEFAULT_AGGRESSIVE_CACHE_DURATION` default aggressive cache duration is 1 year
`static int`	`DEFAULT_CACHE_DURATION` default cache duration is 1 hour
`static Set<String>`	`DEFAULT_COMPRESS_SUFFIXES` file suffixes to be compressed by default ("css", "js", "html", "xml").
`static Set<String>`	`DEFAULT_MERGE_SUFFIXES` file suffixes to be merged by default ("css" and "js").

Constructor Summary

Constructors
Constructor and Description
`ResourceMount()` Create a new ResourceMount with default settings
`ResourceMount(boolean development)` If dCreate a new ResourceMount with default settings

Method Summary

Methods
Modifier and Type	Method and Description
`ResourceMount`	`addResourceSpec(Class<?> scope, String name)` add a new `ResourceSpec` with this scope and name
`ResourceMount`	`addResourceSpec(Class<?> scope, String name, Locale locale, String style, Integer cacheDuration)` add a new `ResourceSpec` with this scope, name, locale, style and cacheDuration
`ResourceMount`	`addResourceSpec(org.apache.wicket.ResourceReference ref)` add a `ResourceSpec` using a `ResourceReference`
`ResourceMount`	`addResourceSpec(ResourceSpec resourceSpec)`
`ResourceMount`	`addResourceSpecMatchingSuffix(Class<?> scope, String suffix)` Adds a resource spec for a resource with the same name as the scope, adding a suffix.
`ResourceMount`	`addResourceSpecs(Class<?> scope, String... names)` add a new `ResourceSpec` with this scope and each name
`ResourceMount`	`addResourceSpecs(Iterable<? extends ResourceSpec> resourceSpecs)` add all resource specs
`ResourceMount`	`addResourceSpecs(org.apache.wicket.ResourceReference... refs)` add a `ResourceSpec` for each `ResourceReference`
`ResourceMount`	`addResourceSpecs(ResourceSpec... resourceSpecs)` add all resource specs
`ResourceMount`	`addResourceSpecsMatchingSuffix(Class<?>... scopes)` uses the path (set by `setPath(String)`) to obtain a suffix to use with `addResourceSpecMatchingSuffix(Class, String)`
`ResourceMount`	`addResourceSpecsMatchingSuffix(Class<?> scope, Iterable<String> suffixes)` same as `addResourceSpecMatchingSuffix(Class, String)` but using multiple suffixes
`ResourceMount`	`addResourceSpecsMatchingSuffix(String suffix, Class<?>... scopes)`
`ResourceMount`	`addResourceSpecsMatchingSuffixes(Class<?> scope, String... suffixes)` same as `addResourceSpecMatchingSuffix(Class, String)` but using multiple suffixes
`ResourceMount`	`autodetectCacheDuration()` autodetect cache duration: use minimum of all resource specs or `DEFAULT_CACHE_DURATION` if not available.
`ResourceMount`	`autodetectCompression()` autodetect whether this resource should be compressed using suffix of file name (e.g.
`ResourceMount`	`autodetectLocale()` Autodetect the locale.
`ResourceMount`	`autodetectMerging()` autodetect whether this resource should be merged using suffix of file name (e.g.
`ResourceMount`	`autodetectMinifyCss()` Autodetect wheter resource should be minified using a CSS compressor.
`ResourceMount`	`autodetectMinifyJs()` Autodetect wheter resource should be minified using a JS compressor.
`ResourceMount`	`autodetectMountScope()` Same as passing `null` to `setMountScope(Class)`.
`ResourceMount`	`autodetectStyle()` Autodetect the style.
`ResourceMount`	`autodetectVersion()` same as passing `null` to `setVersion(AbstractResourceVersion)`
`org.apache.wicket.behavior.AbstractHeaderContributor`	`build(org.apache.wicket.protocol.http.WebApplication application)` same as `mount(WebApplication)`, but returns an `AbstractHeaderContributor` to use in components
`org.apache.wicket.behavior.AbstractHeaderContributor`	`build(org.apache.wicket.protocol.http.WebApplication application, String cssMediaType)` same as `mount(WebApplication)`, but returns an `AbstractHeaderContributor` to use in components
`protected String`	`buildVersionedPath(String path, AbstractResourceVersion version)` create a versioned path out of the given path and the version.
`protected void`	`checkSuffixes(String path, Iterable<ResourceSpec> specs)` check if suffixes of path and each RespurceSpec file match
`ResourceMount`	`clearSpecs()` clear all added `ResourceSpec`s
`ResourceMount`	`clone()` a copy of the resource mount, with unfolded collections of compressed suffixes, merged suffices and `ResourceSpec`s
`protected boolean`	`doCompress(String file)`
`protected boolean`	`doMerge()` should the added `ResourceSpec`s be merged to a single resource, or should they be mounted idividually? default is to merge files ending with `DEFAULT_MERGE_SUFFIXES`
`protected boolean`	`doMinifyCss(String file)`
`protected boolean`	`doMinifyJs(String file)`
`static void`	`enableAnnotations(org.apache.wicket.protocol.http.WebApplication application)` enable annotation based adding of resources and make sure that the component instantiation listener is only added once
`protected int`	`getCacheDuration(ResourceSpec[] specs, boolean versioned)` detect the cache duration to use.
`Set<String>`	`getCompressedSuffixes()`
`static ICssCompressor`	`getCssCompressor(org.apache.wicket.Application application)` get `ICssCompressor` used by `CompressedMergedCssResource`
`protected Locale`	`getLocale(ResourceSpec[] specs)` detect the locale to use.
`Set<String>`	`getMergedSuffixes()`
`String`	`getPath()`
`String`	`getPath(String appendName)`
`String`	`getPath(String appendName, ResourceSpec[] specs)`
`IResourcePreProcessor`	`getPreProcessor()`
`protected ResourceSpec[]`	`getResourceSpecs()`
`protected Class<?>`	`getScope(ResourceSpec[] specs)` get the mount scope.
`protected String`	`getStyle(ResourceSpec[] specs)` detect the style to use.
`static String`	`getSuffix(String path)`
`ResourceMount.SuffixMismatchStrategy`	`getSuffixMismatchStrategy()`
`protected AbstractResourceVersion`	`getVersion(ResourceSpec[] specs)` detect the version.
`ResourceMount`	`mount(org.apache.wicket.protocol.http.WebApplication application)` mount the `ResourceSpec`(s) added either as a single `Resource` or multiple Resource, depending on `doMerge()`.
`static void`	`mountAnnotatedPackageResources(String mountPrefix, Class<?> scope, org.apache.wicket.protocol.http.WebApplication application, ResourceMount mount)`
`static void`	`mountAnnotatedPackageResources(String mountPrefix, Package pkg, org.apache.wicket.protocol.http.WebApplication application, ResourceMount mount)`
`static void`	`mountAnnotatedPackageResources(String mountPrefix, String packageName, org.apache.wicket.protocol.http.WebApplication application, ResourceMount mount)` mount annotated resources from the given package.
`static void`	`mountWicketResources(String mountPrefix, org.apache.wicket.protocol.http.WebApplication application)` Mount wicket-event.js and wicket-ajax.js using wicket's version for aggressive caching (e.g.
`static void`	`mountWicketResources(String mountPrefix, org.apache.wicket.protocol.http.WebApplication application, ResourceMount mount)` Mount wicket-event.js and wicket-ajax.js using wicket's version (e.g.
`static void`	`mountWicketResourcesMerged(String mountPrefix, org.apache.wicket.protocol.http.WebApplication application)` Mount wicket-event.js and wicket-ajax.js merged using wicket's version for aggressive caching (e.g.
`static void`	`mountWicketResourcesMerged(String mountPrefix, org.apache.wicket.protocol.http.WebApplication application, ResourceMount mount)` Mount wicket-event.js and wicket-ajax.js merged using wicket's version (e.g.
`protected org.apache.wicket.behavior.AbstractHeaderContributor`	`newHeaderContributor(List<org.apache.wicket.ResourceReference> refs, String cssMediaType)`
`protected org.apache.wicket.request.target.coding.IRequestTargetUrlCodingStrategy`	`newRedirectStrategy(String mountPath, String redirectPath)` create a new `IRequestTargetUrlCodingStrategy` to redirect from mountPath to redirectPath
`protected org.apache.wicket.ResourceReference`	`newResourceReference(Class<?> scope, String name, Locale locale, String style, int cacheDuration, ResourceSpec[] resourceSpecs, IResourcePreProcessor preProcessor)` create a new `ResourceReference`
`protected org.apache.wicket.request.target.coding.IRequestTargetUrlCodingStrategy`	`newStrategy(String mountPath, org.apache.wicket.ResourceReference ref, boolean merge)` create a new `IRequestTargetUrlCodingStrategy`
`protected void`	`onSuffixMismatch(String resource, String path)` apply `ResourceMount.SuffixMismatchStrategy` without further checking, arguments are for logging only
`ResourceMount`	`setCacheDuration(int cacheDuration)` Set cache duration in seconds.
`ResourceMount`	`setCompressed(boolean compressed)`
`static void`	`setCssCompressor(org.apache.wicket.Application application, ICssCompressor compressor)` set `ICssCompressor` used by `CompressedMergedCssResource`
`ResourceMount`	`setDefaultAggresiveCacheDuration()` Deprecated. typo in name, it's aggressive with ss
`ResourceMount`	`setDefaultAggressiveCacheDuration()` Same as passing `DEFAULT_AGGRESSIVE_CACHE_DURATION` to `setCacheDuration(int)`
`ResourceMount`	`setDefaultCacheDuration()` Same as passing `DEFAULT_CACHE_DURATION` to `setCacheDuration(int)`
`ResourceMount`	`setLocale(Locale locale)` Locale might either be detected from added `ResourceSpec`s or set manually.
`ResourceMount`	`setMerged(boolean merge)`
`ResourceMount`	`setMinifyCss(Boolean minifyCss)`
`ResourceMount`	`setMinifyJs(Boolean minifyJs)`
`ResourceMount`	`setMinVersion(AbstractResourceVersion minVersion)` force a minimal version.
`ResourceMount`	`setMinVersion(int minVersionValue)` Convenience method to use a `SimpleResourceVersion` as minVersion (e.g.
`ResourceMount`	`setMountRedirect(boolean mountRedirect)`
`ResourceMount`	`setMountScope(Class<?> mountScope)` The mount scope to use.
`ResourceMount`	`setNoVersion()` same as passing `AbstractResourceVersion.NO_VERSION` to `setVersion(AbstractResourceVersion)`
`ResourceMount`	`setPath(String path)` the path to user for mounting.
`ResourceMount`	`setPath(String prefix, org.apache.wicket.ResourceReference ref)` convenience method to use `setPath(String)` use a prefix and `ResourceReference.getName()`.
`ResourceMount`	`setPath(String prefix, org.apache.wicket.ResourceReference ref, String suffix)` convenience method to use `setPath(String)` use a prefix and `ResourceReference.getName()`.
`ResourceMount`	`setPath(String prefix, String name, String suffix)` convenience method to use `setPath(String)` use a prefix and a name
`ResourceMount`	`setPreProcessor(IResourcePreProcessor preProcessor)` use an `IResourcePreProcessor` to modify resources (e.g.
`ResourceMount`	`setRequireVersion(boolean requireVersion)` `IResourceVersionProvider` might not always be able to detect the version of a resource.
`ResourceMount`	`setResourceVersionProvider(IResourceVersionProvider resourceVersionProvider)` Set the `IResourceVersionProvider` to use for `AbstractResourceVersion` detection
`ResourceMount`	`setStyle(String style)` Style might either be detected from added `ResourceSpec`s or set manually.
`ResourceMount`	`setSuffixMismatchStrategy(ResourceMount.SuffixMismatchStrategy suffixMismatchStrategy)`
`ResourceMount`	`setVersion(AbstractResourceVersion version)` force a resource version, any `IResourceVersionProvider` ( `setResourceVersionProvider(IResourceVersionProvider)`) will be ignored.
`ResourceMount`	`unsetMinVersion()` unset minimal version, same as passing `null` to `setMinVersion(AbstractResourceVersion)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CACHE_DURATION
```
public static final int DEFAULT_CACHE_DURATION
```
    default cache duration is 1 hour
  - DEFAULT_AGGRESSIVE_CACHE_DURATION
```
public static final int DEFAULT_AGGRESSIVE_CACHE_DURATION
```
    default aggressive cache duration is 1 year
  - DEFAULT_AGGRESIVE_CACHE_DURATION
```
@Deprecated
public static final int DEFAULT_AGGRESIVE_CACHE_DURATION
```
    Deprecated. typo in name, it's aggressive with ss, use DEFAULT_AGGRESSIVE_CACHE_DURATION instead
  - DEFAULT_COMPRESS_SUFFIXES
```
public static final Set<String> DEFAULT_COMPRESS_SUFFIXES
```
    file suffixes to be compressed by default ("css", "js", "html", "xml"). For instance, there is no sense in gzipping images
  - DEFAULT_MERGE_SUFFIXES
```
public static final Set<String> DEFAULT_MERGE_SUFFIXES
```
    file suffixes to be merged by default ("css" and "js"). For instance, there is no sense in merging xml files into a single one by default (you don't want multiple root elements)
  - CSS_COMPRESSOR_KEY
```
public static final org.apache.wicket.MetaDataKey<ICssCompressor> CSS_COMPRESSOR_KEY
```
    MetaDataKey used for CompressedMergedCssResource
- Constructor Detail
  - ResourceMount
```
public ResourceMount()
```
    Create a new ResourceMount with default settings
  - ResourceMount
```
public ResourceMount(boolean development)
```
    If dCreate a new ResourceMount with default settings
    
    Parameters:
    development - true if ResourceMount should be configured with developer-friendly defaults: no caching, no merging, no minify
- Method Detail
  - mountWicketResources
```
public static void mountWicketResources(String mountPrefix,
                        org.apache.wicket.protocol.http.WebApplication application)
```
    Mount wicket-event.js and wicket-ajax.js using wicket's version for aggressive caching (e.g. wicket-ajax-1.3.6.js)
    
    Parameters:
    mountPrefix - e.g. "script" for "/script/wicket-ajax-1.3.6.js
    application - the application
  - mountWicketResources
```
public static void mountWicketResources(String mountPrefix,
                        org.apache.wicket.protocol.http.WebApplication application,
                        ResourceMount mount)
```
    Mount wicket-event.js and wicket-ajax.js using wicket's version (e.g. wicket-ajax-1.3.6.js).
    
    Parameters:
    mountPrefix - e.g. "script" for "/script/wicket-ajax-1.3.6.js
    application - the application
    mount - pre-configured resource mount to use. ResourceVersionProvider will be overriden
  - mountWicketResourcesMerged
```
public static void mountWicketResourcesMerged(String mountPrefix,
                              org.apache.wicket.protocol.http.WebApplication application)
```
    Mount wicket-event.js and wicket-ajax.js merged using wicket's version for aggressive caching (e.g. wicket-1.4.7.js)
    
    Parameters:
    mountPrefix - e.g. "script" for "/script/wicket-1.4.7.js
    application - the application
  - mountWicketResourcesMerged
```
public static void mountWicketResourcesMerged(String mountPrefix,
                              org.apache.wicket.protocol.http.WebApplication application,
                              ResourceMount mount)
```
    Mount wicket-event.js and wicket-ajax.js merged using wicket's version (e.g. wicket-1.4.7.js).
    
    Parameters:
    mountPrefix - e.g. "script" for "/script/wicket-1.4.7.js
    application - the application
    mount - pre-configured resource mount to use. ResourceVersionProvider and Merged will be overridden
  - enableAnnotations
```
public static void enableAnnotations(org.apache.wicket.protocol.http.WebApplication application)
```
    enable annotation based adding of resources and make sure that the component instantiation listener is only added once
    
    Parameters:
    application -
    See Also:
    JsContribution, CssContribution
  - mountAnnotatedPackageResources
```
public static void mountAnnotatedPackageResources(String mountPrefix,
                                  Class<?> scope,
                                  org.apache.wicket.protocol.http.WebApplication application,
                                  ResourceMount mount)
```
    See Also:
    mountAnnotatedPackageResources(String, String, WebApplication, ResourceMount)
  - mountAnnotatedPackageResources
```
public static void mountAnnotatedPackageResources(String mountPrefix,
                                  Package pkg,
                                  org.apache.wicket.protocol.http.WebApplication application,
                                  ResourceMount mount)
```
    See Also:
    mountAnnotatedPackageResources(String, String, WebApplication, ResourceMount)
  - mountAnnotatedPackageResources
```
public static void mountAnnotatedPackageResources(String mountPrefix,
                                  String packageName,
                                  org.apache.wicket.protocol.http.WebApplication application,
                                  ResourceMount mount)
```
    mount annotated resources from the given package. resources are mounted beyond the given pathPrefix if resource scope doesn't start with / itself.
    
    Parameters:
    mount - a preconfigured ResourceMount, won't be changed
    pathPrefix - pathPrefix to mount resources
    packageName - the scanned package
    application -
    See Also:
    JsContribution, CssContribution
  - getSuffix
```
public static String getSuffix(String path)
```
    Parameters:
    path -
    
    Returns:
    everything after last dot '.', ignoring anything before last slash '/' and leading dots '.' ; null if suffix is empty
  - setCssCompressor
```
public static void setCssCompressor(org.apache.wicket.Application application,
                    ICssCompressor compressor)
```
    set ICssCompressor used by CompressedMergedCssResource
    
    Parameters:
    application -
    compressor -
  - getCssCompressor
```
public static ICssCompressor getCssCompressor(org.apache.wicket.Application application)
```
    get ICssCompressor used by CompressedMergedCssResource
    
    Parameters:
    application -
  - setCompressed
```
public ResourceMount setCompressed(boolean compressed)
```
    Parameters:
    compressed - whether this resources should be compressed. default is autodetect
    
    Returns:
    this
    See Also:
    autodetectCompression()
  - autodetectCompression
```
public ResourceMount autodetectCompression()
```
    autodetect whether this resource should be compressed using suffix of file name (e.g. ".css") Behavior might be overriden in doCompress(String)
    
    Returns:
    this
    See Also:
    setCompressed(boolean)
  - setMerged
```
public ResourceMount setMerged(boolean merge)
```
    Parameters:
    merge - whether all ResourceSpecs should be merged to a single resource. default is autodetect
    
    Returns:
    this
    See Also:
    autodetectMerging()
  - autodetectMerging
```
public ResourceMount autodetectMerging()
```
    autodetect whether this resource should be merged using suffix of file name (e.g. ".js")
    
    Returns:
    this
    See Also:
    setMerged(boolean)
  - setVersion
```
public ResourceMount setVersion(AbstractResourceVersion version)
```
    force a resource version, any IResourceVersionProvider ( setResourceVersionProvider(IResourceVersionProvider)) will be ignored. default is null
    
    Parameters:
    version - version
    
    Returns:
    this
  - setNoVersion
```
public ResourceMount setNoVersion()
```
    same as passing AbstractResourceVersion.NO_VERSION to setVersion(AbstractResourceVersion)
    
    Returns:
    this
    See Also:
    setVersion(AbstractResourceVersion)
  - autodetectVersion
```
public ResourceMount autodetectVersion()
```
    same as passing null to setVersion(AbstractResourceVersion)
    
    Returns:
    this
    See Also:
    setVersion(AbstractResourceVersion)
  - setMinVersion
```
public ResourceMount setMinVersion(AbstractResourceVersion minVersion)
```
    force a minimal version. default is null
    
    Parameters:
    minVersion -
    
    Returns:
    this
  - setMinVersion
```
public ResourceMount setMinVersion(int minVersionValue)
```
    Convenience method to use a SimpleResourceVersion as minVersion (e.g. suitable for RevisionVersionProvider)
    
    Parameters:
    minVersionValue - the minimal version
    
    Returns:
    this
  - unsetMinVersion
```
public ResourceMount unsetMinVersion()
```
    unset minimal version, same as passing null to setMinVersion(AbstractResourceVersion)
    
    Returns:
    this
  - setRequireVersion
```
public ResourceMount setRequireVersion(boolean requireVersion)
```
    IResourceVersionProvider might not always be able to detect the version of a resource. This might be ignored or cause an error depending. default is to cause an error (true)
    
    Parameters:
    requireVersion - whether version is required (true) or not (false). default is true
    
    Returns:
    this
  - setPath
```
public ResourceMount setPath(String path)
```
    the path to user for mounting. this might either be a prefix if multiple resources are mounted or the full name. if used as prefix, ResourceSpec.getFile() is appended
    
    Parameters:
    path - name or prefix for mount, with or without leading or trailing slashes
    
    Returns:
    this
  - setPath
```
public ResourceMount setPath(String prefix,
                    org.apache.wicket.ResourceReference ref)
```
    convenience method to use setPath(String) use a prefix and ResourceReference.getName().
    
    Parameters:
    prefix - path prefix prefix for mount, with or without leading or trailing slashes
    ref - a ResourceReference
    
    Returns:
    this
  - setPath
```
public ResourceMount setPath(String prefix,
                    org.apache.wicket.ResourceReference ref,
                    String suffix)
```
    convenience method to use setPath(String) use a prefix and ResourceReference.getName().
    
    Parameters:
    prefix - path prefix prefix for mount, with or without leading or trailing slashes
    ref - a ResourceReference
    suffix - suffix to append after ResourceReference.getName(), might be null
    
    Returns:
    this
  - setPath
```
public ResourceMount setPath(String prefix,
                    String name,
                    String suffix)
```
    convenience method to use setPath(String) use a prefix and a name
    
    Parameters:
    prefix - path prefix prefix for mount, with or without leading or trailing slashes
    name - a name
    suffix - suffix to append after ResourceReference.getName(), might be null
    
    Returns:
    this
  - setMountRedirect
```
public ResourceMount setMountRedirect(boolean mountRedirect)
```
    Parameters:
    mountRedirect - whether a redirected should be mounted from the unversioned path to the versioned path (only used if there is a version). default is true
    
    Returns:
    this
  - setLocale
```
public ResourceMount setLocale(Locale locale)
```
    Locale might either be detected from added ResourceSpecs or set manually.
    
    Parameters:
    locale - Locale for mounted resources
    
    Returns:
    this
    See Also:
    ResourceReference#setLocale(Locale)}
  - autodetectLocale
```
public ResourceMount autodetectLocale()
```
    Autodetect the locale. Same as passing null to setLocale(Locale)
    
    Returns:
    this
  - setStyle
```
public ResourceMount setStyle(String style)
```
    Style might either be detected from added ResourceSpecs or set manually.
    
    Parameters:
    style - Style for mounted resources
    
    Returns:
    this
    See Also:
    ResourceReference#setStyle(String)}
  - autodetectStyle
```
public ResourceMount autodetectStyle()
```
    Autodetect the style. Same as passing null to setStyle(String)
    
    Returns:
    this
  - setCacheDuration
```
public ResourceMount setCacheDuration(int cacheDuration)
```
    Set cache duration in seconds. default is autodetect (null). Must be >= 0
    
    Parameters:
    cacheDuration -
    
    Returns:
    this
    See Also:
    autodetectCacheDuration()
  - setDefaultCacheDuration
```
public ResourceMount setDefaultCacheDuration()
```
    Same as passing DEFAULT_CACHE_DURATION to setCacheDuration(int)
    
    Returns:
    this
  - setDefaultAggressiveCacheDuration
```
public ResourceMount setDefaultAggressiveCacheDuration()
```
    Same as passing DEFAULT_AGGRESSIVE_CACHE_DURATION to setCacheDuration(int)
    
    Returns:
    this
  - setDefaultAggresiveCacheDuration
```
@Deprecated
public ResourceMount setDefaultAggresiveCacheDuration()
```
    Deprecated. typo in name, it's aggressive with ss
    
    See Also:
    setDefaultAggressiveCacheDuration()
  - autodetectCacheDuration
```
public ResourceMount autodetectCacheDuration()
```
    autodetect cache duration: use minimum of all resource specs or DEFAULT_CACHE_DURATION if not available. Behavior might be overriden using #getCacheDuration()
    
    Returns:
    this
  - setResourceVersionProvider
```
public ResourceMount setResourceVersionProvider(IResourceVersionProvider resourceVersionProvider)
```
    Set the IResourceVersionProvider to use for AbstractResourceVersion detection
    
    Parameters:
    resourceVersionProvider - the resource version provider
    
    Returns:
    this
  - setMinifyJs
```
public ResourceMount setMinifyJs(Boolean minifyJs)
```
    Parameters:
    minifyJs - whether js should be minified (true) or not (false). Default is autodetect
    
    Returns:
    this
    See Also:
    autodetectMinifyJs()
  - autodetectMinifyJs
```
public ResourceMount autodetectMinifyJs()
```
    Autodetect wheter resource should be minified using a JS compressor. Default is to minify files ending with .js. Behavior might be overriden using doMinifyJs(String)
    
    Returns:
    this
  - setMinifyCss
```
public ResourceMount setMinifyCss(Boolean minifyCss)
```
    Parameters:
    minifyCss - whether css should be minified (true) or not (false). Default is autodetect
    
    Returns:
    this
    See Also:
    autodetectMinifyCss()
  - autodetectMinifyCss
```
public ResourceMount autodetectMinifyCss()
```
    Autodetect wheter resource should be minified using a CSS compressor. Default is to minify files ending with .css. Behavior might be overriden using doMinifyCss(String)
    
    Returns:
    this
  - setMountScope
```
public ResourceMount setMountScope(Class<?> mountScope)
```
    The mount scope to use. default is autodetect (null)
    
    Parameters:
    mountScope - mount scope
    
    Returns:
    this
    See Also:
    ResourceReference.getScope(), autodetectMountScope()
  - autodetectMountScope
```
public ResourceMount autodetectMountScope()
```
    Same as passing null to setMountScope(Class). Autodetect: either use the scope that all (merged) resources are using or use ResourceMount as mount scope.
    
    Returns:
    this
  - getPreProcessor
```
public IResourcePreProcessor getPreProcessor()
```
    Returns:
    the current IResourcePreProcessor
  - setPreProcessor
```
public ResourceMount setPreProcessor(IResourcePreProcessor preProcessor)
```
    use an IResourcePreProcessor to modify resources (e.g. replace properties, change relative to absolute paths, ...)
    
    Parameters:
    preProcessor -
    
    Returns:
    this
  - getSuffixMismatchStrategy
```
public ResourceMount.SuffixMismatchStrategy getSuffixMismatchStrategy()
```
    Returns:
    current suffixMismatchStrategy
  - setSuffixMismatchStrategy
```
public ResourceMount setSuffixMismatchStrategy(ResourceMount.SuffixMismatchStrategy suffixMismatchStrategy)
```
    Parameters:
    suffixMismatchStrategy - the new strategy
    
    Returns:
    this
  - addResourceSpec
```
public ResourceMount addResourceSpec(ResourceSpec resourceSpec)
```
    Parameters:
    resourceSpec - add a new ResourceSpec
    
    Returns:
    this
  - addResourceSpec
```
public ResourceMount addResourceSpec(Class<?> scope,
                            String name)
```
    add a new ResourceSpec with this scope and name
    
    Parameters:
    scope - scope
    name - name
    
    Returns:
    this
  - addResourceSpecs
```
public ResourceMount addResourceSpecs(Class<?> scope,
                             String... names)
```
    add a new ResourceSpec with this scope and each name
    
    Parameters:
    scope - scope
    names - names
    
    Returns:
    this
  - addResourceSpec
```
public ResourceMount addResourceSpec(Class<?> scope,
                            String name,
                            Locale locale,
                            String style,
                            Integer cacheDuration)
```
    add a new ResourceSpec with this scope, name, locale, style and cacheDuration
    
    Parameters:
    scope - scope
    name - name
    locale - locale
    style - style
    cacheDuration - cache duration
    
    Returns:
    this
  - addResourceSpecs
```
public ResourceMount addResourceSpecs(ResourceSpec... resourceSpecs)
```
    add all resource specs
    
    Parameters:
    resourceSpecs - array of ResourceSpecs to add
    
    Returns:
    this
  - addResourceSpecs
```
public ResourceMount addResourceSpecs(Iterable<? extends ResourceSpec> resourceSpecs)
```
    add all resource specs
    
    Parameters:
    resourceSpecs - Iterable of ResourceSpecs to add
    
    Returns:
    this
  - addResourceSpecMatchingSuffix
```
public ResourceMount addResourceSpecMatchingSuffix(Class<?> scope,
                                          String suffix)
```
    Adds a resource spec for a resource with the same name as the scope, adding a suffix. Example: if scope is Foo.class and suffix is "js", name will be "Foo.js"
    
    Parameters:
    scope - the scope
    suffix - the suffix
    
    Returns:
    this
  - addResourceSpecsMatchingSuffixes
```
public ResourceMount addResourceSpecsMatchingSuffixes(Class<?> scope,
                                             String... suffixes)
```
    same as addResourceSpecMatchingSuffix(Class, String) but using multiple suffixes
    
    Parameters:
    scope - the scope
    suffixes - the suffixes
    
    Returns:
    this
  - addResourceSpecsMatchingSuffix
```
public ResourceMount addResourceSpecsMatchingSuffix(Class<?> scope,
                                           Iterable<String> suffixes)
```
    same as addResourceSpecMatchingSuffix(Class, String) but using multiple suffixes
    
    Parameters:
    scope - the scope
    suffixes - the suffixes
    
    Returns:
    this
  - addResourceSpecsMatchingSuffix
```
public ResourceMount addResourceSpecsMatchingSuffix(Class<?>... scopes)
```
    uses the path (set by setPath(String)) to obtain a suffix to use with addResourceSpecMatchingSuffix(Class, String)
    
    Parameters:
    scopes -
    
    Returns:
    this
  - addResourceSpecsMatchingSuffix
```
public ResourceMount addResourceSpecsMatchingSuffix(String suffix,
                                           Class<?>... scopes)
```
  - addResourceSpec
```
public ResourceMount addResourceSpec(org.apache.wicket.ResourceReference ref)
```
    add a ResourceSpec using a ResourceReference
    
    Parameters:
    ref - the ResourceReference
    
    Returns:
    this
  - addResourceSpecs
```
public ResourceMount addResourceSpecs(org.apache.wicket.ResourceReference... refs)
```
    add a ResourceSpec for each ResourceReference
    
    Parameters:
    refs - the ResourceReferences
    
    Returns:
    this
  - mount
```
public ResourceMount mount(org.apache.wicket.protocol.http.WebApplication application)
```
    mount the ResourceSpec(s) added either as a single Resource or multiple Resource, depending on doMerge(). Might also mount a redirect for versioned path names. (e.g. from "/script/wicket-ajax.js" to "/script/wicket-ajax-1.3.6.js")
    
    Parameters:
    application - the application
    
    Returns:
    this
  - build
```
public org.apache.wicket.behavior.AbstractHeaderContributor build(org.apache.wicket.protocol.http.WebApplication application)
```
    same as mount(WebApplication), but returns an AbstractHeaderContributor to use in components
    
    Parameters:
    application - the application
    
    Returns:
    AbstractHeaderContributor to be used in components
  - build
```
public org.apache.wicket.behavior.AbstractHeaderContributor build(org.apache.wicket.protocol.http.WebApplication application,
                                                         String cssMediaType)
```
    same as mount(WebApplication), but returns an AbstractHeaderContributor to use in components
    
    Parameters:
    application - the application
    cssMediaType - CSS media type, e.g. "print" or null for no media type
    
    Returns:
    AbstractHeaderContributor to be used in components, all files ending with '.css' will be rendered with passed cssMediaType
  - newHeaderContributor
```
protected org.apache.wicket.behavior.AbstractHeaderContributor newHeaderContributor(List<org.apache.wicket.ResourceReference> refs,
                                                                        String cssMediaType)
```
    Parameters:
    refs - a list of ResourceReferences
    
    Returns:
    an AbstractHeaderContributor that renders references to all CSS and JS resources contained in refs
  - newStrategy
```
protected org.apache.wicket.request.target.coding.IRequestTargetUrlCodingStrategy newStrategy(String mountPath,
                                                                                  org.apache.wicket.ResourceReference ref,
                                                                                  boolean merge)
```
    create a new IRequestTargetUrlCodingStrategy
    
    Parameters:
    mountPath - the mount path
    ref - the ResourceReference
    merge - if true, all resources obtained by getResourceSpecs() should be merged
    
    Returns:
    this
  - newRedirectStrategy
```
protected org.apache.wicket.request.target.coding.IRequestTargetUrlCodingStrategy newRedirectStrategy(String mountPath,
                                                                                          String redirectPath)
```
    create a new IRequestTargetUrlCodingStrategy to redirect from mountPath to redirectPath
    
    Parameters:
    mountPath - the path to redirect from
    redirectPath - the path to redirect to
    
    Returns:
    a new IRequestTargetUrlCodingStrategy
  - getPath
```
public final String getPath()
                     throws IResourceVersionProvider.VersionException,
                            AbstractResourceVersion.IncompatibleVersionsException
```
    Returns:
    the path, same as passing null and null to getPath(String, ResourceSpec[])
    
    Throws:
    
    IResourceVersionProvider.VersionException - if version can't be found
    
    AbstractResourceVersion.IncompatibleVersionsException - if versions can't be compared
    See Also:
    #getPath(String, boolean)
  - getPath
```
public final String getPath(String appendName)
                     throws IResourceVersionProvider.VersionException,
                            AbstractResourceVersion.IncompatibleVersionsException
```
    Parameters:
    appendName -
    
    Returns:
    the path, same as passing appendName and null to getPath(String, ResourceSpec[])
    
    Throws:
    
    IResourceVersionProvider.VersionException - if version can't be found
    
    AbstractResourceVersion.IncompatibleVersionsException - if versions can't be compared
    See Also:
    #getPath(String, boolean)
  - getPath
```
public String getPath(String appendName,
             ResourceSpec[] specs)
               throws IResourceVersionProvider.VersionException,
                      AbstractResourceVersion.IncompatibleVersionsException,
                      IllegalStateException
```
    Parameters:
    appendName - the name to append after path
    specs - a list of specs to get the version from or null
    
    Returns:
    the path
    
    Throws:
    
    IResourceVersionProvider.VersionException - if version can't be found
    
    AbstractResourceVersion.IncompatibleVersionsException - if versions can't be compared
    
    IllegalStateException - if path not set
  - buildVersionedPath
```
protected String buildVersionedPath(String path,
                        AbstractResourceVersion version)
```
    create a versioned path out of the given path and the version. default is to append the version after a '-' in front of the last '.' in the path. (e.g. wicket-ajax-1.3.6.js) if there is no '.' in the path or only at the beginning, a '-' and the version will be appended (e.g. foobar-1.3.6 or .something-1.3.6
    
    Parameters:
    path - the path
    version - the version. must not be null but may be invalid (check version.isValid()!)
    
    Returns:
    the versioned path
  - getVersion
```
protected AbstractResourceVersion getVersion(ResourceSpec[] specs)
                                      throws IResourceVersionProvider.VersionException,
                                             AbstractResourceVersion.IncompatibleVersionsException
```
    detect the version. default implementation is to use the manually set version or detect it using IResourceVersionProvider from all specs.
    
    Parameters:
    specs - the specs to detect the version from
    
    Returns:
    the version
    
    Throws:
    
    IResourceVersionProvider.VersionException - If a version can't be determined from any resource and version is required (setRequireVersion(boolean))
    
    AbstractResourceVersion.IncompatibleVersionsException - if versions can't be compared
  - getScope
```
protected Class<?> getScope(ResourceSpec[] specs)
```
    get the mount scope. Either use the manually set scope ( setMountScope(Class) or detect it. Default is to use the scope of all specs if it is common or use ResourceMount
    
    Parameters:
    specs - the specs to obtain the scope for
    
    Returns:
    the scope
  - newResourceReference
```
protected org.apache.wicket.ResourceReference newResourceReference(Class<?> scope,
                                                       String name,
                                                       Locale locale,
                                                       String style,
                                                       int cacheDuration,
                                                       ResourceSpec[] resourceSpecs,
                                                       IResourcePreProcessor preProcessor)
```
    create a new ResourceReference
    
    Parameters:
    scope - scope
    name - name
    locale - locale
    style - style
    cacheDuration - cache duration
    resourceSpecs - resource specs
    
    Returns:
    a new ResourceReference
  - getLocale
```
protected Locale getLocale(ResourceSpec[] specs)
```
    detect the locale to use. Either use a manually chosen one ( setLocale(Locale)) or detect it from the given resource specs. An Exception will be thrown if locales of added resources aren't compatible. (e.g. 'de' and 'en'). The resource will always use the most specific locale. For instance, if 5 resources are 'en' and one is 'en_US', the locale will be 'en_US'
    
    Parameters:
    specs - the ResourceSpecs to get the locale for
    
    Returns:
    the locale
  - getStyle
```
protected String getStyle(ResourceSpec[] specs)
```
    detect the style to use. Default implementation is to either use a manually chosen one (setStyle(String)) or detect it from the given resource specs. An Exception will be thrown if styles of added resources aren't compatible. (e.g. 'foo' and 'bar', null and 'foo' are considered compatible). The resource will always use a style if at least one resource uses one. For instance, if 5 resources are don't have a style and one has 'foo', the style will be 'foo'
    
    Parameters:
    specs - the ResourceSpecs to get the style for
    
    Returns:
    the style
  - getCacheDuration
```
protected int getCacheDuration(ResourceSpec[] specs,
                   boolean versioned)
```
    detect the cache duration to use. Default implementation is to either use a manually chosen one (setCacheDuration(int)) or detect it from the given resource specs. The resource will always use the lowest cache duration or DEFAULT_CACHE_DURATION if it can't be detected
    
    Parameters:
    specs - the ResourceSpecs to get the cache duration for
    if - the resource is versioned.
    
    Returns:
    the cache duration in seconds
  - getResourceSpecs
```
protected ResourceSpec[] getResourceSpecs()
```
    Returns:
    the resource specs
  - doCompress
```
protected boolean doCompress(String file)
```
    Parameters:
    file - a file name
    
    Returns:
    whether this file should use gzip compression. default is to check the suffix of the file
    See Also:
    setCompressed(boolean), getCompressedSuffixes()
  - doMinifyJs
```
protected boolean doMinifyJs(String file)
```
    Parameters:
    file - a file name
    
    Returns:
    whether this file should be processed by a JS compressor. default is to minify files ending with '.js'
    See Also:
    setMinifyJs(Boolean)
  - doMinifyCss
```
protected boolean doMinifyCss(String file)
```
    Parameters:
    file - a file name
    
    Returns:
    whether this file should be processed by a CSS compressor. default is to minify files ending with '.css'
    See Also:
    setMinifyJs(Boolean)
  - doMerge
```
protected boolean doMerge()
```
    should the added ResourceSpecs be merged to a single resource, or should they be mounted idividually? default is to merge files ending with DEFAULT_MERGE_SUFFIXES
    
    Returns:
    See Also:
    setMerged(boolean), autodetectMerging(), getMergedSuffixes()
  - clearSpecs
```
public ResourceMount clearSpecs()
```
    clear all added ResourceSpecs
    
    Returns:
    this
  - getCompressedSuffixes
```
public Set<String> getCompressedSuffixes()
```
    Returns:
    the set of suffixes that will be compressed by default
    See Also:
    DEFAULT_COMPRESS_SUFFIXES
  - getMergedSuffixes
```
public Set<String> getMergedSuffixes()
```
    Returns:
    the set of suffixes that will be merged by default
    See Also:
    DEFAULT_MERGE_SUFFIXES
  - checkSuffixes
```
protected void checkSuffixes(String path,
                 Iterable<ResourceSpec> specs)
```
    check if suffixes of path and each RespurceSpec file match
    
    Throws:
    
    org.apache.wicket.WicketRuntimeException - if suffixes don't match and strategy is ResourceMount.SuffixMismatchStrategy.EXCEPTION
  - onSuffixMismatch
```
protected void onSuffixMismatch(String resource,
                    String path)
```
    apply ResourceMount.SuffixMismatchStrategy without further checking, arguments are for logging only
    
    Throws:
    
    org.apache.wicket.WicketRuntimeException - if suffixes don't match and strategy is ResourceMount.SuffixMismatchStrategy.EXCEPTION
  - clone
```
public ResourceMount clone()
```
    a copy of the resource mount, with unfolded collections of compressed suffixes, merged suffices and ResourceSpecs
    
    Overrides:
    
    clone in class Object

Class ResourceMount

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CACHE_DURATION

DEFAULT_AGGRESSIVE_CACHE_DURATION

DEFAULT_AGGRESIVE_CACHE_DURATION

DEFAULT_COMPRESS_SUFFIXES

DEFAULT_MERGE_SUFFIXES

CSS_COMPRESSOR_KEY

Constructor Detail

ResourceMount

ResourceMount

Method Detail

mountWicketResources

mountWicketResources

mountWicketResourcesMerged

mountWicketResourcesMerged

enableAnnotations

mountAnnotatedPackageResources

mountAnnotatedPackageResources

mountAnnotatedPackageResources

getSuffix

setCssCompressor

getCssCompressor

setCompressed

autodetectCompression

setMerged

autodetectMerging

setVersion

setNoVersion

autodetectVersion

setMinVersion

setMinVersion

unsetMinVersion

setRequireVersion

setPath

setPath

setPath

setPath

setMountRedirect

setLocale

autodetectLocale

setStyle

autodetectStyle

setCacheDuration

setDefaultCacheDuration

setDefaultAggressiveCacheDuration

setDefaultAggresiveCacheDuration

autodetectCacheDuration

setResourceVersionProvider

setMinifyJs

autodetectMinifyJs

setMinifyCss

autodetectMinifyCss

setMountScope

autodetectMountScope

getPreProcessor

setPreProcessor

getSuffixMismatchStrategy

setSuffixMismatchStrategy

addResourceSpec

addResourceSpec

addResourceSpecs

addResourceSpec

addResourceSpecs

addResourceSpecs

addResourceSpecMatchingSuffix

addResourceSpecsMatchingSuffixes

addResourceSpecsMatchingSuffix

addResourceSpecsMatchingSuffix

addResourceSpecsMatchingSuffix

addResourceSpec

addResourceSpecs

mount

build

build