org.jahia.utils.zip

Class ZipEntryCharsetDetector

java.lang.Object

org.jahia.utils.zip.ZipEntryCharsetDetector

public final class ZipEntryCharsetDetector
extends Object

Charset detector for the ZIP file entries.

Author:

Sergiy Shyrkov

Field Summary

Fields

Modifier and Type	Field and Description
static String	ZIP_ENTRY_ALTERNATIVE_ENCODING

Constructor Summary

Constructors

Constructor and Description
ZipEntryCharsetDetector()

Method Summary

Modifier and Type	Method and Description
static Charset	detect(File zipFile) Returns the detected character set, which is suitable to read the entries of the provided ZIP file properly.
static Charset	detect(InputStream resettableInputStream) Returns the detected character set, which is suitable to read the entries of the provided ZIP file properly.
static Charset	detect(JCRFileContent zipFileNode) Returns the detected character set, which is suitable to read the entries of the provided ZIP file properly.
static Charset	detect(URL resourceUrl) Returns the detected character set, which is suitable to read the entries of the provided ZIP resource properly.

Methods inherited from class java.lang.Object

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

Field Detail

ZIP_ENTRY_ALTERNATIVE_ENCODING

public static final String ZIP_ENTRY_ALTERNATIVE_ENCODING

See Also:

Constant Field Values

Constructor Detail

ZipEntryCharsetDetector

public ZipEntryCharsetDetector()

Method Detail

detect

public static Charset detect(File zipFile)

Returns the detected character set, which is suitable to read the entries of the provided ZIP file properly. The set of charsets to try can be specified by the system property ZIP_ENTRY_ALTERNATIVE_ENCODING and also by the corresponding jahia.properties entry. If the method fails to detect the charset it returns null.

Parameters:

zipFile - the ZIP file to read entries from

Returns:

the detected character set, which is suitable to read the entries of the provided ZIP file properly or null if we fail to detect the charset

detect

public static Charset detect(InputStream resettableInputStream)

Returns the detected character set, which is suitable to read the entries of the provided ZIP file properly. The set of charsets to try can be specified by the system property ZIP_ENTRY_ALTERNATIVE_ENCODING and also by the corresponding jahia.properties entry. If the method fails to detect the charset it returns null.

Parameters:

zipFileResettableInputStream - a ZIP file stream that has proper support for InputStream.reset() method, e.g. is a ByteArrayInputStream

Returns:

the detected character set, which is suitable to read the entries of the provided ZIP file properly or null if we fail to detect the charset

detect

public static Charset detect(JCRFileContent zipFileNode)

Returns the detected character set, which is suitable to read the entries of the provided ZIP file properly. The set of charsets to try can be specified by the system property ZIP_ENTRY_ALTERNATIVE_ENCODING and also by the corresponding jahia.properties entry. If the method fails to detect the charset it returns null.

Parameters:

zipFile - the ZIP file to read entries from

Returns:

the detected character set, which is suitable to read the entries of the provided ZIP file properly or null if we fail to detect the charset

detect

public static Charset detect(URL resourceUrl)

Returns the detected character set, which is suitable to read the entries of the provided ZIP resource properly. The set of charsets to try can be specified by the system property ZIP_ENTRY_ALTERNATIVE_ENCODING and also by the corresponding jahia.properties entry. If the method fails to detect the charset it returns null.

Parameters:

resourceUrl - the URL of the resource to open a stream from

Returns:

the detected character set, which is suitable to read the entries of the provided ZIP resource properly or null if we fail to detect the charset