uk.org.ogsadai.examples.demoFactory
Class DemoInstanceDataResourceAccessor

java.lang.Object
  |
  +--uk.org.ogsadai.examples.demoFactory.DemoInstanceDataResourceAccessor

All Implemented Interfaces:

DataResourceAccessor, DemoNameProvider, PersistInFiles

public class DemoInstanceDataResourceAccessor

extends java.lang.Object

implements DataResourceAccessor, PersistInFiles, DemoNameProvider

A very simple data resource accessor designed to be used to demonstrate dynamic creation of data service resources.

The dynamically created data service resource will use this accessor. This data resource accessor has only one configuration file called name.txt which contains a string. The value of this string can be retrieved via either a resource property called {https://ogsadai.org.uk/namespaces/2005/10/properties}name or via the getName() method.

Author:

The OGSA-DAI Project Team

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE

Copyright statement

See Also:

Constant Field Values

mResourceName

private java.lang.String mResourceName

Name of data service resource

mName

private java.lang.String mName

A simple name value

NAME_PROPERTY_QNAME

public static final javax.xml.namespace.QName NAME_PROPERTY_QNAME

Name of resource property holding the name value

DemoInstanceDataResourceAccessor

public DemoInstanceDataResourceAccessor()

setResourceName

public void setResourceName(java.lang.String resourceName)

Description copied from interface: DataResourceAccessor

Sets the name of the resource. This method will be called one before any other methods in this interface are called. Data resource accessors are not required to do anything with this name although it is sometimes useful to include it in any error messages.

Specified by:

setResourceName in interface DataResourceAccessor

Parameters:

resourceName - Name of the data service resource which will use this data resource accessor to mediate access to a data resource.

restoreFromConfig

public void restoreFromConfig(java.io.File directory)
                       throws DataResourceAccessorConfigException,
                              DataResourceAccessorMetaDataException,
                              DataResourceAccessorSetupException,
                              java.lang.IllegalArgumentException

Description copied from interface: PersistInFiles

Configures the data resource accessor by reading any relevant configuration files in the given directory.

If a data service resource is being constructed by reading from a configuration file this method will be called once immediately after the setName method is called. The data resource accessor should read its configuration from the files in the given directory of the data service resource which uses it.

Data resource accessors are free to add, amend or delete files in the given directory at any time throughout their lifetime. The exception to this rule is the dataResourceClassConfig.xml file which must be left unaltered since this specifies the data resource accessor class name.

Specified by:

restoreFromConfig in interface PersistInFiles

Parameters:

directory - Directory containing the data service resource configuration files. This includes the data resource accessor configuration files.

Throws:

java.lang.IllegalArgumentException - if the directory argument is null or is not a directory.

DataResourceAccessorSetupException - if an error occurs when setting up the data resource accessor after having read the configuration files.

DataResourceAccessorConfigException - if an error occurs reading the configuration files.

DataResourceAccessorMetaDataException - if an error occurs when constructing data resource accessor meta data properties.

getProperties

public Property[] getProperties()

Description copied from interface: DataResourceAccessor

Gets the resource properties associated with the data resource accessor. These are made available as properties of the data service resource to which the data resource accessor belongs.

This method should be called once after the readConfig method has been called but before any other methods are called.

Specified by:

getProperties in interface DataResourceAccessor

Returns:

The resource proporties. If there are no resource properties then a zero-sized array will be returned.

getName

public java.lang.String getName()

Gets the name value.

Specified by:

getName in interface DemoNameProvider

Returns:

the name value.