dk.heick.properties.io

Class AbstractURLPropertyIO

java.lang.Object

dk.heick.properties.io.AbstractPropertyIO

dk.heick.properties.io.AbstractURLPropertyIO

All Implemented Interfaces:

PropertyIO, Serializable

public abstract class AbstractURLPropertyIO
extends AbstractPropertyIO

Abstract PropertyIO which gets Properties from an URL location.
This can be done in many many ways, with lot of secrity around it, which there should be.
But for now this is the parent class for all those remote class to inherite.

I can imaging several ways and parameters. Here are some ideas.

• Only https
• The server only accept certain URLs
• Mayby a private/public key encryption schema.
• Parameters like, environment, project, application, service etc.
• Mayby an API key, which mayby is timeshiftet (Changes every minut)

Since:

1.9

Author:

Frederik Heick

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractURLPropertyIO(URL url) Constructor, where cache and readonly is true.

Method Summary

Modifier and Type	Method and Description
Properties	getProperties() Gets the Properties from method "getPropertiesFromUrl()", tihs incapsulates the performance logging and exception handling.
protected abstract Properties	getPropertiesFromUrl() Abstract method to retrieve the Properties from an URL and mayby another parameters which is provided in the instance constructor.
String	getSource() The source of the properties (URL)
URL	getUrl() The URL
void	setValue(String propertyName, String value) The setValue method which allways gives an exception, since they can not be set through this PropertyIO.
void	validate() Validates the PropertyIO, veirfies that the URL is not null and the Properties could be retrived.

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface dk.heick.properties.PropertyIO

getName

Constructor Detail

AbstractURLPropertyIO

public AbstractURLPropertyIO(URL url)

Constructor, where cache and readonly is true.

Parameters:

url - the URL

Method Detail

getUrl

public final URL getUrl()

The URL

Returns:

the remote URL

getProperties

public final Properties getProperties()

Gets the Properties from method "getPropertiesFromUrl()", tihs incapsulates the performance logging and exception handling.

Returns:

the Properties available for the IO.

See Also:

Properties

getPropertiesFromUrl

protected abstract Properties getPropertiesFromUrl()
                                            throws PropertyIOException

Abstract method to retrieve the Properties from an URL and mayby another parameters which is provided in the instance constructor.

Returns:

a Properties instance.

Throws:

PropertyIOException - if the Properties could not be loaded.

getSource

public final String getSource()

The source of the properties (URL)

Returns:

a data source description.

setValue

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

The setValue method which allways gives an exception, since they can not be set through this PropertyIO.

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.

validate

public void validate()
              throws PropertyIOException

Validates the PropertyIO, veirfies that the URL is not null and the Properties could be retrived.

Throws:

PropertyIOException