public interface MetadataInstance extends StringConstants
Modifier and Type | Interface and Description |
---|---|
static class |
MetadataInstance.Condition
The server state.
|
static class |
MetadataInstance.ConnectivityType
Type of connectivity
|
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_ADMIN_PASSWORD
The default admin password for the metadata instance
|
static int |
DEFAULT_ADMIN_PORT
The default admin port for the metadata instance
|
static String |
DEFAULT_ADMIN_USER
The default admin user for the metadata instance
|
static String |
DEFAULT_INSTANCE_PROTOCOL
The default protocol for the metadata instance
|
static String |
DEFAULT_JDBC_PASSWORD
The default jdbc password for the metadata instance
|
static int |
DEFAULT_JDBC_PORT
The default jdbc port for the metadata instance
|
static String |
DEFAULT_JDBC_USER
The default jdbc user for the metadata instance
|
static String |
HOST
The host of the metadata instance
|
static int |
NO_LIMIT
Value representing no limit to results returned by a query
|
static int |
NO_OFFSET
Value representing no offset to a set of results returned by a query
|
static String |
PING_VDB
VDB file name for the ping test
|
static String |
PING_VDB_NAME
VDB name for the ping test
|
AMPERSAND, AT, BR, CLASS, CLOSE_ANGLE_BRACKET, CLOSE_BRACE, CLOSE_BRACKET, CLOSE_PRE_CMT, CLOSE_PRE_TAG, CLOSE_SQUARE_BRACKET, COLON, COMMA, CONNECTION_SUFFIX, CURRENT_FOLDER_SYMBOL, DDL, DEFAULT_LOCAL_WORKSPACE_NAME, DIVIDE, DOLLAR_SIGN, DOT, DOT_CHAR, DOT_DOT, DOT_KOMODO, DOUBLE_BACK_SLASH, DRIVE_SEPARATOR, EMPTY_ARRAY, EMPTY_STRING, ENUM, EQUALS, FILE_EXTENSION_SEPARATOR, FILE_NAME_WILDCARD, FINAL, FORWARD_SLASH, HASH, HYPHEN, INTERFACE, JAR, JAVA, JAVA_IO_TMPDIR, JBOSS_SERVER_TMP_DIR, KOMODO, LINE_SEPARATOR, LINE_SEPARATOR_PROPERTY_NAME, LOG, MINUS, MULTIPLY, NBSP, NEW_LINE, OPEN_ANGLE_BRACKET, OPEN_BRACE, OPEN_BRACKET, OPEN_PRE_CMT, OPEN_PRE_TAG, OPEN_SQUARE_BRACKET, PARENT_FOLDER_SYMBOL, PERCENT, PIPE, PLUS, PREFIX_PATTERN, PRIVATE, PUBLIC, QUESTION_MARK, QUOTE_MARK, SEMI_COLON, SERVICE_VDB_SUFFIX, SERVICE_VDB_VIEW_MODEL, SERVICE_VDB_VIEW_SUFFIX, SOURCES, SPACE, SPEECH_MARK, SRC, STAR, STATIC, TAB, TARGET, UNDERSCORE, UNDERSCORE_CHAR, VDB_DEPLOYMENT_SUFFIX, VDB_PREFIX, XML, XML_SUFFIX, ZIP, ZIP_SUFFIX
Modifier and Type | Method and Description |
---|---|
void |
addObserver(MetadataObserver observer) |
boolean |
dataSourceExists(String name) |
void |
deleteDataSource(String dsName)
Removes the data source from the metadata instance (if exists)
|
void |
deployDataSourceDriver(String driverName,
File driverFile)
Deploys a driver (jar or rar) to the related metadata instance
|
void |
deployDynamicVdb(String vdbName,
String vdbDeploymentName,
InputStream stream)
Deploy a dynamic vdb
|
MetadataInstance.Condition |
getCondition() |
TeiidDataSource |
getDataSource(String sourceName) |
Collection<ConnectionDriver> |
getDataSourceDrivers() |
Collection<TeiidDataSource> |
getDataSources() |
Set<String> |
getDataSourceTemplateNames()
Get all DataSource template names
|
DataTypeService |
getDataTypeService() |
TeiidDataSource |
getOrCreateDataSource(String displayName,
String dsName,
String typeName,
Properties properties)
Get the specified DataSource, or create one if it does not exist.
|
String |
getSchema(String vdbName,
String version,
String modelName) |
Collection<TeiidPropertyDefinition> |
getTemplatePropertyDefns(String driverName) |
TeiidTranslator |
getTranslator(String translatorName) |
Collection<TeiidTranslator> |
getTranslators() |
TeiidVdb |
getVdb(String vdbDeploymentName) |
Collection<String> |
getVdbNames() |
Collection<TeiidVdb> |
getVdbs() |
MetadataVersion |
getVersion() |
boolean |
hasVdb(String name) |
boolean |
hasVdbFailed(String vdbName) |
boolean |
isVdbActive(String vdbName) |
boolean |
isVdbLoading(String vdbName) |
void |
notify(MetadataClientEvent event)
Notify this metadata instance of a client event
|
Outcome |
ping(MetadataInstance.ConnectivityType connectivityType)
Ping the metadata instance to determine whether it is still connected
|
QSResult |
query(String vdbName,
String query,
int offset,
int limit)
Query the vdb with given name
|
void |
refresh()
Refresh this instance to clear any cached and get the latest metadata.
|
void |
removeObserver(MetadataObserver observer) |
List<String> |
retrieveVdbValidityErrors(String vdbName) |
void |
undeployDataSourceDriver(String driver)
Undeploy the named driver
|
void |
undeployDynamicVdb(String name)
Undeploy the dynamic vdb with the given name
|
boolean |
wasVdbRemoved(String vdbName) |
static final String HOST
static final String DEFAULT_ADMIN_USER
static final String DEFAULT_ADMIN_PASSWORD
static final int DEFAULT_ADMIN_PORT
static final String DEFAULT_JDBC_USER
static final String DEFAULT_JDBC_PASSWORD
static final int DEFAULT_JDBC_PORT
static final String DEFAULT_INSTANCE_PROTOCOL
static final String PING_VDB_NAME
static final String PING_VDB
static final int NO_LIMIT
static final int NO_OFFSET
MetadataInstance.Condition getCondition()
void notify(MetadataClientEvent event)
event
- void addObserver(MetadataObserver observer)
observer
- the observer to be addedvoid removeObserver(MetadataObserver observer)
observer
- the observer to be removedMetadataVersion getVersion()
DataTypeService getDataTypeService()
Outcome ping(MetadataInstance.ConnectivityType connectivityType)
connectivityType
- Outcome
describing state of pingKException
QSResult query(String vdbName, String query, int offset, int limit) throws KException
vdbName
- the name of the vdb to queryquery
- the SQL queryoffset
- an offset of the results to returnlimit
- a limit on the number of results to returnKException
Collection<TeiidVdb> getVdbs() throws KException
KException
Collection<String> getVdbNames() throws KException
KException
TeiidVdb getVdb(String vdbDeploymentName) throws KException
vdbDeploymentName
- KException
boolean hasVdb(String name) throws KException
name
- KException
boolean isVdbActive(String vdbName) throws KException
vdbName
- true
if the vdb is activeKException
boolean isVdbLoading(String vdbName) throws KException
vdbName
- true
if the vdb is loadingKException
boolean hasVdbFailed(String vdbName) throws KException
vdbName
- true
if the vdb failedKException
boolean wasVdbRemoved(String vdbName) throws KException
vdbName
- true
if the vdb was removedKException
List<String> retrieveVdbValidityErrors(String vdbName) throws KException
vdbName
- KException
String getSchema(String vdbName, String version, String modelName) throws KException
vdbName
- version
- modelName
- KException
void deployDynamicVdb(String vdbName, String vdbDeploymentName, InputStream stream) throws KException
vdbDeploymentName
- stream
- KException
void undeployDynamicVdb(String name) throws KException
name
- KException
Collection<TeiidTranslator> getTranslators() throws KException
KException
TeiidTranslator getTranslator(String translatorName) throws KException
translatorName
- KException
Collection<ConnectionDriver> getDataSourceDrivers() throws KException
KException
void deployDataSourceDriver(String driverName, File driverFile) throws KException
driverName
- the deployment name to use for the driverdriverFile
- the file to deployKException
- if deployment failsvoid undeployDataSourceDriver(String driver) throws KException
driver
- KException
- if undeployment failsCollection<TeiidDataSource> getDataSources() throws KException
KException
TeiidDataSource getOrCreateDataSource(String displayName, String dsName, String typeName, Properties properties) throws KException
displayName
- the data source display namedsName
- the data source nametypeName
- the translator type nameproperties
- the list of metadata-related connection propertiesKException
- if data source creation failsTeiidDataSource getDataSource(String sourceName) throws KException
sourceName
- KException
boolean dataSourceExists(String name) throws KException
name
- the name of the data sourceKException
void deleteDataSource(String dsName) throws KException
dsName
- the data source nameKException
- if failure in deleting data source on metadata instanceCollection<TeiidPropertyDefinition> getTemplatePropertyDefns(String driverName) throws KException
driverName
- KException
Set<String> getDataSourceTemplateNames() throws KException
KException
void refresh() throws KException
KException
Copyright © 2013–2019. All rights reserved.