@Component @Path(value="workspace/vdbs") public final class KomodoVdbService extends KomodoService
KomodoService.QueryParamKeys, KomodoService.SecurityPrincipal
KomodoRestV1Application.V1Constants.App
DSB_PROP_METADATA_STATUS, DSB_PROP_METADATA_STATUS_MSG, DSB_PROP_OWNER, DSB_PROP_SERVICE_SOURCE, DSB_PROP_SOURCE_CONNECTION, DSB_PROP_SOURCE_TRANSLATOR, ENCRYPTED_PREFIX, ENCRYPTION_ALGORITHM, entityFactory, kengine, LOGGER, securityContext, SYSTEM_USER
ABOUT, APP_PATH, BIND_TO_SERVICE_CATALOG_SOURCE, CLONE_SEGMENT, COLUMNS_SEGMENT, CONDITION_PLACEHOLDER, CONDITIONS_SEGMENT, CONNECTION_PLACEHOLDER, CONNECTION_SEGMENT, CONNECTIONS_FROM_TEIID, CONNECTIONS_SEGMENT, CRITERIA_FOR_JOIN_TABLES, DATA_ROLE_PLACEHOLDER, DATA_ROLES_SEGMENT, DATA_SERVICE_PLACEHOLDER, DATA_SERVICE_SEGMENT, DATA_SERVICES_SEGMENT, DEPLOYABLE_STATUS_SEGMENT, DRIVERS_SEGMENT, EXPORT, EXPORT_TO_GIT, GIT_REPO_PLACEHOLDER, GIT_REPOSITORY, IMPORT, IMPORT_EXPORT_SEGMENT, IMPORT_PLACEHOLDER, IMPORTS_SEGMENT, JDBC_CATALOG_SCHEMA_SEGMENT, JDBC_INFO_SEGMENT, MASK_PLACEHOLDER, MASKS_SEGMENT, METADATA__CREDENTIALS, METADATA_DRIVER, METADATA_DRIVER_PLACEHOLDER, METADATA_SEGMENT, MODEL_FROM_TEIID_DDL, MODEL_PLACEHOLDER, MODELS_SEGMENT, NAME_VALIDATION_SEGMENT, PERMISSION_PLACEHOLDER, PERMISSIONS_SEGMENT, PING_SEGMENT, PING_TYPE_PARAMETER, PUBLISH, PUBLISH_LOGS, QUERY_SEGMENT, REFRESH_DATASERVICE_VIEWS, REFRESH_PREVIEW_VDB_SEGMENT, REFRESH_SCHEMA_SEGMENT, SAMPLE_DATA, SAVED_SEARCHES_SEGMENT, SCHEMA_SEGMENT, SEARCH_ANCESTOR_PARAMETER, SEARCH_CONTAINS_PARAMETER, SEARCH_OBJECT_NAME_PARAMETER, SEARCH_PARENT_PARAMETER, SEARCH_PATH_PARAMETER, SEARCH_SAVED_NAME_PARAMETER, SEARCH_SEGMENT, SEARCH_TYPE_PARAMETER, SERVICE_CATALOG_SEGMENT, SERVICE_SEGMENT, SERVICE_VDB_FOR_JOIN_TABLES, SERVICE_VDB_FOR_SINGLE_SOURCE_TABLES, SERVICE_VIEW_DDL_FOR_JOIN_TABLES, SERVICE_VIEW_DDL_FOR_SINGLE_TABLE, SERVICE_VIEW_INFO, SOURCE_PLACEHOLDER, SOURCE_VDB_MATCHES, SOURCES_SEGMENT, STATUS_SEGMENT, STORAGE_TYPES, SYNDESIS_SOURCE, SYNDESIS_SOURCE_PLACEHOLDER, SYNDESIS_SOURCE_STATUSES, SYNDESIS_SOURCES, TABLE_PLACEHOLDER, TABLES_SEGMENT, TEMPLATE_ENTRIES_SEGMENT, TEMPLATE_ENTRY_PLACEHOLDER, TEMPLATE_PLACEHOLDER, TEMPLATE_SEGMENT, TEMPLATES_SEGMENT, TRANSLATOR_DEFAULT_SEGMENT, TRANSLATOR_PLACEHOLDER, TRANSLATORS_SEGMENT, UNDEPLOY, USER_PROFILE, VALIDATE_PLACEHOLDER, VALIDATE_SEGMENT, VALIDATE_VIEW_DEFINITION, VDB_EXPORT_XML_PROPERTY, VDB_MANIFEST_SEGMENT, VDB_NAME_PARAMETER, VDB_PLACEHOLDER, VDB_SEGMENT, VDBS_FROM_TEIID, VDBS_SEGMENT, VIEW_EDITOR_STATE, VIEW_EDITOR_STATE_PLACEHOLDER, VIEW_EDITOR_STATES, VIEW_PLACEHOLDER, VIEWS_SEGMENT, WORKSPACE_SEGMENT
BASE_URI, CHILDREN, DATA_PATH, DDL_ATTRIBUTE, DEFAULT_VALUE, DESCRIPTION, HAS_CHILDREN, HREF, ID, KENGINE_PREFIX, KTYPE, LIMIT, LINKS, NULL, PARENT, PREFIX_PATTERN, PREFIX_SEPARATOR, PROPERTIES, REL, REPEATABLE, REQUIRED, SELF, TYPE, VALUES
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, 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
Constructor and Description |
---|
KomodoVdbService() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
cloneVdb(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String newVdbName)
Clone a Vdb in the komodo repository
|
javax.ws.rs.core.Response |
createDataRole(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String dataRoleName,
String dataRoleJson)
Create a data role in the specified VDB.
|
javax.ws.rs.core.Response |
createModel(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String modelJson)
Create a new Model in the specified VDB
|
javax.ws.rs.core.Response |
createModelSource(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String sourceName,
String sourceJson)
Create a new model source in the specified vdb model.
|
javax.ws.rs.core.Response |
createModelView(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String viewName,
String viewJson)
Create a new model view in the specified vdb model.
|
javax.ws.rs.core.Response |
createModelViews(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String vdbViewsInfo)
Sets the model views as specified by the supplied inputs
|
javax.ws.rs.core.Response |
createVdb(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String vdbJson)
Create a new Vdb in the komodo repository
|
javax.ws.rs.core.Response |
deleteDataRole(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String dataRoleName)
Delete the specified data role from the specified VDB
|
javax.ws.rs.core.Response |
deleteModel(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName)
Delete the specified Model from the specified VDB
|
javax.ws.rs.core.Response |
deleteModelSource(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String sourceName)
Delete the ModelSource in the specified Vdb Model
|
javax.ws.rs.core.Response |
deleteModelView(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String viewName)
Delete the View in the specified Vdb Model
|
javax.ws.rs.core.Response |
deleteVdb(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName)
Delete the specified Vdb from the komodo repository
|
javax.ws.rs.core.Response |
getCondition(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String dataRoleId,
String permissionId,
String conditionId) |
javax.ws.rs.core.Response |
getConditions(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String dataRoleId,
String permissionId) |
javax.ws.rs.core.Response |
getDataRole(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String dataRoleId) |
javax.ws.rs.core.Response |
getDataRoles(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName) |
javax.ws.rs.core.Response |
getImport(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String importName) |
javax.ws.rs.core.Response |
getImports(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName) |
javax.ws.rs.core.Response |
getMask(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String dataRoleId,
String permissionId,
String maskId) |
javax.ws.rs.core.Response |
getMasks(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String dataRoleId,
String permissionId) |
javax.ws.rs.core.Response |
getModel(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName) |
javax.ws.rs.core.Response |
getModels(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName) |
javax.ws.rs.core.Response |
getModelSource(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String sourceName) |
javax.ws.rs.core.Response |
getModelSources(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName) |
javax.ws.rs.core.Response |
getModelTableColumns(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String tableName) |
javax.ws.rs.core.Response |
getModelTables(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName) |
javax.ws.rs.core.Response |
getModelView(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String viewName) |
javax.ws.rs.core.Response |
getModelViews(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName) |
javax.ws.rs.core.Response |
getPermission(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String dataRoleId,
String permissionId) |
javax.ws.rs.core.Response |
getPermissions(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String dataRoleId) |
javax.ws.rs.core.Response |
getTranslator(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String translatorName) |
javax.ws.rs.core.Response |
getTranslators(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName) |
javax.ws.rs.core.Response |
getVdb(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName) |
javax.ws.rs.core.Response |
getVdbs(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
javax.ws.rs.core.Response |
updateModel(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String modelJson)
Update a Model in the specified VDB
|
javax.ws.rs.core.Response |
updateModelSource(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String sourceName,
String sourceJson)
Update a model source in the specified VDB model.
|
javax.ws.rs.core.Response |
updateModelView(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String viewName,
String viewJson)
Update a view in the specified VDB model.
|
javax.ws.rs.core.Response |
updateVdb(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String vdbJson)
Update a Vdb in the komodo repository
|
javax.ws.rs.core.Response |
validateVdbName(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName) |
javax.ws.rs.core.Response |
validateViewName(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName,
String viewName) |
awaitCallback, checkSecurityContext, commit, commit, commit, commit, commitNoConnectionFound, commitNoDataRoleFound, commitNoDataserviceFound, commitNoModelFound, commitNoPermissionFound, commitNoSourceVdbFound, commitNoTableFound, commitNoTemplateFound, commitNoVdbFound, createErrorResponse, createErrorResponse, createErrorResponse, createErrorResponseEntity, createErrorResponseWithForbidden, createErrorResponseWithForbidden, createTransaction, createTransaction, decode, decryptSensitiveData, encode, encryptSensitiveData, findConnection, findDataservice, findVdb, getAuthenticationToken, getUserProfile, getViewEditorStateId, getViewEditorStateIdPrefix, getViewEditorStates, getWorkspaceManager, isAcceptable, notAcceptableMediaTypesBuilder, protectPrefix, removeEditorState, removeEditorState, setProperties, systemTx, unprotectPrefix, uri
@POST @Path(value="/{vdbName}") @Produces(value="application/json") public javax.ws.rs.core.Response createVdb(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, String vdbJson) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the vdb name (cannot be empty)vdbJson
- the Vdb JSON representation (cannot be null
)null
)KomodoRestException
- if there is an error creating the VDB@PUT @Path(value="/{vdbName}") @Produces(value="application/json") public javax.ws.rs.core.Response updateVdb(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, String vdbJson) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the vdb name (cannot be empty)vdbJson
- the vdb JSON representation (cannot be null
)null
)KomodoRestException
- if there is an error updating the vdb@POST @Path(value="/clone/{vdbName}") @Produces(value="application/json") public javax.ws.rs.core.Response cloneVdb(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, String newVdbName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the Vdb name (cannot be empty)newVdbName
- the new Vdb name (cannot be empty)null
)KomodoRestException
- if there is an error creating the Vdb@DELETE @Path(value="{vdbName}") @Produces(value="application/json") public javax.ws.rs.core.Response deleteVdb(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the name of the Vdb to be removed (cannot be null
)KomodoRestException
- if there is a problem performing the delete@GET @Produces(value="application/json") public javax.ws.rs.core.Response getVdbs(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)null
)KomodoRestException
- if there is a problem constructing the VDBs JSON document@GET @Path(value="{vdbName}") @Produces(value={"application/json","application/xml"}) public javax.ws.rs.core.Response getVdb(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/Models") @Produces(value="application/json") public javax.ws.rs.core.Response getModels(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/Models/{modelName}") @Produces(value="application/json") public javax.ws.rs.core.Response getModel(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@POST @Path(value="{vdbName}/Models/{modelName}") @Produces(value="application/json") public javax.ws.rs.core.Response createModel(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, String modelJson) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the vdb name (cannot be empty)modelName
- the model name (cannot be empty)modelJson
- the Model JSON representation (cannot be null
)null
)KomodoRestException
- if there is an error creating the Model@PUT @Path(value="{vdbName}/Models/{modelName}") @Produces(value="application/json") public javax.ws.rs.core.Response updateModel(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, String modelJson) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the vdb name (cannot be empty)modelName
- the model name (cannot be empty)modelJson
- the model JSON representation (cannot be null
)null
)KomodoRestException
- if there is an error updating the model@DELETE @Path(value="{vdbName}/Models/{modelName}") @Produces(value="application/json") public javax.ws.rs.core.Response deleteModel(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the name of the Vdb (cannot be null
)modelName
- the name of the model to remove (cannot be null
)KomodoRestException
- if there is a problem performing the delete@GET @Path(value="{vdbName}/VdbTranslators") @Produces(value="application/json") public javax.ws.rs.core.Response getTranslators(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbTranslators/{translatorName}") @Produces(value="application/json") public javax.ws.rs.core.Response getTranslator(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="translatorName") String translatorName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)translatorName
- the id of the translator being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbImports") @Produces(value="application/json") public javax.ws.rs.core.Response getImports(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbImports/{importName}") @Produces(value="application/json") public javax.ws.rs.core.Response getImport(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="importName") String importName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)importName
- the id of the import being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbDataRoles") @Produces(value="application/json") public javax.ws.rs.core.Response getDataRoles(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@POST @Path(value="{vdbName}/VdbDataRoles/{dataRoleId}") @Produces(value="application/json") public javax.ws.rs.core.Response createDataRole(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="dataRoleId") String dataRoleName, String dataRoleJson) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the vdb name (cannot be empty)dataRoleName
- the data role name (cannot be empty)dataRoleJson
- the data role JSON representation (cannot be null
)null
)KomodoRestException
- if there is an error creating the data role@DELETE @Path(value="{vdbName}/VdbDataRoles/{dataRoleId}") @Produces(value="application/json") public javax.ws.rs.core.Response deleteDataRole(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="dataRoleId") String dataRoleName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the name of the VDB (cannot be null
)dataRoleName
- the name of the data role to remove (cannot be null
)KomodoRestException
- if there is a problem performing the delete@GET @Path(value="{vdbName}/VdbDataRoles/{dataRoleId}") @Produces(value="application/json") public javax.ws.rs.core.Response getDataRole(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="dataRoleId") String dataRoleId) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)dataRoleId
- the id of the data role being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/Models/{modelName}/VdbModelSources") @Produces(value="application/json") public javax.ws.rs.core.Response getModelSources(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/Models/{modelName}/VdbModelSources/{sourceName}") @Produces(value="application/json") public javax.ws.rs.core.Response getModelSource(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="sourceName") String sourceName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)sourceName
- the id of the source being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@POST @Path(value="{vdbName}/Models/{modelName}/VdbModelSources/{sourceName}") @Produces(value="application/json") public javax.ws.rs.core.Response createModelSource(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="sourceName") String sourceName, String sourceJson) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)sourceName
- the id of the source being retrieved (cannot be empty)sourceJson
- the ModelSource JSON representation (cannot be null
)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB model or constructing the JSON representation@PUT @Path(value="{vdbName}/Models/{modelName}/VdbModelSources/{sourceName}") @Produces(value="application/json") public javax.ws.rs.core.Response updateModelSource(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="sourceName") String sourceName, String sourceJson) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)sourceName
- the id of the source being retrieved (cannot be empty)sourceJson
- the ModelSource JSON representation (cannot be null
)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@DELETE @Path(value="{vdbName}/Models/{modelName}/VdbModelSources/{sourceName}") @Produces(value="application/json") public javax.ws.rs.core.Response deleteModelSource(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="sourceName") String sourceName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)sourceName
- the id of the source being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/Models/{modelName}/Tables") @Produces(value="application/json") public javax.ws.rs.core.Response getModelTables(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/Models/{modelName}/Tables/{tableName}/Columns") @Produces(value="application/json") public javax.ws.rs.core.Response getModelTableColumns(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="tableName") String tableName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)tableName
- the id of the table being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbDataRoles/{dataRoleId}/VdbPermissions") @Produces(value="application/json") public javax.ws.rs.core.Response getPermissions(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="dataRoleId") String dataRoleId) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)dataRoleId
- the id of the data role being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbDataRoles/{dataRoleId}/VdbPermissions/{permissionId}") @Produces(value="application/json") public javax.ws.rs.core.Response getPermission(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="dataRoleId") String dataRoleId, @PathParam(value="permissionId") String permissionId) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)dataRoleId
- the id of the data role being retrieved (cannot be empty)permissionId
- the id of the permission being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbDataRoles/{dataRoleId}/VdbPermissions/{permissionId}/VdbConditions") @Produces(value="application/json") public javax.ws.rs.core.Response getConditions(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="dataRoleId") String dataRoleId, @PathParam(value="permissionId") String permissionId) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)dataRoleId
- the id of the data role being retrieved (cannot be empty)permissionId
- the id of the permission being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbDataRoles/{dataRoleId}/VdbPermissions/{permissionId}/VdbConditions/{conditionId}") @Produces(value="application/json") public javax.ws.rs.core.Response getCondition(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="dataRoleId") String dataRoleId, @PathParam(value="permissionId") String permissionId, @PathParam(value="conditionId") String conditionId) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)dataRoleId
- the id of the data role being retrieved (cannot be empty)permissionId
- the id of the permission being retrieved (cannot be empty)conditionId
- the id of the condition being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbDataRoles/{dataRoleId}/VdbPermissions/{permissionId}/VdbMasks") @Produces(value="application/json") public javax.ws.rs.core.Response getMasks(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="dataRoleId") String dataRoleId, @PathParam(value="permissionId") String permissionId) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)dataRoleId
- the id of the data role being retrieved (cannot be empty)permissionId
- the id of the permission being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/VdbDataRoles/{dataRoleId}/VdbPermissions/{permissionId}/VdbMasks/{maskId}") @Produces(value="application/json") public javax.ws.rs.core.Response getMask(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="dataRoleId") String dataRoleId, @PathParam(value="permissionId") String permissionId, @PathParam(value="maskId") String maskId) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)dataRoleId
- the id of the data role being retrieved (cannot be empty)permissionId
- the id of the permission being retrieved (cannot be empty)maskId
- the id of the mask being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="nameValidation/{vdbName}") @Produces(value="text/plain") public javax.ws.rs.core.Response validateVdbName(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the VDB name being validated (cannot be empty)null
) with an entity that is
either an empty string, when the name is valid, or an error
messageKomodoRestException
- if there is a problem validating the VDB name or constructing
the response@GET @Path(value="{vdbName}/Models/{modelName}/Views/nameValidation/{viewName}") @Produces(value="text/plain") public javax.ws.rs.core.Response validateViewName(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="viewName") String viewName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the Vdb being retrieved (cannot be empty)modelName
- the id of the Model being retrieved (cannot be empty)viewName
- the view name being validated (cannot be empty)null
) with an entity that is
either an empty string, when the name is valid, or an error
messageKomodoRestException
- if there is a problem validating the View name or constructing
the response@GET @Path(value="{vdbName}/Models/{modelName}/Views") @Produces(value="application/json") public javax.ws.rs.core.Response getModelViews(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB (cannot be empty)modelName
- the id of the model whose views are being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@GET @Path(value="{vdbName}/Models/{modelName}/Views/{viewName}") @Produces(value="application/json") public javax.ws.rs.core.Response getModelView(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="viewName") String viewName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB (cannot be empty)modelName
- the id of the model whose views are being retrieved (cannot be empty)viewName
- the id of the view to be retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@POST @Path(value="{vdbName}/Models/{modelName}/Views/{viewName}") @Produces(value="application/json") public javax.ws.rs.core.Response createModelView(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="viewName") String viewName, String viewJson) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)sourceName
- the id of the view being created (cannot be empty)sourceJson
- the View JSON representation (cannot be null
)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB model or constructing the JSON representation@PUT @Path(value="{vdbName}/Models/{modelName}/Views/{viewName}") @Produces(value="application/json") public javax.ws.rs.core.Response updateModelView(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="viewName") String viewName, String viewJson) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)viewName
- the id of the view being retrieved (cannot be empty)viewJson
- the View JSON representation (cannot be null
)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representation@POST @Path(value="{vdbName}/Models/{modelName}/defineViews") @Produces(value="application/json") public javax.ws.rs.core.Response createModelViews(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, String vdbViewsInfo) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)viewsInfo
- the Views info JSON representation (cannot be null
)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB model or constructing the JSON representation@DELETE @Path(value="{vdbName}/Models/{modelName}/Views/{viewName}") @Produces(value="application/json") public javax.ws.rs.core.Response deleteModelView(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName, @PathParam(value="modelName") String modelName, @PathParam(value="viewName") String viewName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)vdbName
- the id of the VDB being retrieved (cannot be empty)modelName
- the id of the model being retrieved (cannot be empty)viewName
- the id of the view being deleted (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified workspace VDB or constructing the JSON representationCopyright © 2013–2019. All rights reserved.