@Component @Path(value="service") public final class KomodoUtilService extends KomodoService
KomodoService.QueryParamKeys, KomodoService.SecurityPrincipal
KomodoRestV1Application.V1Constants.App
Modifier and Type | Field and Description |
---|---|
static String |
APP_DESCRIPTION |
static String |
APP_NAME |
static String |
APP_TITLE |
static String |
APP_VERSION |
static String[] |
SAMPLES
The sample vdbs provided by this service
|
static String |
USER_NAME |
static String |
WORKSPACE |
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 |
---|
KomodoUtilService() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
about(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 ktype) |
static InputStream |
getVdbSample(String sampleName) |
javax.ws.rs.core.Response |
getViewEditorState(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String viewEditorStateId)
Get the view editor state with the given id from the user's profile
|
javax.ws.rs.core.Response |
getViewEditorStates(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo)
Get all view editor states from the user's profile
|
javax.ws.rs.core.Response |
importSampleData(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo)
Attempt to import the sample data into the engine
|
javax.ws.rs.core.Response |
removeGitRepository(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String gitRepositoryName) |
javax.ws.rs.core.Response |
removeViewEditorState(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String viewEditorStateId) |
javax.ws.rs.core.Response |
stashGitRepository(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String gitRepositoryConfig) |
javax.ws.rs.core.Response |
stashViewEditorStates(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String viewEditorStateConfig)
Stash an array of ViewEditorStates
|
javax.ws.rs.core.Response |
userProfile(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo) |
javax.ws.rs.core.Response |
validateValue(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String validateValue) |
javax.ws.rs.core.Response |
validateViewDefinition(javax.ws.rs.core.HttpHeaders headers,
javax.ws.rs.core.UriInfo uriInfo,
String viewDefinitionConfig)
Validate the supplied ViewDefinition
|
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 static final String APP_NAME
public static final String APP_TITLE
public static final String APP_DESCRIPTION
public static final String APP_VERSION
public static final String USER_NAME
public static final String WORKSPACE
public static final String[] SAMPLES
@GET @Path(value="about") @Produces(value="application/json") public javax.ws.rs.core.Response about(@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
)KomodoRestException
- if error occurspublic static InputStream getVdbSample(String sampleName)
sampleName
- @POST @Path(value="samples") @Produces(value="application/json") public javax.ws.rs.core.Response importSampleData(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo)
@GET @Path(value="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, @QueryParam(value="ktype") String ktype) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)ktype
- the komodo type parameternull
).
If a ktype parameter is specified conforming to a KomodoType then only the associated
element of the teiid schema is returned.KomodoRestException
- if there is a problem constructing the VDBs JSON document@GET @Path(value="validate/{validateValue}") @Produces(value="text/plain") public javax.ws.rs.core.Response validateValue(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="validateValue") String validateValue) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)validateValue
- the value 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 value or constructing
the response@GET @Path(value="userProfile") public javax.ws.rs.core.Response userProfile(@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
)KomodoRestException
- if error occurs@PUT @Path(value="userProfile/gitRepository") public javax.ws.rs.core.Response stashGitRepository(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, String gitRepositoryConfig) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)KomodoRestException
- if error occurs@DELETE @Path(value="userProfile/gitRepository/{gitRepositoryName}") public javax.ws.rs.core.Response removeGitRepository(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="gitRepositoryName") String gitRepositoryName) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)KomodoRestException
- if error occurs@GET @Path(value="userProfile/viewEditorState") @Produces(value="application/json") public javax.ws.rs.core.Response getViewEditorStates(@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 Connection JSON document@GET @Path(value="userProfile/viewEditorState/{viewEditorStateId}") @Produces(value="application/json") public javax.ws.rs.core.Response getViewEditorState(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="viewEditorStateId") String viewEditorStateId) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)null
)KomodoRestException
- if there is a problem constructing the Connection JSON document@PUT @Path(value="userProfile/viewEditorStates") public javax.ws.rs.core.Response stashViewEditorStates(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, String viewEditorStateConfig) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)KomodoRestException
- if error occurs@POST @Path(value="userProfile/validateViewDefinition") public javax.ws.rs.core.Response validateViewDefinition(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, String viewDefinitionConfig) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)KomodoRestException
- if error occurs@DELETE @Path(value="userProfile/viewEditorState/{viewEditorStateId}") public javax.ws.rs.core.Response removeViewEditorState(@Context javax.ws.rs.core.HttpHeaders headers, @Context javax.ws.rs.core.UriInfo uriInfo, @PathParam(value="viewEditorStateId") String viewEditorStateId) throws KomodoRestException
headers
- the request headers (never null
)uriInfo
- the request URI information (never null
)KomodoRestException
- if error occursCopyright © 2013–2019. All rights reserved.