org.spincast.core.utils

Class SpincastUtilsDefault

java.lang.Object

org.spincast.core.utils.SpincastUtilsDefault

All Implemented Interfaces:

SpincastUtils

public class SpincastUtilsDefault
extends Object
implements SpincastUtils

Implementations of the Spincast utilities.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SpincastUtilsDefault(SpincastConfig spincastConfig)

Method Summary

Modifier and Type	Method and Description
File	getAppJarDirectory() Returns the working directory: the directory in which the executable .jar is located.
String	getCacheBusterCode() The cache buster to use.
protected String	getCurrentVersionFromPom()
Locale	getLocaleBestMatchFromAcceptLanguageHeader(String header) Gets the best Locale to use given a "Accept-Language" HTTP header.
String	getMimeTypeFromExtension(String extension) Gets the mime type from the extension.
String	getMimeTypeFromMultipleSources(String responseContentTypeHeader, String resourcePath, String requestPath) Gets the mime type using multiple sources of information.
String	getMimeTypeFromPath(String path) Gets the mime type from a path, using its extension.
protected SpincastConfig	getSpincastConfig()
String	getSpincastCurrentVersion() Gets the current Spincast version.
boolean	isContentTypeToSkipGziping(String contentType) Should the specified Content-Type be gzipped?
String	readClasspathFile(String path) Reads a file on the classpath on returns it as a String.
String	readClasspathFile(String path, String encoding) Reads a file on the classpath on returns it as a String.
String	removeCacheBusterCodes(String text) Removes the cache buster code occurences from the given text.
void	zipDirectory(File directoryToZip, File targetZipFile, boolean includeDirItself) Zips a directory.
void	zipExtract(File zipFile, File targetDir) Extracts a .zip file to the specified directory.

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

SpincastUtilsDefault

@Inject
public SpincastUtilsDefault(SpincastConfig spincastConfig)

Method Detail

getSpincastConfig

protected SpincastConfig getSpincastConfig()

isContentTypeToSkipGziping

public boolean isContentTypeToSkipGziping(String contentType)

Description copied from interface: SpincastUtils

Should the specified Content-Type be gzipped?

Specified by:

isContentTypeToSkipGziping in interface SpincastUtils

getMimeTypeFromMultipleSources

public String getMimeTypeFromMultipleSources(String responseContentTypeHeader,
                                             String resourcePath,
                                             String requestPath)

Description copied from interface: SpincastUtils

Gets the mime type using multiple sources of information.

Specified by:

getMimeTypeFromMultipleSources in interface SpincastUtils

resourcePath - the path (absolute or relative) to the target resource. Can be null.

requestPath - the path of the current request. Can be null.

Returns:

the mime type or null if it can't be decided.

getMimeTypeFromPath

public String getMimeTypeFromPath(String path)

Description copied from interface: SpincastUtils

Gets the mime type from a path, using its extension.

Specified by:

getMimeTypeFromPath in interface SpincastUtils

Returns:

the mime type or null if it can't be decided.

getMimeTypeFromExtension

public String getMimeTypeFromExtension(String extension)

Description copied from interface: SpincastUtils

Gets the mime type from the extension.

Specified by:

getMimeTypeFromExtension in interface SpincastUtils

Returns:

the mime type or null if it can't be decided.

getLocaleBestMatchFromAcceptLanguageHeader

public Locale getLocaleBestMatchFromAcceptLanguageHeader(String header)

Description copied from interface: SpincastUtils

Gets the best Locale to use given a "Accept-Language" HTTP header.

Specified by:

getLocaleBestMatchFromAcceptLanguageHeader in interface SpincastUtils

Returns:

the best Locale to use or null if the given header can't be parsed.

getAppJarDirectory

public File getAppJarDirectory()

Description copied from interface: SpincastUtils

Returns the working directory: the directory in which the executable .jar is located.

Specified by:

getAppJarDirectory in interface SpincastUtils

Returns:

the working directory or null if the application is running inside an IDE.

getSpincastCurrentVersion

public String getSpincastCurrentVersion()

Description copied from interface: SpincastUtils

Gets the current Spincast version.

Specified by:

getSpincastCurrentVersion in interface SpincastUtils

getCurrentVersionFromPom

protected String getCurrentVersionFromPom()

zipDirectory

public void zipDirectory(File directoryToZip,
                         File targetZipFile,
                         boolean includeDirItself)

Description copied from interface: SpincastUtils

Zips a directory.

Specified by:

zipDirectory in interface SpincastUtils

targetZipFile - the target .zip file. If the parent directories don't exist, tries to create them.

zipExtract

public void zipExtract(File zipFile,
                       File targetDir)

Description copied from interface: SpincastUtils

Extracts a .zip file to the specified directory.

Specified by:

zipExtract in interface SpincastUtils

targetDir - The target directory. If it doesn't exist, tried to create it (and its parents, if required).

getCacheBusterCode

public String getCacheBusterCode()

Description copied from interface: SpincastUtils

The cache buster to use.

This should probably change each time the application is restarted or at least redeployed.

It should also be in such a format that it's possible to remove it from a given text.

This must be kept in sync with removeCacheBusterCode!

Specified by:

getCacheBusterCode in interface SpincastUtils

removeCacheBusterCodes

public String removeCacheBusterCodes(String text)

Description copied from interface: SpincastUtils

Removes the cache buster code occurences from the given text.

Note that this won't simply remove the current cache busting code, it will remove any valid cache busting code... This is what we want since we don't want a client sending a request containing an old cache busting code to break!

This must be kept in sync with getCacheBusterCode!

Specified by:

removeCacheBusterCodes in interface SpincastUtils

readClasspathFile

public String readClasspathFile(String path)

Description copied from interface: SpincastUtils

Reads a file on the classpath on returns it as a String.

Paths are always considered from the root at the classpath. You can start the path with a "/" or not, it makes no difference.

Uses the UTF-8 encoding.

Specified by:

readClasspathFile in interface SpincastUtils

Returns:

the content of the file or null if not found.

readClasspathFile

public String readClasspathFile(String path,
                                String encoding)

Description copied from interface: SpincastUtils

Reads a file on the classpath on returns it as a String.

Paths are always considered from the root at the classpath. You can start the path with a "/" or not, it makes no difference.

Specified by:

readClasspathFile in interface SpincastUtils

Returns:

the content of the file or null if not found.