com.metamatrix.dqp.service
Interface VDBService

All Superinterfaces:

ApplicationService

All Known Implementing Classes:

EmbeddedVDBService, PlatformVDBService

public interface VDBService
extends ApplicationService

This interface defines methods which are specific to dealing with VDBs and their management in a server/dqp.

Method Summary

void	changeVDBStatus(java.lang.String vdbName, java.lang.String vdbVersion, int status) Change the status of the VDB
java.util.List<VDBArchive>	getAvailableVDBs() Get the list of VDBs available from the service
java.util.List	getConnectorBindingNames(java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String modelName) Get connector bindings for a particular vdb model.
java.lang.String	getConnectorName(java.lang.String connectorBindingID)
int	getFileVisibility(java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String pathInVDB) Get visibility of the file at the given path in the vdb.
int	getModelVisibility(java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String modelName) Get model visibility
java.util.List	getMultiSourceModels(java.lang.String vdbName, java.lang.String vdbVersion) Get all multi-source model names (models that can be bound to multiple connector bindings) for this VDB name and version.
java.io.InputStream	getVDBResource(java.lang.String vdbName, java.lang.String vdbVersion) Get VDB resource contents
int	getVDBStatus(java.lang.String vdbName, java.lang.String vdbVersion) Get the Status of VDB

Methods inherited from interface com.metamatrix.common.application.ApplicationService

initialize, start, stop

Method Detail

getConnectorBindingNames

java.util.List getConnectorBindingNames(java.lang.String vdbName,
                                        java.lang.String vdbVersion,
                                        java.lang.String modelName)
                                        throws MetaMatrixComponentException

Get connector bindings for a particular vdb model. For most models, there will be exactly one. For multi-source models, there may be more than one. The VDBConfiguration#getMultiSourceModels(String, String) method can be used to determine which models are multi-source models.

Parameters:

vdbName - VDB name

vdbVersion - VDB version

modelName - Model name

Returns:

list of String names of connectors

Throws:

MetaMatrixComponentException

getModelVisibility

int getModelVisibility(java.lang.String vdbName,
                       java.lang.String vdbVersion,
                       java.lang.String modelName)
                       throws MetaMatrixComponentException

Get model visibility

Parameters:

vdbName - VDB name

vdbVersion - VDB version

modelName - The name of the model

Returns:

Visibility constant, as defined in this class

Throws:

MetaMatrixComponentException

getFileVisibility

int getFileVisibility(java.lang.String vdbName,
                      java.lang.String vdbVersion,
                      java.lang.String pathInVDB)
                      throws MetaMatrixComponentException

Get visibility of the file at the given path in the vdb.

Parameters:

vdbName - VDB name

vdbVersion - VDB version

pathInVDB - The path to the model in the VDB

Returns:

Visibility constant, as defined in this class

Throws:

MetaMatrixComponentException

getVDBResource

java.io.InputStream getVDBResource(java.lang.String vdbName,
                                   java.lang.String vdbVersion)
                                   throws MetaMatrixComponentException

Get VDB resource contents

Parameters:

vdbName - VDB name

vdbVersion - VDB version

Returns:

VDB resource file name

Throws:

MetaMatrixComponentException

getMultiSourceModels

java.util.List getMultiSourceModels(java.lang.String vdbName,
                                    java.lang.String vdbVersion)
                                    throws MetaMatrixComponentException

Get all multi-source model names (models that can be bound to multiple connector bindings) for this VDB name and version.

Parameters:

vdbName - VDB name

vdbVersion - VDB version

Returns:

List of model names that are multi-source models.

Throws:

MetaMatrixComponentException

Since:

4.2

getAvailableVDBs

java.util.List<VDBArchive> getAvailableVDBs()
                                            throws MetaMatrixComponentException

Get the list of VDBs available from the service

Returns:

List of com.metamatrix.metadata.runtime.admin.vdb.VDBDefn

Throws:

MetaMatrixComponentException

Since:

4.3

getVDBStatus

int getVDBStatus(java.lang.String vdbName,
                 java.lang.String vdbVersion)
                 throws MetaMatrixComponentException

Get the Status of VDB

Parameters:

vdbName - - Name of the VDB

vdbVersion - - Version of the VDB

Returns:

int Current status of VDB

Throws:

MetaMatrixComponentException

Since:

4.3

changeVDBStatus

void changeVDBStatus(java.lang.String vdbName,
                     java.lang.String vdbVersion,
                     int status)
                     throws ApplicationLifecycleException,
                            MetaMatrixComponentException

Change the status of the VDB

Parameters:

vdbName - - Name of the VDB

vdbVersion - - Version of the VDB

status - -

Throws:

ApplicationLifecycleException

MetaMatrixComponentException

Since:

4.3

getConnectorName

java.lang.String getConnectorName(java.lang.String connectorBindingID)
                                  throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException