public interface Dataservice extends Exportable, RelationalObject, VdbEntryContainer
RelationalObject.Filter
Modifier and Type | Field and Description |
---|---|
static KomodoType |
IDENTIFIER
Identifier of this object
|
static Dataservice[] |
NO_DATASERVICES
An empty array of Dataservices.
|
static TypeResolver<Dataservice> |
RESOLVER
The resolver of a
Dataservice . |
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, 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 Dataservice[] NO_DATASERVICES
static final TypeResolver<Dataservice> RESOLVER
Dataservice
.VdbEntry addVdb(Repository.UnitOfWork transaction, Vdb vdb) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)vdb
- the VDB being added (cannot be null
)null
)KException
- if an error occursVdbEntry addVdbEntry(Repository.UnitOfWork transaction, String vdbEntryName) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)vdbEntryName
- the name of the VDB entry to create (cannot be empty)null
)KException
- if an error occursVdb setServiceVdb(Repository.UnitOfWork uow, Vdb serviceVdb) throws KException
uow
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)serviceVdb
- the service VDB being set (can be null
when deleting current value)null
if one is not being replacedKException
- if an error occursVdb getServiceVdb(Repository.UnitOfWork uow) throws KException
uow
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)null
if not defined)KException
- if an error occursServiceVdbEntry getServiceVdbEntry(Repository.UnitOfWork uow) throws KException
uow
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)null
if not defined)KException
- if an error occursString[] getViewDefinitionNames(Repository.UnitOfWork uow) throws KException
uow
- the transaction (cannot be null
or have a state that is not
Repository.UnitOfWork.State.NOT_STARTED
)KException
- if an error occursString getServiceViewModelName(Repository.UnitOfWork uow) throws KException
uow
- the transaction (cannot be null
or have a state that is not
Repository.UnitOfWork.State.NOT_STARTED
)null
if not found)KException
- if an error occursDriverEntry[] getDriverEntries(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[] getDriverPlan(Repository.UnitOfWork uow) throws KException
uow
- the transaction (cannot be null
or have a state that is not
Repository.UnitOfWork.State.NOT_STARTED
)null
but can be empty)KException
- if an error occursDriver[] getDrivers(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[] getVdbPlan(Repository.UnitOfWork uow) throws KException
uow
- the transaction (cannot be null
or have a state that is not
Repository.UnitOfWork.State.NOT_STARTED
)null
but can be empty)KException
- if an error occursDeployStatus deploy(Repository.UnitOfWork uow) throws KException
uow
- the transaction (cannot be null
or have a state that is not
Repository.UnitOfWork.State.NOT_STARTED
)KException
ConnectionEntry addConnection(Repository.UnitOfWork transaction, Connection connection) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)connection
- the connection being added to the data service (cannot be null
or empty)null
)KException
- if an error occursConnectionEntry addConnectionEntry(Repository.UnitOfWork transaction, String connectionEntryName) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)connectionEntryName
- the name of the connection entry to create (cannot be null
or empty)null
)KException
- if an error occursDdlEntry addDdlEntry(Repository.UnitOfWork transaction, String ddlEntryName) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)ddlEntryName
- the name of the DDL entry to create (cannot be empty)null
)KException
- if an error occursDdlEntry addDdlFile(Repository.UnitOfWork transaction, DdlFile ddlFile) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)ddlFile
- the DDL file being added to the data service (cannot be null
)null
)KException
- if an error occursDriverEntry addDriverFile(Repository.UnitOfWork transaction, Driver driverFile) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)driverFile
- the driver file being added to the data service (cannot be null
)null
)KException
- if an error occursDriverEntry addDriverEntry(Repository.UnitOfWork transaction, String driverEntryName) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)driverEntryName
- the name of the driver entry to create (cannot be empty)null
)KException
- if an error occursResourceEntry addResourceFile(Repository.UnitOfWork transaction, ResourceFile resourceFile) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)resourceFile
- the resource file being added to the data service (cannot be null
)null
)KException
- if an error occursResourceEntry addResourceEntry(Repository.UnitOfWork transaction, String resourceEntryName) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)resourceEntryName
- the name of the resource entry to create (cannot be empty)null
)KException
- if an error occursUdfEntry addUdfEntry(Repository.UnitOfWork transaction, String udfEntryName) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)udfEntryName
- the name of the UDF entry to create (cannot be empty)null
)KException
- if an error occursUdfEntry addUdfFile(Repository.UnitOfWork transaction, UdfFile udfFile) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)udfFile
- the UDF being added to the data service (cannot be empty)null
)KException
- if an error occursDataServiceEntry<?> getChild(Repository.UnitOfWork transaction, String name) throws KException
getChild
in interface KomodoObject
KException
KomodoObject.getChild(org.komodo.spi.repository.Repository.UnitOfWork, java.lang.String)
DataServiceEntry<?> getChild(Repository.UnitOfWork transaction, String name, String typeName) throws KException
getChild
in interface KomodoObject
KException
KomodoObject.getChild(org.komodo.spi.repository.Repository.UnitOfWork, java.lang.String,
java.lang.String)
DataServiceEntry<?>[] getChildren(Repository.UnitOfWork transaction, String... namePatterns) throws KException
getChildren
in interface KomodoObject
KException
KomodoObject.getChildren(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String[])
DataServiceEntry<?>[] getChildrenOfType(Repository.UnitOfWork transaction, String type, String... namePatterns) throws KException
getChildrenOfType
in interface KomodoObject
KException
KomodoObject.getChildrenOfType(org.komodo.spi.repository.Repository.UnitOfWork,
java.lang.String, java.lang.String[])
ConnectionEntry[] getConnectionEntries(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 occursConnection[] getConnections(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[] getConnectionPlan(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)null
but can be empty)KException
- if an error occursDdlEntry[] getDdlEntries(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
and must have a state of
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 occursDdlFile[] getDdlFiles(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
and must have a state of
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[] getDdlPlan(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)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 occursCalendar getLastModified(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not
Repository.UnitOfWork.State.NOT_STARTED
)null
)KException
- if an error occursString getModifiedBy(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not
Repository.UnitOfWork.State.NOT_STARTED
)null
or empty)KException
- if an error occursString[] getResourcePlan(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)null
but can be empty)KException
- if an error occursResourceEntry[] getResourceEntries(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
and must have a state of
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 occursResourceFile[] getResourceFiles(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
and must have a state of
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[] getUdfPlan(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
and must have a state of
Repository.UnitOfWork.State.NOT_STARTED
)null
but can be empty)KException
- if an error occursUdfEntry[] getUdfEntries(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
and must have a state of
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 occursUdfFile[] getUdfFiles(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
and must have a state of
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 occursVdbEntry[] getVdbEntries(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
and must have a state of
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 occursVdb[] getVdbs(Repository.UnitOfWork transaction, String... namePatterns) throws KException
transaction
- the transaction (cannot be null
and must have a state of
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 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 setLastModified(Repository.UnitOfWork transaction, Calendar newLastModified) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newLastModified
- the new value of the last modified date
propertyKException
- if an error occursvoid setModifiedBy(Repository.UnitOfWork transaction, String newModifiedBy) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)newModifiedBy
- the new value of the modified by
propertyKException
- if an error occursvoid clone(Repository.UnitOfWork transaction, Dataservice dataservice) throws KException
Dataservice
's properties to the given Dataservice
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)dataservice
- the destination data serviceKException
- if an error occursCopyright © 2013–2019. All rights reserved.