org.spincast.core.utils

Interface SpincastUtils

All Known Implementing Classes:

SpincastUtilsDefault

public interface SpincastUtils

Spincast utilities.

Method Summary

Modifier and Type	Method and Description
File	getAppJarDirectory() If the project is running from an executable .jar file, this will return the directory containing this .jar file.
File	getAppRootDirectoryNoJar() If the project is not running from an executable .jar file, this will return the root directory of the project on the file system.
String	getCacheBusterCode() The cache buster to use.
Locale	getLocaleBestMatchFromAcceptLanguageHeader(String acceptLanguageHeader) 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.
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 and returns it as a String.
String	readClasspathFile(String path, String encoding) Reads a file on the classpath and 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.

Method Detail

zipDirectory

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

Zips a directory.

Parameters:

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

If - true, the directory itself will be included in the zip file, otherwise only its content will be.

zipExtract

void zipExtract(File zipFile,
                File targetDir)

Extracts a .zip file to the specified directory.

Parameters:

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

getMimeTypeFromMultipleSources

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

Gets the mime type using multiple sources of information.

Parameters:

contentTypeHeader - an already existing Content-Type header on the response. Can be null.

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

String getMimeTypeFromPath(String path)

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

Returns:

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

getMimeTypeFromExtension

String getMimeTypeFromExtension(String extension)

Gets the mime type from the extension.

Returns:

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

getLocaleBestMatchFromAcceptLanguageHeader

Locale getLocaleBestMatchFromAcceptLanguageHeader(String acceptLanguageHeader)

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

Returns:

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

isContentTypeToSkipGziping

boolean isContentTypeToSkipGziping(String contentType)

Should the specified Content-Type be gzipped?

getAppJarDirectory

File getAppJarDirectory()

If the project is running from an executable .jar file, this will return the directory containing this .jar file.

Returns:

the directory path or null if the application is not running from an executable .jar file.

getAppRootDirectoryNoJar

File getAppRootDirectoryNoJar()

If the project is not running from an executable .jar file, this will return the root directory of the project on the file system.

Returns:

the directory path or null if the application is running from an executable .jar file.

getSpincastCurrentVersion

String getSpincastCurrentVersion()

Gets the current Spincast version.

getCacheBusterCode

String getCacheBusterCode()

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!

removeCacheBusterCodes

String removeCacheBusterCodes(String text)

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!

readClasspathFile

String readClasspathFile(String path)

Reads a file on the classpath and 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.

Returns:

the content of the file or null if not found.

readClasspathFile

String readClasspathFile(String path,
                         String encoding)

Reads a file on the classpath and 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.

Returns:

the content of the file or null if not found.