@Component @Path(value="metadata") public class KomodoMetadataService extends KomodoService
KomodoService.QueryParamKeys, KomodoService.SecurityPrincipal
KomodoRestV1Application.V1Constants.App
ALL_AVAILABLE, 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, VALIDATOR
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 |
---|
KomodoMetadataService() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
addConnection(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String pathAttribute)
Adds (deploys) a Connection to the server
|
javax.ws.rs.core.Response |
addDataservice(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String pathAttribute)
Adds (deploys) a Dataservice to the server
|
javax.ws.rs.core.Response |
addDriver(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String driverAttributes)
Adds (deploys) a Driver to the server
|
javax.ws.rs.core.Response |
addVdb(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String pathAttribute)
Adds (deploys) a VDB to the server
|
javax.ws.rs.core.Response |
bindSyndesisSource(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String syndesisSourceName)
Bind a Syndesis source - creates a corresponding connection in the teiid engine.
|
javax.ws.rs.core.Response |
copyConnectionsIntoRepo(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo)
Copy connections from the server into the workspace that are not present in the workspace
|
javax.ws.rs.core.Response |
deleteVirtualization(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName) |
javax.ws.rs.core.Response |
getAllConnectionSchema(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
javax.ws.rs.core.Response |
getConnection(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String connectionName) |
javax.ws.rs.core.Response |
getConnectionDefaultTranslator(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String connectionName)
Return the default translator to be used for a Connection
|
javax.ws.rs.core.Response |
getConnections(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
javax.ws.rs.core.Response |
getConnectionTemplate(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String templateName) |
javax.ws.rs.core.Response |
getConnectionTemplateEntries(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String templateName) |
javax.ws.rs.core.Response |
getConnectionTemplates(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
javax.ws.rs.core.Response |
getDataserviceDeployableStatus(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String dataserviceName)
Return Dataservice deployability status.
|
javax.ws.rs.core.Response |
getDrivers(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
javax.ws.rs.core.Response |
getSchema(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String syndesisSourceName) |
javax.ws.rs.core.Response |
getSchemaColumns(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String syndesisSourceName) |
javax.ws.rs.core.Response |
getSyndesisSources(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo)
Get the syndesis sources
|
javax.ws.rs.core.Response |
getSyndesisSourceStatuses(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo)
Get status for the available syndesis sources.
|
javax.ws.rs.core.Response |
getSyndesisSourceStatusesByName(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String syndesisSourceName) |
javax.ws.rs.core.Response |
getTranslators(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
javax.ws.rs.core.Response |
getVdb(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName)
Get the specified VDB
|
javax.ws.rs.core.Response |
getVdbModelSchema(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName,
String modelName)
Get the schema for a model in a deployed VDB
|
javax.ws.rs.core.Response |
getVdbs(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
javax.ws.rs.core.Response |
getVirtualizationLogs(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName) |
javax.ws.rs.core.Response |
getVirtualizations(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
boolean includeInProgressServices) |
javax.ws.rs.core.Response |
getVirtualizationStatus(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName) |
javax.ws.rs.core.Response |
publishVirtualization(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
PublishRequestPayload payload) |
javax.ws.rs.core.Response |
query(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String queryAttribute)
Query the teiid server
|
javax.ws.rs.core.Response |
refreshPreviewVdb(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName)
Refresh the preview Vdb with the supplied name
|
javax.ws.rs.core.Response |
refreshSchema(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String syndesisSourceName,
boolean redeployServerVdb,
boolean generateSchema)
Initiate schema refresh for a syndesis source.
|
javax.ws.rs.core.Response |
removeConnection(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String connectionName)
Remove a Connection from the server
|
javax.ws.rs.core.Response |
removeDriver(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String driverName)
Remove a Driver from the server
|
javax.ws.rs.core.Response |
removeVdb(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String vdbName)
Remove a VDB from the server
|
javax.ws.rs.core.Response |
status(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
javax.ws.rs.core.Response |
vdbs(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
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
public KomodoMetadataService() throws javax.ws.rs.WebApplicationException
engine
- the Komodo Engine (cannot be null
and must be started)openshiftClient
- OpenShift client to access service catalogjavax.ws.rs.WebApplicationException
- if there is a problem obtaining the workspace manager
@GET @Path(value="status") @Produces(value="application/json") public javax.ws.rs.core.Response status(@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="status/vdbs") @Produces(value="application/json") public javax.ws.rs.core.Response vdbs(@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="vdbs") @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="vdbs/{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@DELETE @Path(value="vdbs/{vdbName}") @Produces(value="application/json") public javax.ws.rs.core.Response removeVdb(@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 dynamic VDB name (never null
)null
)KomodoRestException
- if there is an error removing the VDB@DELETE @Path(value="connections/{connectionName}") @Produces(value="application/json") public javax.ws.rs.core.Response removeConnection(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="connectionName") String connectionName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)connectionName
- the Connection name (never null
)null
)KomodoRestException
- if there is an error removing the Connection@GET @Path(value="vdbs/{vdbName}/Models/{modelName}/schema") @Produces(value={"application/json","application/xml"}) public javax.ws.rs.core.Response getVdbModelSchema(@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 (cannot be empty)null
)KomodoRestException
- if there is a problem retrieving the schema@GET @Path(value="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) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)null
)KomodoRestException
- if there is a problem constructing the JSON document@GET @Path(value="connections") @Produces(value="application/json") public javax.ws.rs.core.Response getConnections(@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 JSON document@GET @Path(value="connections/{connectionName}") @Produces(value={"application/json","application/xml"}) public javax.ws.rs.core.Response getConnection(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="connectionName") String connectionName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)connectionName
- the id of the Connection being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified connection or constructing the JSON representation@GET @Path(value="connections/{connectionName}/TranslatorDefault") @Produces(value={"application/json","application/xml"}) public javax.ws.rs.core.Response getConnectionDefaultTranslator(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="connectionName") String connectionName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)connectionName
- the id of the Connection being retrieved (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified connection@POST @Path(value="connections/connectionsFromTeiid") @Produces(value="application/json") public javax.ws.rs.core.Response copyConnectionsIntoRepo(@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 an error copying the connections@GET @Path(value="drivers") @Produces(value="application/json") public javax.ws.rs.core.Response getDrivers(@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 JSON document@POST @Path(value="driver") @Produces(value="application/json") public javax.ws.rs.core.Response addDriver(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, String driverAttributes) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)driverAttributes
- the file attributes (never null
)null
)KomodoRestException
- if there is an error adding the Driver@DELETE @Path(value="driver/{driverName}") @Produces(value="application/json") public javax.ws.rs.core.Response removeDriver(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="driverName") String driverName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)driverName
- the driver name (never null
)null
)KomodoRestException
- if there is an error removing the Driver@GET @Path(value="dataservice/{dataserviceName}/deployableStatus") @Produces(value={"application/json","application/xml"}) public javax.ws.rs.core.Response getDataserviceDeployableStatus(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="dataserviceName") String dataserviceName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)dataserviceName
- the id of the Dataservice being requested for deployment (cannot be empty)null
)KomodoRestException
- if there is a problem determining the status@POST @Path(value="dataservice") @Produces(value="application/json") @Consumes(value="application/json") public javax.ws.rs.core.Response addDataservice(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, String pathAttribute) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)pathAttribute
- the path (never null
)null
)KomodoRestException
- if there is an error adding the Dataservice@POST @Path(value="connection") @Produces(value="application/json") @Consumes(value="application/json") public javax.ws.rs.core.Response addConnection(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, String pathAttribute) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)pathAttribute
- the path (never null
)null
)KomodoRestException
- if there is an error adding the Connection@POST @Path(value="vdb") @Produces(value="application/json") @Consumes(value="application/json") public javax.ws.rs.core.Response addVdb(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, String pathAttribute) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)pathAttribute
- the path attribute (never null
)null
)KomodoRestException
- if there is an error adding the VDB@POST @Path(value="/refreshPreviewVdb/{vdbName}") @Produces(value="application/json") public javax.ws.rs.core.Response refreshPreviewVdb(@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 (cannot be empty)null
)KomodoRestException
- if there is an error refreshing the preview vdb@POST @Path(value="query") @Produces(value="application/json") @Consumes(value="application/json") public javax.ws.rs.core.Response query(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, String queryAttribute) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)queryAttribute
- the query attribute (never null
)null
)KomodoRestException
- if there is an error getting results@GET @Path(value="templates") @Produces(value="application/json") public javax.ws.rs.core.Response getConnectionTemplates(@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 Templates JSON document@GET @Path(value="templates/{templateName}") @Produces(value="application/json") public javax.ws.rs.core.Response getConnectionTemplate(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="templateName") String templateName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)null
)KomodoRestException
- if there is a problem constructing the Templates JSON document@GET @Path(value="templates/{templateName}/entries") @Produces(value="application/json") public javax.ws.rs.core.Response getConnectionTemplateEntries(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="templateName") String templateName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)null
)KomodoRestException
- if there is a problem constructing the TemplateEntry JSON document@GET @Path(value="syndesisSources") @Produces(value="application/json") public javax.ws.rs.core.Response getSyndesisSources(@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 JSON document@POST @Path(value="syndesisSource/{syndesisSourceName}") @Produces(value="application/json") @Consumes(value="application/json") public javax.ws.rs.core.Response bindSyndesisSource(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="syndesisSourceName") String syndesisSourceName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)payload
- the payload that contains the name of the service (never
null
)null
)KomodoRestException
- if there is an error adding the Connection@POST @Path(value="/refresh-schema/{syndesisSourceName}") @Produces(value="application/json") public javax.ws.rs.core.Response refreshSchema(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="syndesisSourceName") String syndesisSourceName, @DefaultValue(value="false") @QueryParam(value="redeploy") boolean redeployServerVdb, @DefaultValue(value="true") @QueryParam(value="generate-schema") boolean generateSchema) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)syndesisSourceName
- the syndesis source name (cannot be empty)null
)KomodoRestException
- if there is an error initiating a schema refresh@GET @Path(value="{syndesisSourceName}/schema") @Produces(value="application/json") public javax.ws.rs.core.Response getSchema(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="syndesisSourceName") String syndesisSourceName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)syndesisSourceName
- the name of the syndesisSource whose tables are being requested (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified syndesis source or constructing the JSON representation@GET @Path(value="connection-schema") @Produces(value="application/json") public javax.ws.rs.core.Response getAllConnectionSchema(@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 finding the schema collection or constructing the JSON representation@GET @Path(value="{syndesisSourceName}/schema-columns") @Produces(value="application/json") public javax.ws.rs.core.Response getSchemaColumns(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="syndesisSourceName") String syndesisSourceName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)syndesisSourceName
- the name of the syndesis source whose schemaColumns are being requested (cannot be empty)null
)KomodoRestException
- if there is a problem finding the specified syndesis source or constructing the JSON representation@GET @Path(value="syndesisSourceStatuses") @Produces(value="application/json") public javax.ws.rs.core.Response getSyndesisSourceStatuses(@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 JSON document@GET @Path(value="syndesisSourceStatuses/{syndesisSourceName}") @Produces(value="application/json") public javax.ws.rs.core.Response getSyndesisSourceStatusesByName(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="syndesisSourceName") String syndesisSourceName) throws KomodoRestException
KomodoRestException
@GET @Path(value="publish") @Produces(value="application/json") public javax.ws.rs.core.Response getVirtualizations(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @QueryParam(value="includeInProgress") boolean includeInProgressServices) throws KomodoRestException
KomodoRestException
@GET @Path(value="publish/{vdbName}") @Produces(value="application/json") public javax.ws.rs.core.Response getVirtualizationStatus(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
KomodoRestException
@GET @Path(value="publishLogs/{vdbName}") @Produces(value="application/json") public javax.ws.rs.core.Response getVirtualizationLogs(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
KomodoRestException
@DELETE @Path(value="publish/{vdbName}") @Produces(value="application/json") public javax.ws.rs.core.Response deleteVirtualization(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="vdbName") String vdbName) throws KomodoRestException
KomodoRestException
@POST @Path(value="publish") @Produces(value="application/json") public javax.ws.rs.core.Response publishVirtualization(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, PublishRequestPayload payload) throws KomodoRestException
KomodoRestException
Copyright © 2013–2019. All rights reserved.