|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl com.metamatrix.server.admin.apiimpl.RuntimeMetadataAdminAPIImpl
public class RuntimeMetadataAdminAPIImpl
Method Summary | |
---|---|
java.util.Set |
getAllDataNodeNames(java.lang.String vdbName,
java.lang.String vdbVersion)
Get all data element paths for a VDB version. |
java.util.Map |
getConnectorBindingNames(VirtualDatabaseID vdbID)
Get connector binding names for a given virtual database. |
PermissionDataNode |
getDataNodes(java.lang.String vDBName,
java.lang.String vDBVersion)
Get the tree of data nodes that make op a VDB. |
PermissionDataNode |
getEntitlementTree(java.lang.String vDBName,
java.lang.String vDBVersion,
AuthorizationPolicyID policyID)
Returns the entitlement tree for a given VDB version. |
static RuntimeMetadataAdminAPI |
getInstance()
|
VirtualDatabase |
getLatestVirtualDatabase(java.lang.String vdbName)
Returns the latest VirtualDatabase for the specified vdbName. |
MaterializationLoadScripts |
getMaterializationScripts(ConnectorBinding materializationConnector,
VDBDefn vdb,
java.lang.String mmHost,
java.lang.String mmPort,
java.lang.String materializationUserName,
java.lang.String materializationUserPwd,
java.lang.String metamatrixUserName,
java.lang.String metamatrixPwd)
Get the MaterializationLoadScripts for all materialized views in the materialization model
in this VDB. |
java.util.Map |
getModelVisibilityLevels(VirtualDatabaseID vdbID)
Get the visibility levels for models in a given virtual database. |
byte[] |
getVDB(VirtualDatabaseID vdbID)
Call to export a VDB to the local file system |
java.util.Collection |
getVDBModels(VirtualDatabaseID vdbID)
Returns a sorted Collection of type Model that represents
all the models that were deployed in the specified virtual database. |
java.util.Collection |
getVDBsForConnectorBinding(java.lang.String routingID)
Given a routing ID, find all VDBs whose models use the connector binding. |
VirtualDatabase |
getVirtualDatabase(VirtualDatabaseID vdbID)
Returns the VirtualDatabase specified by the VirtualDatabaseID . |
java.util.Collection |
getVirtualDatabases()
Returns a Collection of the VirtualDatabase s in the system. |
VirtualDatabase |
importVDB(byte[] vdbStream)
Call to import a VDB |
void |
markVDBForDelete(VirtualDatabaseID vdbID)
Mark a VirtualDataBase (VDB) for deletion. |
java.util.Map |
migrateConnectorBindingNames(VirtualDatabase sourceVDB,
VDBDefn vdb)
Migrate connector binding names from models in a virtual database, filling in connector binding names possible for the models in the DTCInfo. |
EntitlementMigrationReport |
migrateEntitlements(VirtualDatabase targetVDB,
char[] dataRoleContents,
boolean overwriteExisting)
Migrate as many existing entitlements as possible to a newly deployed VDB from a supplied roles xml file. |
EntitlementMigrationReport |
migrateEntitlements(VirtualDatabase sourceVDB,
VirtualDatabase targetVDB)
Migrate as many existing entitlements as possible to a newly deployed VDB. |
void |
setConnectorBindingNames(VirtualDatabaseID vdbID,
java.util.Map modelAndCBNames)
Set connector binding names for models in a virtual database. |
void |
setVDBState(VirtualDatabaseID vdbID,
short state)
Updates the VirtualDatabase state. |
void |
updateVirtualDatabase(VirtualDatabase vdb)
Update a modified VirtualDataBase . |
boolean |
validateConnectorBindingForMaterialization(ConnectorBinding materializationConnector)
Validate the given connector binding is capable for connectivity to a Materialization. |
Methods inherited from class com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl |
---|
getSessionID |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static RuntimeMetadataAdminAPI getInstance() throws MetaMatrixComponentException
MetaMatrixComponentException
public void updateVirtualDatabase(VirtualDatabase vdb) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
VirtualDataBase
.
updateVirtualDatabase
in interface RuntimeMetadataAdminAPI
vdb
- the modified VirtualDatabase.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public void markVDBForDelete(VirtualDatabaseID vdbID) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
VirtualDataBase
(VDB) for deletion.
The VDB will not actually be deleted until there are no more users using it.
markVDBForDelete
in interface RuntimeMetadataAdminAPI
callerSessionID
- ID of the caller's current session.vdbID
- the ID of the VirtualDatabase that is to be deleted.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while updating vdb.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public java.util.Map migrateConnectorBindingNames(VirtualDatabase sourceVDB, VDBDefn vdb) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
migrateConnectorBindingNames
in interface RuntimeMetadataAdminAPI
callerSessionID
- ID of the caller's current session.sourceVDB
- The source VirtualDatabase from which to search for models and thus,
connector binding names.dtc
- The DTC that contains the models for which to attach String Connector Binding names. This param gets modified.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public void setConnectorBindingNames(VirtualDatabaseID vdbID, java.util.Map modelAndCBNames) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
setConnectorBindingNames
in interface RuntimeMetadataAdminAPI
callerSessionID
- vdbID
- ID of the VirtualDatabase.modelAndCBNames
- Map of ModelID
s to String Connector Binding names.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public java.util.Map getConnectorBindingNames(VirtualDatabaseID vdbID) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
getConnectorBindingNames
in interface RuntimeMetadataAdminAPI
vdbID
- ID of the VirtualDatabase.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public java.util.Collection getVDBsForConnectorBinding(java.lang.String routingID) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
getVDBsForConnectorBinding
in interface RuntimeMetadataAdminAPI
callerSessionID
- The caller's session ID.routingID
- ID of the connector binding.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public VirtualDatabase getVirtualDatabase(VirtualDatabaseID vdbID) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
VirtualDatabase
specified by the VirtualDatabaseID
.
getVirtualDatabase
in interface RuntimeMetadataAdminAPI
callerSessionID
- ID of the caller's current session.vdbID
- ID of the VirtualDatabase.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.public VirtualDatabase getLatestVirtualDatabase(java.lang.String vdbName) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
VirtualDatabase
for the specified vdbName.
getLatestVirtualDatabase
in interface RuntimeMetadataAdminAPI
callerSessionID
- ID of the caller's current session.vdbName
- is the name of the VirtualDatabase.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs during retrieval process.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public java.util.Collection getVirtualDatabases() throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
Collection
of the VirtualDatabase
s in the system.
This would include all virtual databases flagged as incomplete, active, inactive or deleted.
getVirtualDatabases
in interface RuntimeMetadataAdminAPI
callerSessionID
- ID of the caller's current session.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.public java.util.Collection getVDBModels(VirtualDatabaseID vdbID) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
Collection
of type Model
that represents
all the models that were deployed in the specified virtual database.
getVDBModels
in interface RuntimeMetadataAdminAPI
callerSessionID
- ID of the caller's current session.vdbID
- ID of the VirtualDatabase.
AuthorizationException
- if caller is not authorized to perform this method.
MetaMatrixComponentException
- if an error occurs in communicating with a component.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while setting the state.public void setVDBState(VirtualDatabaseID vdbID, short state) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
VirtualDatabase
state.
The following four states are valid.
Incomplete: The virtula database is not fully created yet. Set by runtime metadata during the creation of a new virtual database.
Inactive: Not ready for use.
Active: Ready for use.
Deleted: Ready for deletion.
setVDBState
in interface RuntimeMetadataAdminAPI
callerSessionID
- ID of the caller's current session.vdbID
- ID of the VirtualDatabase.state
- the state the VirtualDatabase should be set to.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.public EntitlementMigrationReport migrateEntitlements(VirtualDatabase sourceVDB, VirtualDatabase targetVDB) throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
migrateEntitlements
in interface RuntimeMetadataAdminAPI
sourceVDB
- The existing VDB from which to copy entitlements.targetVDB
- The new VDB to which to copy entitlements.
InvalidSessionException
- if the administrative session is invalid
AuthorizationException
- if admninistrator does not have the authority to perform the requested operation.
MetaMatrixComponentException
- if this service has trouble communicating.public EntitlementMigrationReport migrateEntitlements(VirtualDatabase targetVDB, char[] dataRoleContents, boolean overwriteExisting) throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
migrateEntitlements
in interface RuntimeMetadataAdminAPI
sourceVDB
- The existing VDB from which to copy entitlements.dataRoleContents
- The contents of the Data Roles xml File.overwriteExisting
- flag to determine if existing entitlements should be overwritten.
InvalidSessionException
- if the administrative session is invalid
AuthorizationException
- if admninistrator does not have the authority to perform the requested operation.
MetaMatrixComponentException
- if this service has trouble communicating.public PermissionDataNode getEntitlementTree(java.lang.String vDBName, java.lang.String vDBVersion, AuthorizationPolicyID policyID) throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
getEntitlementTree
in interface RuntimeMetadataAdminAPI
vDBName
- The name of a VDB for which to get its model info.vDBVersion
- The name of a VDB version for which to get its model info.policyID
- The policy (entitlement) for which to constrain the search for permissions.
InvalidSessionException
- if the administrative session is invalid
AuthorizationException
- if admninistrator does not have the authority to perform the requested operation.
MetaMatrixComponentException
- if this service has trouble communicating.public PermissionDataNode getDataNodes(java.lang.String vDBName, java.lang.String vDBVersion) throws AuthorizationException, InvalidSessionException, MetaMatrixComponentException
getDataNodes
in interface RuntimeMetadataAdminAPI
vDBName
- The name of the VDB for which data nodes are sought.vDBVersion
- The version of the VDB for which data nodes are sought.
InvalidSessionException
- if the administrative session is invalid
AuthorizationException
- if admninistrator does not have the authority to perform the requested operation.
MetaMatrixComponentException
- if this service has trouble communicating.public java.util.Set getAllDataNodeNames(java.lang.String vdbName, java.lang.String vdbVersion) throws InvalidSessionException, MetaMatrixComponentException
getAllDataNodeNames
in interface RuntimeMetadataAdminAPI
callerSessionID
- The session ID of the administrator making the call.vdbName
- The VDB name.vdbVersion
- The version for the VDB.
InvalidSessionException
MetaMatrixComponentException
public byte[] getVDB(VirtualDatabaseID vdbID) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
getVDB
in interface RuntimeMetadataAdminAPI
vdbID
- ID of the VirtualDatabase.dirLocation
- is the path where the files will be savedvdbDefnFileName
- is the name of the VDB Definition file to be saved.
Visibility levels are defined in MetadataConstants.VISIBILITY_TYPES.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public VirtualDatabase importVDB(byte[] vdbStream) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
RuntimeMetadataAdminAPI
importVDB
in interface RuntimeMetadataAdminAPI
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public java.util.Map getModelVisibilityLevels(VirtualDatabaseID vdbID) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
getModelVisibilityLevels
in interface RuntimeMetadataAdminAPI
vdbID
- ID of the VirtualDatabase.
AuthorizationException
- if caller is not authorized to perform this method.
InvalidSessionException
- if the callerSessionID
is not valid or is expired.
VirtualDatabaseException
- if an error occurs while setting the state.
MetaMatrixComponentException
- if an error occurs in communicating with a component.public boolean validateConnectorBindingForMaterialization(ConnectorBinding materializationConnector) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
RuntimeMetadataAdminAPI
validateConnectorBindingForMaterialization
in interface RuntimeMetadataAdminAPI
materializationConnector
- The connector that will be validated.
true
iff the given connector binding passes validation.
AuthorizationException
InvalidSessionException
VirtualDatabaseException
MetaMatrixComponentException
com.metamatrix.server.admin.apiimpl.RuntimeMetadataAdminAPIInterface#validateConnectorBindingForMaterialization(ConnectorBinding)
public MaterializationLoadScripts getMaterializationScripts(ConnectorBinding materializationConnector, VDBDefn vdb, java.lang.String mmHost, java.lang.String mmPort, java.lang.String materializationUserName, java.lang.String materializationUserPwd, java.lang.String metamatrixUserName, java.lang.String metamatrixPwd) throws AuthorizationException, InvalidSessionException, VirtualDatabaseException, MetaMatrixComponentException
RuntimeMetadataAdminAPI
MaterializationLoadScripts
for all materialized views in the materialization model
in this VDB.
getMaterializationScripts
in interface RuntimeMetadataAdminAPI
materializationConnector
- the connector that will be used to connect to the Materialization.vdb
- the VDB to which the Materialization belongs.mmHost
- The host that the MetaMatrix server is running on.mmPort
- The MetaMatrix server port.materializationUserName
- The name of the user that will be logging in to the database that
holds this particular materialization and the user that the load/refresh scripts will run under.materializationUserPwd
- The password of the materialization user.metamatrixUserName
- User that will log into the MetaMatrix server to perform the refresh.metamatrixPwd
- Password of the MetaMatrix user.
AuthorizationException
InvalidSessionException
VirtualDatabaseException
MetaMatrixComponentException
com.metamatrix.server.admin.apiimpl.RuntimeMetadataAdminAPIInterface#getMaterializationScripts(com.metamatrix.common.config.api.ConnectorBinding, RMCVersionEntry, String, String, String, String, String, String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |