Package com.flowable.serviceregistry.api.repository

Interface ServiceRegistryRepositoryService

All Known Implementing Classes:
ServiceRegistryRepositoryServiceImpl
public interface ServiceRegistryRepositoryService

  • Method Details

    • createDeployment

      ServiceDeploymentBuilder createDeployment()
      Starts creating a new deployment

    • getDeploymentResourceNames

      List<String> getDeploymentResourceNames(String deploymentId)
      Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
      Parameters:
      deploymentId - id of the deployment, cannot be null.

    • getResourceAsStream

      InputStream getResourceAsStream(String deploymentId, 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:
      FlowableObjectNotFoundException - when the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.

    • getServiceDefinitionModel

      ServiceDefinitionModel getServiceDefinitionModel(String serviceDefinitionId)
      Returns the ServiceDefinitionModel including all service model info.

    • getServiceDefinitionModelByKey

      ServiceDefinitionModel getServiceDefinitionModelByKey(String serviceDefinitionKey)
      Returns the ServiceDefinitionModel including all service model info, using the service definition key and resolving the key to the latest version.

    • getServiceDefinitionModelByKeyAndTenantId

      ServiceDefinitionModel getServiceDefinitionModelByKeyAndTenantId(String serviceDefinitionKey, String tenantId)
      Returns the ServiceDefinitionModel including all service model info, using the service definition key and resolving the key to the latest version.

    • getServiceDefinitionModelByKeyAndParentDeploymentId

      ServiceDefinitionModel getServiceDefinitionModelByKeyAndParentDeploymentId(String serviceDefinitionKey, String parentDeploymentId)
      Returns the ServiceDefinitionModel including all service model info, using the service definition key and resolving the key within the provided parent deployment.

    • getServiceDefinitionModelByKeyAndParentDeploymentIdAndTenantId

      ServiceDefinitionModel getServiceDefinitionModelByKeyAndParentDeploymentIdAndTenantId(String serviceDefinitionKey, String parentDeploymentId, String tenantId)
      Returns the ServiceDefinitionModel including all service model info, using the service definition key and resolving the key within the provided parent deployment and tenant id.

    • getServiceDefinitionModelByReferenceKeyAndTenantId

      ServiceDefinitionModel getServiceDefinitionModelByReferenceKeyAndTenantId(String referenceKey, String tenantId)
      Returns the ServiceDefinitionModel including all service model info, using the reference key and resolving the key to the latest version.

    • getServiceDefinitionModelByReferenceKeyAndParentDeploymentIdAndTenantId

      ServiceDefinitionModel getServiceDefinitionModelByReferenceKeyAndParentDeploymentIdAndTenantId(String referenceKey, String parentDeploymentId, String tenantId)
      Returns the ServiceDefinitionModel including all service model info, using the reference key and resolving the key to within the provided parent deployment.

    • convertServiceDefinitionModelToJson

      String convertServiceDefinitionModelToJson(String serviceDefinitionId)
      Returns the ServiceDefinitionModel as a JSON string.

    • getServiceDefinition

      ServiceDefinition getServiceDefinition(String serviceDefinitionId)
      Returns the ServiceDefinition including all service information like additional Properties (e.g. documentation).

    • getServiceDefinitionByKey

      ServiceDefinition getServiceDefinitionByKey(String serviceDefinitionKey)
      Returns the ServiceDefinition including all service information like additional Properties (e.g. documentation). The latest version for the given key will be returned.

    • getServiceDefinitionByKeyAndTenantId

      ServiceDefinition getServiceDefinitionByKeyAndTenantId(String serviceDefinitionKey, String tenantId)
      Returns the ServiceDefinition including all service information like additional Properties (e.g. documentation). The latest version for the given key will be returned.

    • getServiceDefinitionByKeyAndParentDeploymentId

      ServiceDefinition getServiceDefinitionByKeyAndParentDeploymentId(String serviceDefinitionKey, String parentDeploymentId)
      Returns the ServiceDefinition including all service information like additional Properties (e.g. documentation). The version for the provided parent deployment id and the given key will be returned.

    • getServiceDefinitionByKeyAndParentDeploymentIdAndTenantId

      ServiceDefinition getServiceDefinitionByKeyAndParentDeploymentIdAndTenantId(String serviceDefinitionKey, String parentDeploymentId, String tenantId)
      Returns the ServiceDefinition including all service information like additional Properties (e.g. documentation). The version for the provided parent deployment id, tenant id and the given key will be returned.

    • createServiceDefinitionQuery

      ServiceDefinitionQuery createServiceDefinitionQuery()
      Query service definitions

    • deleteDeployment

      void deleteDeployment(String deploymentId)
      Deletes the given deployment.
      Parameters:
      deploymentId - id of the deployment, cannot be null.

    • createDeploymentQuery

      ServiceDeploymentQuery createDeploymentQuery()
      Query deployments