org.spincast.core.routing

Interface IStaticResourceBuilder<R extends IRequestContext<?>>

All Known Implementing Classes:

StaticResourceBuilder

public interface IStaticResourceBuilder<R extends IRequestContext<?>>

Builder to create static resources.

Method Summary

Modifier and Type	Method and Description
IStaticResourceBuilder<R>	cache(int seconds) Adds public cache headers.
IStaticResourceBuilder<R>	cache(int seconds, boolean isPrivate) Adds cache headers.
IStaticResourceBuilder<R>	cache(int seconds, boolean isPrivate, Integer secondsCdn) Adds cache headers.
IStaticResourceBuilder<R>	classpath(String path) The path to the resource, on the classpath.
IStaticResourceBuilder<R>	cors() Enables Cross-Origin Resource Sharing (Cors)
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins) Enables Cross-Origin Resource Sharing (Cors)
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead) Enables Cross-Origin Resource Sharing (Cors)
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent) Enables Cross-Origin Resource Sharing (Cors)
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies) Enables Cross-Origin Resource Sharing (Cors)
IStaticResourceBuilder<R>	cors(Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, int maxAgeInSeconds) Enables Cross-Origin Resource Sharing (Cors)
IStaticResource<R>	create() Creates and returns the static resource without adding it to the router.
IStaticResourceBuilder<R>	pathAbsolute(String absolutePath) The absolute path to the resource, on the file system.
IStaticResourceBuilder<R>	pathRelative(String relativePath) The path to the resource, on the file system, relative to the temp Spincast directory, as returned by ISpincastConfig::getSpincastTempDir()
void	save() Saves the static resource route to the router.
void	save(IHandler<R> generator) Saves the static resource route.
IStaticResourceBuilder<R>	url(String url) The URL pointing to the resource.

Method Detail

url

IStaticResourceBuilder<R> url(String url)

The URL pointing to the resource.

classpath

IStaticResourceBuilder<R> classpath(String path)

The path to the resource, on the classpath.

pathAbsolute

IStaticResourceBuilder<R> pathAbsolute(String absolutePath)

The absolute path to the resource, on the file system.

Parameters:

absolutePath - the absolute path to the resource. If this is a file and not a directory, remember that it will be served as a static resource, so its extension is important for the correct Content-Type to be sent!

pathRelative

IStaticResourceBuilder<R> pathRelative(String relativePath)

The path to the resource, on the file system, relative to the temp Spincast directory, as returned by ISpincastConfig::getSpincastTempDir()

Parameters:

relativePath - the relative path to the resource. If this is a file and not a directory, remember that it will be served as a static resource, so its extension is important for the correct Content-Type to be sent!

cors

IStaticResourceBuilder<R> cors()

Enables Cross-Origin Resource Sharing (Cors)

See Also:

ISpincastFilters#cors(R context)

cors

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

Enables Cross-Origin Resource Sharing (Cors)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins)

cors

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

Enables Cross-Origin Resource Sharing (Cors)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead)

cors

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

Enables Cross-Origin Resource Sharing (Cors)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent)

cors

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

Enables Cross-Origin Resource Sharing (Cors)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies)

cors

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

Enables Cross-Origin Resource Sharing (Cors)

See Also:

ISpincastFilters#cors(R context, Set<String> allowedOrigins, Set<String> extraHeadersAllowedToBeRead, Set<String> extraHeadersAllowedToBeSent, boolean allowCookies, int maxAgeInSeconds )

cache

IStaticResourceBuilder<R> cache(int seconds)

Adds public cache headers.

Parameters:

seconds - The number of seconds the resource associated with this route should be cached.

cache

IStaticResourceBuilder<R> cache(int seconds,
                                boolean isPrivate)

Adds cache headers.

Parameters:

seconds - The number of seconds the resource associated with this route should be cached.

isPrivate - should the cache be private? (help)

cache

IStaticResourceBuilder<R> cache(int seconds,
                                boolean isPrivate,
                                Integer secondsCdn)

Adds cache headers.

Parameters:

seconds - The number of seconds the resource associated with this route should be cached.

isPrivate - should the cache be private? (help)

secondsCdn - The number of seconds the resource associated with this route should be cached by a CDN/proxy. If null, it won't be used.

save

void save()

Saves the static resource route to the router. If the creation of the resource was not started using an IRouter object, an exception will be thrown.

save

void save(IHandler<R> generator)

Saves the static resource route. If the creation of the resource was not started using an IRouter object, an exception will be thrown.

Parameters:

generator - If the resource is not found, the specified generator will be used to generate it and the result will be saved.

create

IStaticResource<R> create()

Creates and returns the static resource without adding it to the router. NOTE : use save(...) instead to save the static resource to the router at the end of the build process!