dk.heick.properties.io

Class ManifestPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.ManifestPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public class ManifestPropertyIO
extends AbstractPropertyIO

ManifestPropertyIO id a readonly and cached PropertyIO.
This is a simple Manifest properties implementation which only reads any given manifest key value once.
So multiple values for a key is NOT loaded.

• Default : finding the "META-INF/MANIFEST.MF" in the URLClassLoader.findResource(String).
• Resource : finding the "<resource>" in the URLClassLoader.findResource(String).
• JarFile : Load the manifest from a JarFile instance.
• Archive file : Loading the manifest from a archive file, which ends with (".jar",".war",".ear" ,".zip").
• Manifest file : Loading the manifest from a file.
• ServletContext : Loading the manifest from ServletContext - getServletContext().getResourceAsStream("META-INF/MANIFEST.MF")).
• Manifest : Loading the manifest from a supplied instance of the manifest.
• URL : Loading the manifest from a JarFile URL - (JarURLConnection)getUrl().openConnection().

Since:

1.9

Author:

Frederik Heick

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ManifestPropertyIO.ArchiveFileFilter
(package private) static class	ManifestPropertyIO.INIT_METHOD

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MANIFEST_PATH The default manifest path "/META-INF/MANIFEST.MF"

Constructor Summary

Constructors

Constructor and Description
ManifestPropertyIO() Default constructor, read the "META-INF/MANIFEST.MF" found via the URLClassLoader.findResource(String).
ManifestPropertyIO(File file) Constructor.
ManifestPropertyIO(JarFile jarFile) Read the manifest file from a JarFile instance.
ManifestPropertyIO(Manifest manifest) Constructor, using a instance of a Manifest.
ManifestPropertyIO(javax.servlet.ServletContext servletContext) Finding the Manifest file via the ServletContext.
ManifestPropertyIO(String resourceName) Constructor, read the resourceName found via the URLClassLoader.findResource.
ManifestPropertyIO(URL url) Loads a manifest from jar file URL.

Method Summary

Modifier and Type	Method and Description
File	getFile() Either an archive file (".jar",".war",".ear" ,".zip") or a file directly to a manifest file.
JarFile	getJarFile() The jar file which the ManifestPropertyIO has been initialized with.
Manifest	getManifest() A manifest instance.
String	getName() A short descriptive name of the Property IO.
Properties	getProperties() Gets all the name,value pair in a Properties class instance.
String	getResourceName() The name of the resource a URLClassLoader will try to locate and load as a manifest file.
javax.servlet.ServletContext	getServletContext() The servletContext.
String	getSource() A detailed description of the source of the property data.
URL	getUrl() An archive file URL.
void	reload() Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time.
void	setValue(String propertyName, String value) Sets the name,value as String in the IO.
void	validate() Validates the PropertyIO.

Methods inherited from class dk.heick.properties.io.AbstractPropertyIO

backup, getCacheTime, getLastLoaded, getLastSaved, getLogger, getTypedProperties, getTypedValue, getValue, isCached, isReadonly, logPerformanceGetProperties, logPerformanceSetValue, setCacheTime, storeTypedValue, updateLastLoaded, updateLastSaved, validateWritable

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MANIFEST_PATH

public static final String DEFAULT_MANIFEST_PATH

The default manifest path "/META-INF/MANIFEST.MF"

See Also:

Constant Field Values

Constructor Detail

ManifestPropertyIO

public ManifestPropertyIO()

Default constructor, read the "META-INF/MANIFEST.MF" found via the URLClassLoader.findResource(String).

See Also:

URLClassLoader.findResource(String), DEFAULT_MANIFEST_PATH

ManifestPropertyIO

public ManifestPropertyIO(String resourceName)

Constructor, read the resourceName found via the URLClassLoader.findResource.

Parameters:

resourceName - the resource name

ManifestPropertyIO

public ManifestPropertyIO(JarFile jarFile)

Read the manifest file from a JarFile instance.
Remember to close the JarFile.

Parameters:

jarFile -

ManifestPropertyIO

public ManifestPropertyIO(File file)

Constructor.
If the file ends with (".jar",".war",".ear" ,".zip") it will loaded as a JarFile, otherwise it will assume that the path points directly to a manifest.mf file.
If it is a archive file, it is open like a JarFile and closed afterwards.

Parameters:

file - the file

ManifestPropertyIO

public ManifestPropertyIO(javax.servlet.ServletContext servletContext)

Finding the Manifest file via the ServletContext. getServletContext().getResourceAsStream("META-INF/MANIFEST.MF").

Parameters:

servletContext - the servletContext.

ManifestPropertyIO

public ManifestPropertyIO(URL url)

Loads a manifest from jar file URL.

Parameters:

url - the url to a jar file

ManifestPropertyIO

public ManifestPropertyIO(Manifest manifest)

Constructor, using a instance of a Manifest.

Parameters:

manifest - the manifest instance.

Method Detail

validate

public void validate()
              throws PropertyIOException

Description copied from interface: PropertyIO

Validates the PropertyIO.

Throws:

PropertyIOException

getResourceName

public final String getResourceName()

The name of the resource a URLClassLoader will try to locate and load as a manifest file.

Returns:

the resourceName, if initalized with this, otherwise null.

getJarFile

public final JarFile getJarFile()

The jar file which the ManifestPropertyIO has been initialized with.

Returns:

the jar file, if initalized with this, otherwise null.

getFile

public File getFile()

Either an archive file (".jar",".war",".ear" ,".zip") or a file directly to a manifest file.

Returns:

the file if initalized with this, otherwise null.

getServletContext

public javax.servlet.ServletContext getServletContext()

The servletContext.

Returns:

servletContext if initalized with this, otherwise null.

getManifest

public Manifest getManifest()

A manifest instance.

Returns:

manifest, if initalized with this, otherwise null.

getUrl

public URL getUrl()

An archive file URL.

Returns:

the url to an archive, if initalized with this, otherwise null.

getName

public String getName()

Description copied from interface: PropertyIO

A short descriptive name of the Property IO.

Returns:

a short descriptive name of the PropertyIO class.

getSource

public String getSource()

Description copied from interface: PropertyIO

A detailed description of the source of the property data.

Returns:

a data source description.

setValue

public final void setValue(String propertyName,
                           String value)
                    throws PropertyIOException

Description copied from interface: PropertyIO

Sets the name,value as String in the IO. Many IO implementations reloads when a value is set to refresh cache.
This is recommended, but the framework will update cache items with new values.

Parameters:

propertyName - the name of the property

value - the string value of the property.

Throws:

PropertyIOException - if the IO is readonly or failed to write the value.

getProperties

public Properties getProperties()

Description copied from interface: PropertyIO

Gets all the name,value pair in a Properties class instance.

Returns:

the Properties available for the IO.

See Also:

Properties

reload

public void reload()

Description copied from interface: PropertyIO

Reloads the name,value pairs for the PropertyIO, or forces the values to reload when read next time. Remember to both reset properties and typed value cache if used.

Specified by:

reload in interface PropertyIO

Overrides:

reload in class AbstractPropertyIO