|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface RuntimeMetadataAdminAPI
| Method Summary | |
|---|---|
java.util.Set |
getAllDataNodeNames(java.lang.String vdbName,
java.lang.String vdbVersion)
Get all data element paths for a VDB version. |
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. |
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 metamatrixUserPwd)
Get the MaterializationLoadScripts for all materialized views in the materialization model
in this VDB. |
byte[] |
getVDB(VirtualDatabaseID vdbID)
Call to obtain the VDB Definition that can be used for importing or exporting. |
java.util.Collection |
getVDBModels(VirtualDatabaseID vdbID)
Returns a sorted Collection of type Model that represents
all the models that where 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 all the VirtualDatabases 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 from a supplied roles file to a newly deployed VDB. |
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 modelnamesAndConnectorBindingNames)
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. |
| Method Detail |
|---|
void updateVirtualDatabase(VirtualDatabase vdb)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
VirtualDataBase.
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 updating vdb.
MetaMatrixComponentException - if an error occurs in communicating with a component.
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.
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.
java.util.Map migrateConnectorBindingNames(VirtualDatabase sourceVDB,
VDBDefn vdb)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
sourceVDB - The source VirtualDatabase from which to search for models and thus,
connector binding names.vdb - represents a specific VDB Version
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.
void setConnectorBindingNames(VirtualDatabaseID vdbID,
java.util.Map modelnamesAndConnectorBindingNames)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
vdbID - ID of the VirtualDatabase.modelnamesAndConnectorBindingNames - Map of ModelIDs 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.
java.util.Collection getVDBsForConnectorBinding(java.lang.String routingID)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
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.
VirtualDatabase getVirtualDatabase(VirtualDatabaseID vdbID)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
VirtualDatabase specified by the VirtualDatabaseID.
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.
VirtualDatabase getLatestVirtualDatabase(java.lang.String vdbName)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
VirtualDatabase for the specified vdbName.
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 while setting the state.
MetaMatrixComponentException - if an error occurs in communicating with a component.
java.util.Collection getVirtualDatabases()
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
Collection of all the VirtualDatabases in the system.
This would include all virtual databases flagged as incomplete, active, inactive or 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 setting the state.
MetaMatrixComponentException - if an error occurs in communicating with a component.
java.util.Collection getVDBModels(VirtualDatabaseID vdbID)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
Collection of type Model that represents
all the models that where deployed in the specified virtual database.
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.
void setVDBState(VirtualDatabaseID vdbID,
short state)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
VirtualDatabase state.
The following four states are valid.
Incomplete = 1: The virtula database is not fully created yet. Set by runtime metadata during the creation of a new virtual database.
Inactive = 2: Not ready for use.
Active = 3: Ready for use.
Deleted =4: Ready for deletion.
vdbID - ID of the VirtualDatabase.state - the state the VirtualDatabase should be set to.
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.
EntitlementMigrationReport migrateEntitlements(VirtualDatabase sourceVDB,
VirtualDatabase targetVDB)
throws AuthorizationException,
InvalidSessionException,
MetaMatrixComponentException
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.
EntitlementMigrationReport migrateEntitlements(VirtualDatabase targetVDB,
char[] dataRoleContents,
boolean overwriteExisting)
throws AuthorizationException,
InvalidSessionException,
MetaMatrixComponentException
targetVDB - The new VDB to which to copy entitlements.dataRoleContents - Data Roles xml file contents.overwriteExisting - flag to determine if any existing roles 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.
PermissionDataNode getEntitlementTree(java.lang.String vDBName,
java.lang.String vDBVersion,
AuthorizationPolicyID policyID)
throws AuthorizationException,
InvalidSessionException,
MetaMatrixComponentException
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.
PermissionDataNode getDataNodes(java.lang.String vDBName,
java.lang.String vDBVersion)
throws AuthorizationException,
InvalidSessionException,
MetaMatrixComponentException
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.
java.util.Set getAllDataNodeNames(java.lang.String vdbName,
java.lang.String vdbVersion)
throws InvalidSessionException,
MetaMatrixComponentException
vdbName - The VDB name.vdbVersion - The version for the VDB.
InvalidSessionException
MetaMatrixComponentException
byte[] getVDB(VirtualDatabaseID vdbID)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
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.
VirtualDatabase importVDB(byte[] vdbStream)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
vdbDefn - is the VDB to be imported, this includes any new connector or
connector bindings.
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.
boolean validateConnectorBindingForMaterialization(ConnectorBinding materializationConnector)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
materializationConnector - The connector that will be validated.
true iff the given connector binding passes validation.
AuthorizationException
InvalidSessionException
VirtualDatabaseException
MetaMatrixComponentException
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 metamatrixUserPwd)
throws AuthorizationException,
InvalidSessionException,
VirtualDatabaseException,
MetaMatrixComponentException
MaterializationLoadScripts for all materialized views in the materialization model
in this VDB.
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.metamatrixUserPwd - Password of the MetaMatrix user.
AuthorizationException
InvalidSessionException
VirtualDatabaseException
MetaMatrixComponentException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||