org.spincast.plugins.routing

Class StaticResourceBuilder<R extends IRequestContext<?>,W extends IWebsocketContext<?>>

java.lang.Object

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

All Implemented Interfaces:

IStaticResourceBuilder<R>

public class StaticResourceBuilder<R extends IRequestContext<?>,W extends IWebsocketContext<?>>
extends Object
implements IStaticResourceBuilder<R>

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StaticResourceBuilder(boolean isDir, IStaticResourceFactory<R> staticResourceFactory, IStaticResourceCorsConfigFactory staticResourceCorsConfigFactory, IStaticResourceCacheConfigFactory staticResourceCacheConfigFactory, ISpincastConfig spincastConfig, ISpincastUtils spincastUtils, ISpincastRouterConfig spincastRouterConfig)
StaticResourceBuilder(IRouter<R,W> router, boolean isDir, IStaticResourceFactory<R> staticResourceFactory, IStaticResourceCorsConfigFactory staticResourceCorsConfigFactory, IStaticResourceCacheConfigFactory staticResourceCacheConfigFactory, ISpincastConfig spincastConfig, ISpincastUtils spincastUtils, ISpincastRouterConfig spincastRouterConfig)

Method Summary

Modifier and Type	Method and Description
IStaticResourceBuilder<R>	cache(int seconds)
IStaticResourceBuilder<R>	cache(int seconds, boolean isCachePrivate)
IStaticResourceBuilder<R>	cache(int seconds, boolean isCachePrivate, Integer cdnSeconds)
IStaticResourceBuilder<R>	classpath(String path)
IStaticResourceBuilder<R>	cors()
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins)
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead)
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent)
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies)
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, int maxAgeInSeconds)
IStaticResource<R>	create()
protected Integer	getCacheCdnSecondsDefault()
IStaticResourceCacheConfig	getCacheConfig()
IStaticResourceCorsConfig	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 IStaticResourceCacheConfig	getDefaultCacheConfig() The default cache configurations to use if it is not specified.
IHandler<R>	getGenerator()
String	getPath()
protected IRouter<R,W>	getRouter()
protected ISpincastConfig	getSpincastConfig()
protected ISpincastRouterConfig	getSpincastRouterConfig()
protected ISpincastUtils	getSpincastUtils()
protected IStaticResourceCacheConfigFactory	getStaticResourceCacheConfigFactory()
protected IStaticResourceCorsConfigFactory	getStaticResourceCorsConfigFactory()
protected IStaticResourceFactory<R>	getStaticResourceFactory()
String	getUrl()
protected boolean	isCachePrivateDefault() Is the cache private by default?
boolean	isClasspath()
protected boolean	isDir()
IStaticResourceBuilder<R>	pathAbsolute(String absolutePath)
IStaticResourceBuilder<R>	pathRelative(String relativePath)
void	save()
void	save(IHandler<R> generator)
IStaticResourceBuilder<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

StaticResourceBuilder

public StaticResourceBuilder(boolean isDir,
                             IStaticResourceFactory<R> staticResourceFactory,
                             IStaticResourceCorsConfigFactory staticResourceCorsConfigFactory,
                             IStaticResourceCacheConfigFactory staticResourceCacheConfigFactory,
                             ISpincastConfig spincastConfig,
                             ISpincastUtils spincastUtils,
                             ISpincastRouterConfig spincastRouterConfig)

StaticResourceBuilder

public StaticResourceBuilder(IRouter<R,W> router,
                             boolean isDir,
                             IStaticResourceFactory<R> staticResourceFactory,
                             IStaticResourceCorsConfigFactory staticResourceCorsConfigFactory,
                             IStaticResourceCacheConfigFactory staticResourceCacheConfigFactory,
                             ISpincastConfig spincastConfig,
                             ISpincastUtils spincastUtils,
                             ISpincastRouterConfig spincastRouterConfig)

Method Detail

isDir

protected boolean isDir()

getRouter

protected IRouter<R,W> getRouter()

getStaticResourceFactory

protected IStaticResourceFactory<R> getStaticResourceFactory()

getStaticResourceCorsConfigFactory

protected IStaticResourceCorsConfigFactory getStaticResourceCorsConfigFactory()

getStaticResourceCacheConfigFactory

protected IStaticResourceCacheConfigFactory getStaticResourceCacheConfigFactory()

getSpincastConfig

protected ISpincastConfig getSpincastConfig()

getSpincastUtils

protected ISpincastUtils getSpincastUtils()

getSpincastRouterConfig

protected ISpincastRouterConfig getSpincastRouterConfig()

getUrl

public String getUrl()

getPath

public String getPath()

isClasspath

public boolean isClasspath()

getGenerator

public IHandler<R> getGenerator()

getCorsConfig

public IStaticResourceCorsConfig getCorsConfig()

getCacheConfig

public IStaticResourceCacheConfig getCacheConfig()

url

public IStaticResourceBuilder<R> url(String url)

Specified by:

url in interface IStaticResourceBuilder<R extends IRequestContext<?>>

classpath

public IStaticResourceBuilder<R> classpath(String path)

Specified by:

classpath in interface IStaticResourceBuilder<R extends IRequestContext<?>>

pathAbsolute

public IStaticResourceBuilder<R> pathAbsolute(String absolutePath)

Specified by:

pathAbsolute in interface IStaticResourceBuilder<R extends IRequestContext<?>>

pathRelative

public IStaticResourceBuilder<R> pathRelative(String relativePath)

Specified by:

pathRelative in interface IStaticResourceBuilder<R extends IRequestContext<?>>

cors

public IStaticResourceBuilder<R> cors()

Specified by:

cors in interface IStaticResourceBuilder<R extends IRequestContext<?>>

cors

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

Specified by:

cors in interface IStaticResourceBuilder<R extends IRequestContext<?>>

cors

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

Specified by:

cors in interface IStaticResourceBuilder<R extends IRequestContext<?>>

cors

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

Specified by:

cors in interface IStaticResourceBuilder<R extends IRequestContext<?>>

cors

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

Specified by:

cors in interface IStaticResourceBuilder<R extends IRequestContext<?>>

cors

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

Specified by:

cors in interface IStaticResourceBuilder<R extends IRequestContext<?>>

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 IStaticResourceBuilder<R> cache(int seconds)

Specified by:

cache in interface IStaticResourceBuilder<R extends IRequestContext<?>>

cache

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

Specified by:

cache in interface IStaticResourceBuilder<R extends IRequestContext<?>>

cache

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

Specified by:

cache in interface IStaticResourceBuilder<R extends IRequestContext<?>>

save

public void save()

Specified by:

save in interface IStaticResourceBuilder<R extends IRequestContext<?>>

save

public void save(IHandler<R> generator)

Specified by:

save in interface IStaticResourceBuilder<R extends IRequestContext<?>>

create

public IStaticResource<R> create()

Specified by:

create in interface IStaticResourceBuilder<R extends IRequestContext<?>>

getDefaultCacheConfig

protected IStaticResourceCacheConfig 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.