org.spincast.plugins.routing

Class StaticResourceBuilderDefault<R extends RequestContext<?>,W extends WebsocketContext<?>>

java.lang.Object

org.spincast.plugins.routing.StaticResourceBuilderDefault<R,W>

All Implemented Interfaces:

StaticResourceBuilder<R>

public class StaticResourceBuilderDefault<R extends RequestContext<?>,W extends WebsocketContext<?>>
extends Object
implements StaticResourceBuilder<R>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
StaticResourceBuilderDefault(boolean isDir, StaticResourceFactory<R> staticResourceFactory, StaticResourceCorsConfigFactory staticResourceCorsConfigFactory, StaticResourceCacheConfigFactory staticResourceCacheConfigFactory, SpincastConfig spincastConfig, SpincastUtils spincastUtils, SpincastRouterConfig spincastRouterConfig)
StaticResourceBuilderDefault(Router<R,W> router, boolean isDir, StaticResourceFactory<R> staticResourceFactory, StaticResourceCorsConfigFactory staticResourceCorsConfigFactory, StaticResourceCacheConfigFactory staticResourceCacheConfigFactory, SpincastConfig spincastConfig, SpincastUtils spincastUtils, SpincastRouterConfig spincastRouterConfig)

Method Summary

Modifier and Type	Method and Description
StaticResourceBuilder<R>	cache(int seconds)
StaticResourceBuilder<R>	cache(int seconds, boolean isCachePrivate)
StaticResourceBuilder<R>	cache(int seconds, boolean isCachePrivate, Integer cdnSeconds)
StaticResourceBuilder<R>	classpath(String path)
StaticResourceBuilder<R>	cors()
StaticResourceBuilder<R>	cors(Set<String> allowedOrigins)
StaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead)
StaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent)
StaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies)
StaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, int maxAgeInSeconds)
StaticResource<R>	create()
protected Integer	getCacheCdnSecondsDefault()
StaticResourceCacheConfig	getCacheConfig()
StaticResourceCorsConfig	getCorsConfig()
protected Set<String>	getCorsDefaultAllowedOrigins() The origins allowed, by default.
protected Set<String>	getCorsDefaultExtraHeadersAllowedToBeRead() The extra headers allowed to be read, by default,
protected Set<String>	getCorsDefaultExtraHeadersAllowedToBeSent() The extra headers allowed to be sent, by default,
protected boolean	getCorsDefaultIsCookiesAllowed() Are cookies allowed by default?
protected int	getCorsDefaultMaxAgeInSeconds() If <= 0, the "Access-Control-Max-Age" header won't be sent.
protected StaticResourceCacheConfig	getDefaultCacheConfig() The default cache configurations to use if it is not specified.
Handler<R>	getGenerator()
String	getPath()
protected Router<R,W>	getRouter()
protected SpincastConfig	getSpincastConfig()
protected SpincastRouterConfig	getSpincastRouterConfig()
protected SpincastUtils	getSpincastUtils()
protected StaticResourceCacheConfigFactory	getStaticResourceCacheConfigFactory()
protected StaticResourceCorsConfigFactory	getStaticResourceCorsConfigFactory()
protected StaticResourceFactory<R>	getStaticResourceFactory()
String	getUrl()
protected boolean	isCachePrivateDefault() Is the cache private by default?
boolean	isClasspath()
protected boolean	isDir()
boolean	isIgnoreQueryString()
StaticResourceBuilder<R>	pathAbsolute(String absolutePath)
StaticResourceBuilder<R>	pathRelative(String relativePath)
void	save()
void	save(Handler<R> generator)
void	save(Handler<R> generator, boolean ignoreQueryString)
StaticResourceBuilder<R>	url(String url)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

StaticResourceBuilderDefault

public StaticResourceBuilderDefault(boolean isDir,
                                    StaticResourceFactory<R> staticResourceFactory,
                                    StaticResourceCorsConfigFactory staticResourceCorsConfigFactory,
                                    StaticResourceCacheConfigFactory staticResourceCacheConfigFactory,
                                    SpincastConfig spincastConfig,
                                    SpincastUtils spincastUtils,
                                    SpincastRouterConfig spincastRouterConfig)

StaticResourceBuilderDefault

public StaticResourceBuilderDefault(Router<R,W> router,
                                    boolean isDir,
                                    StaticResourceFactory<R> staticResourceFactory,
                                    StaticResourceCorsConfigFactory staticResourceCorsConfigFactory,
                                    StaticResourceCacheConfigFactory staticResourceCacheConfigFactory,
                                    SpincastConfig spincastConfig,
                                    SpincastUtils spincastUtils,
                                    SpincastRouterConfig spincastRouterConfig)

Method Detail

isDir

protected boolean isDir()

getRouter

protected Router<R,W> getRouter()

getStaticResourceFactory

protected StaticResourceFactory<R> getStaticResourceFactory()

getStaticResourceCorsConfigFactory

protected StaticResourceCorsConfigFactory getStaticResourceCorsConfigFactory()

getStaticResourceCacheConfigFactory

protected StaticResourceCacheConfigFactory getStaticResourceCacheConfigFactory()

getSpincastConfig

protected SpincastConfig getSpincastConfig()

getSpincastUtils

protected SpincastUtils getSpincastUtils()

getSpincastRouterConfig

protected SpincastRouterConfig getSpincastRouterConfig()

getUrl

public String getUrl()

getPath

public String getPath()

isClasspath

public boolean isClasspath()

getGenerator

public Handler<R> getGenerator()

getCorsConfig

public StaticResourceCorsConfig getCorsConfig()

getCacheConfig

public StaticResourceCacheConfig getCacheConfig()

isIgnoreQueryString

public boolean isIgnoreQueryString()

url

public StaticResourceBuilder<R> url(String url)

Specified by:

url in interface StaticResourceBuilder<R extends RequestContext<?>>

classpath

public StaticResourceBuilder<R> classpath(String path)

Specified by:

classpath in interface StaticResourceBuilder<R extends RequestContext<?>>

pathAbsolute

public StaticResourceBuilder<R> pathAbsolute(String absolutePath)

Specified by:

pathAbsolute in interface StaticResourceBuilder<R extends RequestContext<?>>

pathRelative

public StaticResourceBuilder<R> pathRelative(String relativePath)

Specified by:

pathRelative in interface StaticResourceBuilder<R extends RequestContext<?>>

cors

public StaticResourceBuilder<R> cors()

Specified by:

cors in interface StaticResourceBuilder<R extends RequestContext<?>>

cors

public StaticResourceBuilder<R> cors(Set<String> allowedOrigins)

Specified by:

cors in interface StaticResourceBuilder<R extends RequestContext<?>>

cors

public StaticResourceBuilder<R> cors(Set<String> allowedOrigins,
                                     Set<String> extraHeadersAllowedToBeRead)

Specified by:

cors in interface StaticResourceBuilder<R extends RequestContext<?>>

cors

public StaticResourceBuilder<R> cors(Set<String> allowedOrigins,
                                     Set<String> extraHeadersAllowedToBeRead,
                                     Set<String> extraHeadersAllowedToBeSent)

Specified by:

cors in interface StaticResourceBuilder<R extends RequestContext<?>>

cors

public StaticResourceBuilder<R> cors(Set<String> allowedOrigins,
                                     Set<String> extraHeadersAllowedToBeRead,
                                     Set<String> extraHeadersAllowedToBeSent,
                                     boolean allowCookies)

Specified by:

cors in interface StaticResourceBuilder<R extends RequestContext<?>>

cors

public StaticResourceBuilder<R> cors(Set<String> allowedOrigins,
                                     Set<String> extraHeadersAllowedToBeRead,
                                     Set<String> extraHeadersAllowedToBeSent,
                                     boolean allowCookies,
                                     int maxAgeInSeconds)

Specified by:

cors in interface StaticResourceBuilder<R extends RequestContext<?>>

getCorsDefaultMaxAgeInSeconds

protected int getCorsDefaultMaxAgeInSeconds()

If <= 0, the "Access-Control-Max-Age" header won't be sent.

getCorsDefaultAllowedOrigins

protected Set<String> getCorsDefaultAllowedOrigins()

The origins allowed, by default.

getCorsDefaultExtraHeadersAllowedToBeRead

protected Set<String> getCorsDefaultExtraHeadersAllowedToBeRead()

The extra headers allowed to be read, by default,

getCorsDefaultExtraHeadersAllowedToBeSent

protected Set<String> getCorsDefaultExtraHeadersAllowedToBeSent()

The extra headers allowed to be sent, by default,

getCorsDefaultIsCookiesAllowed

protected boolean getCorsDefaultIsCookiesAllowed()

Are cookies allowed by default?

isCachePrivateDefault

protected boolean isCachePrivateDefault()

Is the cache private by default?

getCacheCdnSecondsDefault

protected Integer getCacheCdnSecondsDefault()

cache

public StaticResourceBuilder<R> cache(int seconds)

Specified by:

cache in interface StaticResourceBuilder<R extends RequestContext<?>>

cache

public StaticResourceBuilder<R> cache(int seconds,
                                      boolean isCachePrivate)

Specified by:

cache in interface StaticResourceBuilder<R extends RequestContext<?>>

cache

public StaticResourceBuilder<R> cache(int seconds,
                                      boolean isCachePrivate,
                                      Integer cdnSeconds)

Specified by:

cache in interface StaticResourceBuilder<R extends RequestContext<?>>

save

public void save()

Specified by:

save in interface StaticResourceBuilder<R extends RequestContext<?>>

save

public void save(Handler<R> generator)

Specified by:

save in interface StaticResourceBuilder<R extends RequestContext<?>>

save

public void save(Handler<R> generator,
                 boolean ignoreQueryString)

Specified by:

save in interface StaticResourceBuilder<R extends RequestContext<?>>

create

public StaticResource<R> create()

Specified by:

create in interface StaticResourceBuilder<R extends RequestContext<?>>

getDefaultCacheConfig

protected StaticResourceCacheConfig getDefaultCacheConfig()

The default cache configurations to use if it is not specified. It can still be null and, in that case, no cache header will be used.