public abstract class KomodoService extends Object implements KomodoRestV1Application.V1Constants
Modifier and Type | Class and Description |
---|---|
static interface |
KomodoService.QueryParamKeys
Query parameter keys used by the service methods.
|
protected static class |
KomodoService.SecurityPrincipal |
KomodoRestV1Application.V1Constants.App
Modifier and Type | Field and Description |
---|---|
protected static int |
ALL_AVAILABLE |
protected static String |
DSB_PROP_METADATA_STATUS |
protected static String |
DSB_PROP_METADATA_STATUS_MSG |
protected static String |
DSB_PROP_OWNER
VDB properties for DSB
|
protected static String |
DSB_PROP_SERVICE_SOURCE |
protected static String |
DSB_PROP_SOURCE_CONNECTION |
protected static String |
DSB_PROP_SOURCE_TRANSLATOR |
static String |
ENCRYPTED_PREFIX |
protected static String |
ENCRYPTION_ALGORITHM |
protected RestEntityFactory |
entityFactory |
protected org.komodo.core.KEngine |
kengine |
protected static org.komodo.utils.KLog |
LOGGER |
protected javax.ws.rs.core.SecurityContext |
securityContext |
protected static KomodoService.SecurityPrincipal |
SYSTEM_USER |
protected static org.komodo.utils.StringNameValidator |
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 |
---|
KomodoService() |
Modifier and Type | Method and Description |
---|---|
protected void |
awaitCallback(org.komodo.spi.repository.Repository.UnitOfWork transaction) |
protected KomodoService.SecurityPrincipal |
checkSecurityContext(javax.ws.rs.core.HttpHeaders headers) |
protected javax.ws.rs.core.Response |
commit(List<javax.ws.rs.core.MediaType> acceptableMediaTypes,
KRestEntity entity) |
protected javax.ws.rs.core.Response |
commit(org.komodo.spi.repository.Repository.UnitOfWork transaction,
List<javax.ws.rs.core.MediaType> acceptableMediaTypes) |
protected javax.ws.rs.core.Response |
commit(org.komodo.spi.repository.Repository.UnitOfWork transaction,
List<javax.ws.rs.core.MediaType> acceptableMediaTypes,
KRestEntity entity) |
protected javax.ws.rs.core.Response |
commit(org.komodo.spi.repository.Repository.UnitOfWork transaction,
List<javax.ws.rs.core.MediaType> acceptableMediaTypes,
List<? extends KRestEntity> entities) |
protected javax.ws.rs.core.Response |
commitNoConnectionFound(org.komodo.spi.repository.Repository.UnitOfWork uow,
List<javax.ws.rs.core.MediaType> mediaTypes,
String connectionName) |
protected javax.ws.rs.core.Response |
commitNoDataRoleFound(org.komodo.spi.repository.Repository.UnitOfWork uow,
List<javax.ws.rs.core.MediaType> mediaTypes,
String dataRoleId,
String vdbName) |
protected javax.ws.rs.core.Response |
commitNoDataserviceFound(org.komodo.spi.repository.Repository.UnitOfWork uow,
List<javax.ws.rs.core.MediaType> mediaTypes,
String dataserviceName) |
protected javax.ws.rs.core.Response |
commitNoModelFound(org.komodo.spi.repository.Repository.UnitOfWork uow,
List<javax.ws.rs.core.MediaType> mediaTypes,
String modelName,
String vdbName) |
protected javax.ws.rs.core.Response |
commitNoPermissionFound(org.komodo.spi.repository.Repository.UnitOfWork uow,
List<javax.ws.rs.core.MediaType> mediaTypes,
String permissionId,
String dataRoleId,
String vdbName) |
protected javax.ws.rs.core.Response |
commitNoSourceVdbFound(org.komodo.spi.repository.Repository.UnitOfWork uow,
List<javax.ws.rs.core.MediaType> mediaTypes) |
protected javax.ws.rs.core.Response |
commitNoTableFound(org.komodo.spi.repository.Repository.UnitOfWork uow,
List<javax.ws.rs.core.MediaType> mediaTypes,
String tableName,
String modelName,
String vdbName) |
protected javax.ws.rs.core.Response |
commitNoTemplateFound(org.komodo.spi.repository.Repository.UnitOfWork uow,
List<javax.ws.rs.core.MediaType> mediaTypes,
String templateName) |
protected javax.ws.rs.core.Response |
commitNoVdbFound(org.komodo.spi.repository.Repository.UnitOfWork uow,
List<javax.ws.rs.core.MediaType> mediaTypes,
String vdbName) |
protected javax.ws.rs.core.Response |
createErrorResponse(javax.ws.rs.core.Response.Status returnCode,
List<javax.ws.rs.core.MediaType> mediaTypes,
RelationalMessages.Error errorType,
Object... errorMsgInputs) |
protected javax.ws.rs.core.Response |
createErrorResponse(javax.ws.rs.core.Response.Status returnCode,
List<javax.ws.rs.core.MediaType> mediaTypes,
String resultMsg) |
protected javax.ws.rs.core.Response |
createErrorResponse(javax.ws.rs.core.Response.Status returnCode,
List<javax.ws.rs.core.MediaType> mediaTypes,
Throwable ex,
RelationalMessages.Error errorType,
Object... errorMsgInputs) |
protected Object |
createErrorResponseEntity(List<javax.ws.rs.core.MediaType> acceptableMediaTypes,
String errorMessage) |
protected javax.ws.rs.core.Response |
createErrorResponseWithForbidden(List<javax.ws.rs.core.MediaType> mediaTypes,
RelationalMessages.Error errorType,
Object... errorMsgInputs) |
protected javax.ws.rs.core.Response |
createErrorResponseWithForbidden(List<javax.ws.rs.core.MediaType> mediaTypes,
Throwable ex,
RelationalMessages.Error errorType,
Object... errorMsgInputs) |
protected org.komodo.spi.repository.Repository.UnitOfWork |
createTransaction(KomodoService.SecurityPrincipal user,
String name,
boolean rollbackOnly) |
protected org.komodo.spi.repository.Repository.UnitOfWork |
createTransaction(KomodoService.SecurityPrincipal user,
String name,
boolean rollbackOnly,
org.komodo.spi.repository.Repository.UnitOfWorkListener callback) |
protected byte[] |
decode(String content) |
protected String |
decryptSensitiveData(javax.ws.rs.core.HttpHeaders headers,
String user,
String encrypted) |
protected String |
encode(byte[] content) |
protected String |
encryptSensitiveData(javax.ws.rs.core.HttpHeaders headers,
String user,
String plainText) |
protected Connection |
findConnection(org.komodo.spi.repository.Repository.UnitOfWork uow,
String connectionName) |
protected Dataservice |
findDataservice(org.komodo.spi.repository.Repository.UnitOfWork uow,
String dataserviceName) |
protected Vdb |
findVdb(org.komodo.spi.repository.Repository.UnitOfWork uow,
String vdbName) |
protected AuthHandlingFilter.OAuthCredentials |
getAuthenticationToken() |
protected Profile |
getUserProfile(org.komodo.spi.repository.Repository.UnitOfWork transaction) |
static String |
getViewEditorStateId(String vdbName,
String viewName)
*** The result ID needs to match the format that Beetle Studio uses.
|
static String |
getViewEditorStateIdPrefix(String vdbName)
*** The prefix needs to match the format that Beetle Studio uses.
|
protected ViewEditorState[] |
getViewEditorStates(org.komodo.spi.repository.Repository.UnitOfWork uow,
String searchPattern) |
protected WorkspaceManager |
getWorkspaceManager(org.komodo.spi.repository.Repository.UnitOfWork transaction) |
protected boolean |
isAcceptable(List<javax.ws.rs.core.MediaType> acceptableTypes,
javax.ws.rs.core.MediaType candidate) |
protected javax.ws.rs.core.Response.ResponseBuilder |
notAcceptableMediaTypesBuilder() |
static String |
protectPrefix(String value) |
protected boolean |
removeEditorState(org.komodo.spi.repository.Repository.UnitOfWork uow,
String viewEditorStateId) |
protected boolean |
removeEditorState(org.komodo.spi.repository.Repository.UnitOfWork uow,
ViewEditorState editorState) |
protected void |
setProperties(org.komodo.spi.repository.Repository.UnitOfWork uow,
Connection connection,
RestConnection restConnection) |
protected org.komodo.spi.repository.Repository.UnitOfWork |
systemTx(String description,
boolean rollback) |
static String |
unprotectPrefix(String value) |
protected String |
uri(String... segments) |
public static final String ENCRYPTED_PREFIX
protected static final String ENCRYPTION_ALGORITHM
protected static final org.komodo.utils.KLog LOGGER
protected static final org.komodo.utils.StringNameValidator VALIDATOR
protected static final int ALL_AVAILABLE
protected static final String DSB_PROP_OWNER
protected static final String DSB_PROP_SERVICE_SOURCE
protected static final String DSB_PROP_SOURCE_CONNECTION
protected static final String DSB_PROP_SOURCE_TRANSLATOR
protected static final String DSB_PROP_METADATA_STATUS
protected static final String DSB_PROP_METADATA_STATUS_MSG
protected static final KomodoService.SecurityPrincipal SYSTEM_USER
@Autowired protected org.komodo.core.KEngine kengine
protected RestEntityFactory entityFactory
@Context protected javax.ws.rs.core.SecurityContext securityContext
public static String getViewEditorStateId(String vdbName, String viewName)
vdbName
- the VDB the view is contained in (cannot be empty)viewName
- the view name (cannot be empty)public static String getViewEditorStateIdPrefix(String vdbName)
vdbName
- the VDB the view is contained in (cannot be empty)public static String protectPrefix(String value)
value
- the valuepublic static String unprotectPrefix(String value)
value
- the valueprotected AuthHandlingFilter.OAuthCredentials getAuthenticationToken()
protected KomodoService.SecurityPrincipal checkSecurityContext(javax.ws.rs.core.HttpHeaders headers)
protected String encode(byte[] content)
content
- protected byte[] decode(String content)
content
- protected WorkspaceManager getWorkspaceManager(org.komodo.spi.repository.Repository.UnitOfWork transaction) throws org.komodo.spi.KException
org.komodo.spi.KException
protected Profile getUserProfile(org.komodo.spi.repository.Repository.UnitOfWork transaction) throws org.komodo.spi.KException
org.komodo.spi.KException
protected boolean removeEditorState(org.komodo.spi.repository.Repository.UnitOfWork uow, String viewEditorStateId) throws Exception
uow
- the transactionviewEditorStateId
- the editor state identifiertrue
if editor state was deleted; false
if not foundException
- if an error occursprotected boolean removeEditorState(org.komodo.spi.repository.Repository.UnitOfWork uow, ViewEditorState editorState) throws Exception
uow
- the transaction to useeditorState
- the editor state being deletedtrue
if successfully deletedException
- if an error occursprotected ViewEditorState[] getViewEditorStates(org.komodo.spi.repository.Repository.UnitOfWork uow, String searchPattern) throws Exception
uow
- the transaction to usesearchPattern
- the optional search patternnull
but can be empty)Exception
- if an error occursprotected String encryptSensitiveData(javax.ws.rs.core.HttpHeaders headers, String user, String plainText)
protected String decryptSensitiveData(javax.ws.rs.core.HttpHeaders headers, String user, String encrypted)
protected Object createErrorResponseEntity(List<javax.ws.rs.core.MediaType> acceptableMediaTypes, String errorMessage)
protected javax.ws.rs.core.Response createErrorResponse(javax.ws.rs.core.Response.Status returnCode, List<javax.ws.rs.core.MediaType> mediaTypes, Throwable ex, RelationalMessages.Error errorType, Object... errorMsgInputs)
protected javax.ws.rs.core.Response createErrorResponse(javax.ws.rs.core.Response.Status returnCode, List<javax.ws.rs.core.MediaType> mediaTypes, RelationalMessages.Error errorType, Object... errorMsgInputs)
protected javax.ws.rs.core.Response createErrorResponseWithForbidden(List<javax.ws.rs.core.MediaType> mediaTypes, Throwable ex, RelationalMessages.Error errorType, Object... errorMsgInputs)
protected javax.ws.rs.core.Response createErrorResponseWithForbidden(List<javax.ws.rs.core.MediaType> mediaTypes, RelationalMessages.Error errorType, Object... errorMsgInputs)
protected javax.ws.rs.core.Response createErrorResponse(javax.ws.rs.core.Response.Status returnCode, List<javax.ws.rs.core.MediaType> mediaTypes, String resultMsg)
protected javax.ws.rs.core.Response.ResponseBuilder notAcceptableMediaTypesBuilder()
protected boolean isAcceptable(List<javax.ws.rs.core.MediaType> acceptableTypes, javax.ws.rs.core.MediaType candidate)
protected javax.ws.rs.core.Response commit(List<javax.ws.rs.core.MediaType> acceptableMediaTypes, KRestEntity entity) throws Exception
Exception
protected javax.ws.rs.core.Response commit(org.komodo.spi.repository.Repository.UnitOfWork transaction, List<javax.ws.rs.core.MediaType> acceptableMediaTypes, KRestEntity entity) throws Exception
Exception
protected javax.ws.rs.core.Response commit(org.komodo.spi.repository.Repository.UnitOfWork transaction, List<javax.ws.rs.core.MediaType> acceptableMediaTypes) throws Exception
Exception
protected javax.ws.rs.core.Response commit(org.komodo.spi.repository.Repository.UnitOfWork transaction, List<javax.ws.rs.core.MediaType> acceptableMediaTypes, List<? extends KRestEntity> entities) throws Exception
Exception
protected org.komodo.spi.repository.Repository.UnitOfWork createTransaction(KomodoService.SecurityPrincipal user, String name, boolean rollbackOnly, org.komodo.spi.repository.Repository.UnitOfWorkListener callback) throws org.komodo.spi.KException
user
- the user initiating the transactionname
- the name of the transaction (cannot be empty)rollbackOnly
- true
if transaction must be rolled backcallback
- the callback to fire when the transaction is committednull
)org.komodo.spi.KException
- if there is an error creating the transactionprotected org.komodo.spi.repository.Repository.UnitOfWork createTransaction(KomodoService.SecurityPrincipal user, String name, boolean rollbackOnly) throws org.komodo.spi.KException
user
- the user initiating the transactionname
- the name of the transaction (cannot be empty)rollbackOnly
- true
if transaction must be rolled backnull
)org.komodo.spi.KException
- if there is an error creating the transactionprotected Vdb findVdb(org.komodo.spi.repository.Repository.UnitOfWork uow, String vdbName) throws org.komodo.spi.KException
org.komodo.spi.KException
protected org.komodo.spi.repository.Repository.UnitOfWork systemTx(String description, boolean rollback) throws org.komodo.spi.KException
org.komodo.spi.KException
protected void awaitCallback(org.komodo.spi.repository.Repository.UnitOfWork transaction) throws org.komodo.spi.KException
org.komodo.spi.KException
protected Dataservice findDataservice(org.komodo.spi.repository.Repository.UnitOfWork uow, String dataserviceName) throws org.komodo.spi.KException
org.komodo.spi.KException
protected Connection findConnection(org.komodo.spi.repository.Repository.UnitOfWork uow, String connectionName) throws org.komodo.spi.KException
org.komodo.spi.KException
protected javax.ws.rs.core.Response commitNoVdbFound(org.komodo.spi.repository.Repository.UnitOfWork uow, List<javax.ws.rs.core.MediaType> mediaTypes, String vdbName) throws Exception
Exception
protected javax.ws.rs.core.Response commitNoSourceVdbFound(org.komodo.spi.repository.Repository.UnitOfWork uow, List<javax.ws.rs.core.MediaType> mediaTypes) throws Exception
Exception
protected javax.ws.rs.core.Response commitNoDataserviceFound(org.komodo.spi.repository.Repository.UnitOfWork uow, List<javax.ws.rs.core.MediaType> mediaTypes, String dataserviceName) throws Exception
Exception
protected javax.ws.rs.core.Response commitNoConnectionFound(org.komodo.spi.repository.Repository.UnitOfWork uow, List<javax.ws.rs.core.MediaType> mediaTypes, String connectionName) throws Exception
Exception
protected javax.ws.rs.core.Response commitNoTemplateFound(org.komodo.spi.repository.Repository.UnitOfWork uow, List<javax.ws.rs.core.MediaType> mediaTypes, String templateName) throws Exception
Exception
protected javax.ws.rs.core.Response commitNoModelFound(org.komodo.spi.repository.Repository.UnitOfWork uow, List<javax.ws.rs.core.MediaType> mediaTypes, String modelName, String vdbName) throws Exception
Exception
protected javax.ws.rs.core.Response commitNoTableFound(org.komodo.spi.repository.Repository.UnitOfWork uow, List<javax.ws.rs.core.MediaType> mediaTypes, String tableName, String modelName, String vdbName) throws Exception
Exception
protected javax.ws.rs.core.Response commitNoDataRoleFound(org.komodo.spi.repository.Repository.UnitOfWork uow, List<javax.ws.rs.core.MediaType> mediaTypes, String dataRoleId, String vdbName) throws Exception
Exception
protected javax.ws.rs.core.Response commitNoPermissionFound(org.komodo.spi.repository.Repository.UnitOfWork uow, List<javax.ws.rs.core.MediaType> mediaTypes, String permissionId, String dataRoleId, String vdbName) throws Exception
Exception
protected void setProperties(org.komodo.spi.repository.Repository.UnitOfWork uow, Connection connection, RestConnection restConnection) throws org.komodo.spi.KException
org.komodo.spi.KException
Copyright © 2013–2019. All rights reserved.