com.metamatrix.platform.admin.api
Class EntitlementMigrationReport

java.lang.Object
  com.metamatrix.platform.admin.api.EntitlementMigrationReport

All Implemented Interfaces:

java.io.Serializable

public class EntitlementMigrationReport
extends java.lang.Object
implements java.io.Serializable

Defines an object for holding results of an entitlement migration. A migration report is generated when an attempt is made to migrate all entitlements from a source VDB to a target VDB.

All values in each line (the inner list) are Strings.

The headere for each entry in the report are described as follows:

1. Migrated (Yes, No)
2. Resource (data node path)
3. Source PolicyID (The source AuthorizationPolicyID)
4. Target PolicyID (The target AuthorizationPolicyID that was created for migration)
5. Actions (CRUD labels)
6. Reason Migration Failed (Only filled in if this data node failed to migrate)

See Also:

Serialized Form

Field Summary

static int	ACTIONS_INDEX Index in inner list of where header's value resides.
static int	MIGRATED_INDEX Index in inner list of where header's value resides.
static int	NUMBER_OF_VALUES The number of values that can be expected in each line entry.
static int	REASON_INDEX Index in inner list of where header's value resides.
static int	RESOURCE_INDEX Index in inner list of where header's value resides.
static int	SOURCE_POLICYID_INDEX Index in inner list of where header's value resides.
static int	TARGET_POLICYID_INDEX Index in inner list of where header's value resides.

Constructor Summary

EntitlementMigrationReport(java.lang.String sourceVDB, java.lang.String targetVDB)
Construct with a source and a target VDB.

Method Summary

void	addResourceEntry(java.lang.Object migrated, java.lang.Object resource, java.lang.Object source_policy, java.lang.Object target_policy, java.lang.Object actions, java.lang.Object reason)
java.util.List	getEntries() Get all the entries in the report.
java.util.List	getHeaderList() Get the column headers in the report.
java.lang.String	getSourceVDBID() Get the source VDB ID from which the entitlement migration was attmpted.
java.lang.String	getTargetVDBID() Get the target VDB ID to which the entitlement migration was attmpted.
void	setSourceVDBID(java.lang.String sourceVDB) Set the source VDB ID from which the entitlement migration was attmpted.
void	setTargetVDBID(java.lang.String targetVDB) Set the target VDB ID to which the entitlement migration was attmpted.
java.lang.String	toString()
void	writeReport(java.lang.String fileName)

Methods inherited from class java.lang.Object

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

Field Detail

MIGRATED_INDEX

public static final int MIGRATED_INDEX

Index in inner list of where header's value resides.

See Also:

Constant Field Values

RESOURCE_INDEX

public static final int RESOURCE_INDEX

Index in inner list of where header's value resides.

See Also:

Constant Field Values

SOURCE_POLICYID_INDEX

public static final int SOURCE_POLICYID_INDEX

Index in inner list of where header's value resides.

See Also:

Constant Field Values

TARGET_POLICYID_INDEX

public static final int TARGET_POLICYID_INDEX

Index in inner list of where header's value resides.

See Also:

Constant Field Values

ACTIONS_INDEX

public static final int ACTIONS_INDEX

Index in inner list of where header's value resides.

See Also:

Constant Field Values

REASON_INDEX

public static final int REASON_INDEX

Index in inner list of where header's value resides.

See Also:

Constant Field Values

NUMBER_OF_VALUES

public static final int NUMBER_OF_VALUES

The number of values that can be expected in each line entry.

See Also:

Constant Field Values

Constructor Detail

EntitlementMigrationReport

public EntitlementMigrationReport(java.lang.String sourceVDB,
                                  java.lang.String targetVDB)

Construct with a source and a target VDB.

Parameters:

sourceVDB - The name and version of the source VDB.

targetVDB - The name and version of the target VDB.

Method Detail

addResourceEntry

public void addResourceEntry(java.lang.Object migrated,
                             java.lang.Object resource,
                             java.lang.Object source_policy,
                             java.lang.Object target_policy,
                             java.lang.Object actions,
                             java.lang.Object reason)

getSourceVDBID

public java.lang.String getSourceVDBID()

Get the source VDB ID from which the entitlement migration was attmpted.

Returns:

The source Virtual Database name and version.

setSourceVDBID

public void setSourceVDBID(java.lang.String sourceVDB)

Set the source VDB ID from which the entitlement migration was attmpted.

Parameters:

The - source Virtual Database name and version.

getTargetVDBID

public java.lang.String getTargetVDBID()

Get the target VDB ID to which the entitlement migration was attmpted.

Returns:

The target Virtual Database name and version.

setTargetVDBID

public void setTargetVDBID(java.lang.String targetVDB)

Set the target VDB ID to which the entitlement migration was attmpted.

Parameters:

The - target Virtual Database name and version.

getEntries

public java.util.List getEntries()

Get all the entries in the report. This is a List of Lists. The entries of the inner List are defined in this class' header.

Returns:

The report.

getHeaderList

public java.util.List getHeaderList()

Get the column headers in the report. This is a List of Strings. The values of this list reside at the index locations above.

Returns:

The header list.

writeReport

public void writeReport(java.lang.String fileName)
                 throws java.lang.Exception

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object