com.ibm.ram.client.batch
Class BatchDataSource

java.lang.Object
  extended by com.ibm.ram.client.batch.BatchDataSource

public abstract class BatchDataSource
extends java.lang.Object

Represents the extension point that third parties can use to transform legacy repositories to a Rational Asset Manager repository. Implementors must implement the fetchAssets and return a list of data that is in the format of a Rational Asset Manager asset.

Since:
7.1
Author:
kbauer

Constructor Summary
BatchDataSource()
          Implementor need to maintain a default constructor.
 
Method Summary
abstract  Asset[] fetchAssets(RAMStatusMonitor monitor)
          This is your main method.
 RAMSession getTargetSession()
          Returns the Target RAM Session set by the batch client
abstract  java.lang.String getTypeId()
          Return the Type Identifier
abstract  void initialize(java.lang.String metadata)
          This method will be called after construction and will pass Initialize your meatdata from saved XML.
abstract  java.lang.String save()
          Save the Data Source into a Batch Update XML file.
 void setTargetSession(RAMSession targetSession)
          Called when the target session is changed in the batch client.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BatchDataSource

public BatchDataSource()
Implementor need to maintain a default constructor. Use the initialize method to construct your object

Since:
7.1
Method Detail

initialize

public abstract void initialize(java.lang.String metadata)
This method will be called after construction and will pass Initialize your meatdata from saved XML.

Parameters:
metadata -
Since:
7.1

save

public abstract java.lang.String save()
Save the Data Source into a Batch Update XML file. Pass in a String contains the XML you would like to save

Parameters:
metadata -
Since:
7.1

fetchAssets

public abstract Asset[] fetchAssets(RAMStatusMonitor monitor)
This is your main method. When fetch asset is called the implementor should return them metadata they have configured to in the for of Assets and the spaghetti ball that goes with it.

Parameters:
monitor -
Returns:
Since:
7.1

getTypeId

public abstract java.lang.String getTypeId()
Return the Type Identifier

Returns:
the id
Since:
7.1

getTargetSession

public RAMSession getTargetSession()
Returns the Target RAM Session set by the batch client

Returns:
the targetSession
Since:
7.1.0.1

setTargetSession

public void setTargetSession(RAMSession targetSession)
Called when the target session is changed in the batch client.

Parameters:
targetSession - the targetSession to set
Since:
7.1.0.1