Interface ServiceRegistryRepositoryService
- All Known Implementing Classes:
ServiceRegistryRepositoryServiceImpl
public interface ServiceRegistryRepositoryService
-
Method Summary
Modifier and Type Method Description java.lang.String
convertServiceDefinitionModelToJson(java.lang.String serviceDefinitionId)
Returns theServiceDefinitionModel
as a JSON string.ServiceDeploymentBuilder
createDeployment()
Starts creating a new deploymentServiceDeploymentQuery
createDeploymentQuery()
Query deploymentsServiceDefinitionQuery
createServiceDefinitionQuery()
Query service definitionsvoid
deleteDeployment(java.lang.String deploymentId)
Deletes the given deployment.java.util.List<java.lang.String>
getDeploymentResourceNames(java.lang.String deploymentId)
Retrieves a list of deployment resources for the given deployment, ordered alphabetically.java.io.InputStream
getResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)
Gives access to a deployment resource through a stream of bytes.ServiceDefinition
getServiceDefinition(java.lang.String serviceDefinitionId)
Returns theServiceDefinition
including all service information like additional Properties (e.g.ServiceDefinition
getServiceDefinitionByKey(java.lang.String serviceDefinitionKey)
Returns theServiceDefinition
including all service information like additional Properties (e.g.ServiceDefinition
getServiceDefinitionByKeyAndTenantId(java.lang.String serviceDefinitionKey, java.lang.String tenantId)
Returns theServiceDefinition
including all service information like additional Properties (e.g.ServiceDefinitionModel
getServiceDefinitionModel(java.lang.String serviceDefinitionId)
Returns theServiceDefinitionModel
including all service model info.ServiceDefinitionModel
getServiceDefinitionModelByKey(java.lang.String serviceDefinitionKey)
Returns theServiceDefinitionModel
including all service model info, using the service definition key and resolving the key to the latest version.ServiceDefinitionModel
getServiceDefinitionModelByKeyAndTenantId(java.lang.String serviceDefinitionKey, java.lang.String tenantId)
Returns theServiceDefinitionModel
including all service model info, using the service definition key and resolving the key to the latest version.
-
Method Details
-
createDeployment
ServiceDeploymentBuilder createDeployment()Starts creating a new deployment -
getDeploymentResourceNames
java.util.List<java.lang.String> getDeploymentResourceNames(java.lang.String deploymentId)Retrieves a list of deployment resources for the given deployment, ordered alphabetically.- Parameters:
deploymentId
- id of the deployment, cannot be null.
-
getResourceAsStream
java.io.InputStream getResourceAsStream(java.lang.String deploymentId, java.lang.String resourceName)Gives access to a deployment resource through a stream of bytes.- Parameters:
deploymentId
- id of the deployment, cannot be null.resourceName
- name of the resource, cannot be null.- Throws:
org.flowable.common.engine.api.FlowableObjectNotFoundException
- when the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.
-
getServiceDefinitionModel
Returns theServiceDefinitionModel
including all service model info. -
getServiceDefinitionModelByKey
Returns theServiceDefinitionModel
including all service model info, using the service definition key and resolving the key to the latest version. -
getServiceDefinitionModelByKeyAndTenantId
ServiceDefinitionModel getServiceDefinitionModelByKeyAndTenantId(java.lang.String serviceDefinitionKey, java.lang.String tenantId)Returns theServiceDefinitionModel
including all service model info, using the service definition key and resolving the key to the latest version. -
convertServiceDefinitionModelToJson
java.lang.String convertServiceDefinitionModelToJson(java.lang.String serviceDefinitionId)Returns theServiceDefinitionModel
as a JSON string. -
getServiceDefinition
Returns theServiceDefinition
including all service information like additional Properties (e.g. documentation). -
getServiceDefinitionByKey
Returns theServiceDefinition
including all service information like additional Properties (e.g. documentation). The latest version for the given key will be returned. -
getServiceDefinitionByKeyAndTenantId
ServiceDefinition getServiceDefinitionByKeyAndTenantId(java.lang.String serviceDefinitionKey, java.lang.String tenantId)Returns theServiceDefinition
including all service information like additional Properties (e.g. documentation). The latest version for the given key will be returned. -
createServiceDefinitionQuery
ServiceDefinitionQuery createServiceDefinitionQuery()Query service definitions -
deleteDeployment
void deleteDeployment(java.lang.String deploymentId)Deletes the given deployment.- Parameters:
deploymentId
- id of the deployment, cannot be null.
-
createDeploymentQuery
ServiceDeploymentQuery createDeploymentQuery()Query deployments
-