public interface Vdb extends Exportable, RelationalObject
Modifier and Type | Interface and Description |
---|---|
static interface |
Vdb.VdbManifest
Represents a VDB XML manifest file.
|
RelationalObject.Filter
Modifier and Type | Field and Description |
---|---|
static String |
ALLOWED_LANGUAGES_TEIIDNAME |
static String |
AUTHENTICATION_TYPE_TEIIDNAME |
static boolean |
DEFAULT_PREVIEW
The default value indicating if this VDB is a preview VDB.
|
static int |
DEFAULT_VERSION
The default version number.
|
static String |
GSS_PATTERN_TEIIDNAME |
static KomodoType |
IDENTIFIER
Identifier of this object
|
static Vdb[] |
NO_VDBS
An empty array of VDBs.
|
static String |
PASSWORD_PATTERN_TEIIDNAME |
static String |
QUERY_TIMEOUT_TEIIDNAME |
static TypeResolver<Vdb> |
RESOLVER
The resolver of a
Vdb . |
static String |
SECURITY_DOMAIN_TEIIDNAME
Teiid Names for special properties
|
static int |
TYPE_ID
The type identifier.
|
DDL_QNAMES_FILTER, DEFAULT_FILTERS, JCR_FILTER, NO_FILTERS, NT_FILTER, RESIDUAL_FILTER
EMPTY_ARRAY
export, getDocumentType, getName
getFilters, setFilters
accept, addChild, addDescriptor, getChild, getChild, getChildren, getChildrenOfType, getChildTypes, getDescriptor, getDescriptors, getIndex, getObjectFactory, getPrimaryType, getProperty, getPropertyDescriptor, getPropertyDescriptors, getPropertyFactory, getPropertyNames, getRawChildren, getRawDescriptors, getRawParent, getRawProperty, getRawPropertyDescriptors, getRawPropertyNames, getTypeId, getTypeIdentifier, hasChild, hasChild, hasChildren, hasDescriptor, hasProperties, hasProperty, hasRawChild, hasRawChild, hasRawChildren, hasRawProperty, isChildRestricted, print, remove, removeChild, removeDescriptor, rename, setPrimaryType, setProperty
getAbsolutePath, getName, getParent, getRepository
static final int TYPE_ID
static final KomodoType IDENTIFIER
static final boolean DEFAULT_PREVIEW
static final int DEFAULT_VERSION
static final Vdb[] NO_VDBS
static final String SECURITY_DOMAIN_TEIIDNAME
static final String QUERY_TIMEOUT_TEIIDNAME
static final String PASSWORD_PATTERN_TEIIDNAME
static final String GSS_PATTERN_TEIIDNAME
static final String AUTHENTICATION_TYPE_TEIIDNAME
static final String ALLOWED_LANGUAGES_TEIIDNAME
static final TypeResolver<Vdb> RESOLVER
Vdb
.DataRole addDataRole(Repository.UnitOfWork transaction, String dataRoleName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)dataRoleName
- the name of the data role being added (cannot be empty)null
)KException
- if an error occursEntry addEntry(Repository.UnitOfWork transaction, String entryName, String entryPath) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)entryName
- the name of the entry being added (cannot be empty)entryPath
- the path of the entry (cannot be empty)null
)KException
- if an error occursVdbImport addImport(Repository.UnitOfWork transaction, String vdbName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)vdbName
- the name of the VDB being imported (cannot be empty)null
)KException
- if an error occursModel addModel(Repository.UnitOfWork transaction, String modelName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)modelName
- the name of the VDB being imported (cannot be empty)null
)KException
- if an error occursTranslator addTranslator(Repository.UnitOfWork transaction, String translatorName, String translatorType) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)translatorName
- the name of the translator being added (cannot be empty)translatorType
- the type of translator (cannot be empty)null
)KException
- if an error occursVdb.VdbManifest createManifest(Repository.UnitOfWork transaction, Properties properties) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)properties
- (can be null
or empty)KException
- if an error occursString getAllowedLanguages(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursString getAuthenticationType(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
String getConnectionType(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)connection type
property (can be empty)KException
- if an error occursDataRole[] getDataRoles(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occursString getDescription(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)description
property (can be empty)KException
- if an error occursEntry[] getEntries(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occursString getGssPattern(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursModel[] getModels(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occursVdbImport[] getImports(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occursString getOriginalFilePath(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)original file path
property (never empty)KException
- if an error occursString getPasswordPattern(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursint getQueryTimeout(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursString getSecurityDomain(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursTranslator[] getTranslators(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)namePatterns
- optional name patterns (can be null
or empty but cannot have null
or empty elements)null
but can be empty)KException
- if an error occursString getVdbName(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)Teiid VDB name
property (can be empty)KException
- if an error occursint getVersion(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)version
propertyKException
- if an error occursDEFAULT_VERSION
boolean isPreview(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)true
if a preview VDBKException
- if an error occursDEFAULT_PREVIEW
void removeDataRole(Repository.UnitOfWork transaction, String dataRoleToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)dataRoleToRemove
- the name of the data role being removed (cannot be empty)KException
- if an error occursvoid removeEntry(Repository.UnitOfWork transaction, String entryToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)entryToRemove
- the name of the entry being removed (cannot be empty)KException
- if an error occursvoid removeImport(Repository.UnitOfWork transaction, String importToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)importToRemove
- the name of the VDB import being removed (cannot be empty)KException
- if an error occursvoid removeModel(Repository.UnitOfWork transaction, String modelToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)modelToRemove
- the name of the model being removed (cannot be empty)KException
- if an error occursvoid removeTranslator(Repository.UnitOfWork transaction, String translatorToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)translatorToRemove
- the name of the translator being removed (cannot be empty)KException
- if an error occursvoid setAllowedLanguages(Repository.UnitOfWork transaction, String newAllowedLanguages) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newAllowedLanguages
- the new allowed languages (can be empty)KException
- if an error occursvoid setAuthenticationType(Repository.UnitOfWork transaction, String newAuthenticationType) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newAuthenticationType
- the new authentication type (can be empty)KException
- if an error occursvoid setConnectionType(Repository.UnitOfWork transaction, String newConnectionType) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newConnectionType
- the new value of the connection type
propertyKException
- if an error occursvoid setDescription(Repository.UnitOfWork transaction, String newDescription) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newDescription
- the new value of the description
propertyKException
- if an error occursvoid setGssPattern(Repository.UnitOfWork transaction, String newGssPattern) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newGssPattern
- the new GSS pattern (can be empty)KException
- if an error occursvoid setOriginalFilePath(Repository.UnitOfWork transaction, String newOriginalFilePath) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newOriginalFilePath
- the new value of the original file path
property (cannot be empty)KException
- if an error occursvoid setPasswordPattern(Repository.UnitOfWork transaction, String newPasswordPattern) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newPasswordPattern
- the new password pattern (can be empty)KException
- if an error occursvoid setPreview(Repository.UnitOfWork transaction, boolean newPreview) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newPreview
- the new value for the preview
propertyKException
- if an error occursDEFAULT_PREVIEW
void setQueryTimeout(Repository.UnitOfWork transaction, int newQueryTimeout) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newQueryTimeout
- the new query timeout or a negative number to delete the current valueKException
- if an error occursvoid setSecurityDomain(Repository.UnitOfWork transaction, String newSecurityDomain) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newSecurityDomain
- the new security domain (can be empty)KException
- if an error occursvoid setVdbName(Repository.UnitOfWork transaction, String newVdbName) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newVdbName
- the new value of the Teiid VDB name
propertyKException
- if an error occursvoid setVersion(Repository.UnitOfWork transaction, int newVersion) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newVersion
- the new value of the version
propertyKException
- if an error occursDEFAULT_VERSION
DeployStatus deploy(Repository.UnitOfWork uow)
uow
- the transaction (cannot be null
or have a state that is not
Repository.UnitOfWork.State.NOT_STARTED
)Copyright © 2013–2019. All rights reserved.