Package com.ibm.datapower.wamt.dataAPI

Defines a collection of interfaces for data persistence that can be implemented to support a repository in various environments.

See:
          Description

Interface Summary
Persistable An interface to identify which classes should be persisted to a repository.
Repository The object used for executing persistence operations such as retrieving and saving Stored objects available with the dataAPI
StoredDeployableConfiguration The version information that must be maintained and persisted for a managed Domain that represents a domain on a DataPower device.
StoredDeployablePolicy The information related to a DeploymentPolicy that must be managed and persisted when domain configuration is deployed to a DataPower device.
StoredDeploymentPolicy The information that must be maintained and persisted for a DeploymentPolicy that is used in deploying a managed domain configuration.
StoredDeploymentPolicyVersion The related information that must be maintained and persisted for a DeploymentPolicyVersion.
StoredDevice All device related information that must be maintained and persisted for a physical DataPower device, i.e Device.
StoredDomain It represents a domain on a DataPower device and holds all information that must be maintained and persisted for a Domain.
StoredDomainVersion Information that must be maintained and persisted for a version of a Domain object in the repository.
StoredFirmware The information related to Firmware that must be maintained and persisted for a firmware that can be deployed to a device.
StoredFirmwareVersion The information that must be maintained and persisted for a firmware level, See FirmwareVersion.
StoredManagedSet The information that must be maintained and persisted for a ManagedSet including its managed device members.
StoredTag The information that must be maintained and persisted for a Device and Domain including its tagged device and domain members.
StoredVersion Information for a version of a Firmware, Domain or Deployment Policy that must be maintained and persisted.
 

Class Summary
PackageInfo Get the SCM information about all the classes in this package.
RepositoryFactory Factory for creating/manufacturing the Repository object.
 

Exception Summary
AlreadyExistsInRepositoryException This exception is thrown if an attempt is made to create/add an instance of an object that already exists in the repository
DatastoreException This is the root class for exceptions that are thrown from the dataAPI package.
DirtySaveException This exception is thrown if an attempt is made to save data after another user has made changes which will not be reflected in the saved repository.
NotEmptyInRepositoryException This exception is thrown if an attempt is made to delete an instance that contains other instances.
NotExistInRepositoryException This exception is thrown if an attempt is made to delete an instance that does not exist in the repository.
 

Package com.ibm.datapower.wamt.dataAPI Description

Defines a collection of interfaces for data persistence that can be implemented to support a repository in various environments. Included in this collection are definitions for objects such as ManagedSets, Devices, Firmware images, Domains and Deployment policies. These classes define the interface which must be used for any concrete implementation. The manager provides one such implementation with its Local File system repository support.

An implementation of the interface should allow callers to persist information related to common operations and features supported by IBM WebSphere Appliance Management Toolkit clientAPI. All clientAPI objects which need to be persisted, example Device, implement the Persistable interface. The clientAPI correlates a clientAPI object to an implementation of the related dataAPI Stored object. For example:

Local File System Implementation

The local file system implementation of the dataAPI persists all information needed by the manager to the local file system. This is the default implementation of the dataAPI interface. Any alternate implementation must be specified when the Manager is instantiated. The data is stored in multiple files whose location can be specified by the WAMT_REPOS_HOME JVM parameter.


-DWAMT_REPOS_HOME="C:\WAMTRepository" Would cause the manager to write the data file in the directory C:\WAMTRepository

The manager persists information about the persistable objects in the WAMT.Repository.xml file. This XML file contains elements that represent Java objects such as ManagedSets, Devices, FirmWares, and Domains. It also contains elements that represent the different FirmWare and Domain versions deployed to DataPower devices. The manager can also persist large binary objects of firmware, and versions of domain and deployment policies in BIN files. These BIN files are created in the location specified by the WAMT_REPOS_HOME java environment variable. The names of the BIN files are referenced in the WAMT.Repository.xml within the FirmWare and Domain elements.

The dataAPI is designed as a pluggable with the expectation that different runtime environments would use different persistence technologies (i.e., DB2, WCCM, Local File System). If you use the default local file system implementation when the Manager is instantiated, all data will be persisted to the local file system. Sample code to dynamically load drivers at Manager instantiation:


Map options = new HashMap();
options.put(Manager.OPTION_REPOSITORY_IMPL, "com.ibm.datapower.wamt.dataAPI.local.filesystem.RepositoryImpl");
manager = Manager.getInstance(options);

Local File System Implementation Artifacts

The WAMT.Repository.xml file contains elements that represent ManagedSet objects, Device objects, FirmWare Objects, and Domain objects. It also contains elements that represent the different FirmWare and Domains version deployed to DataPower devices. The BIN files are firmwares and domain configurations that have been deployed and referenced within WAMT.Repository.xml. The figure below shows the XML and BIN files generated by the dataAPI implementation.

repository directory diagram

Data in WAMT.Repository.xml File

If you are using the local file system implementation, use the WAMT.Repository.xml file to verify the persisted information.

See the figures below for an explanation of the information persisted in the xml file.

MSetDeviceElement.JPG
FirmwaresElement.JPG
DomainsElement.JPG

Back Up Generated files

Save all the files created by the local file system implementation, if you plan to back up your repository



© Copyright IBM Corp. 2006, 2010 All Rights Reserved.