Package org.flowable.app.api
Interface AppRepositoryService
-
public interface AppRepositoryService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringconvertAppModelToJson(String appDefinitionId)Returns theAppModelas a JSON string.AppDefinitionQuerycreateAppDefinitionQuery()Query app definitionsAppDeploymentBuildercreateDeployment()Starts creating a new deploymentAppDeploymentQuerycreateDeploymentQuery()Query deploymentsvoiddeleteDeployment(String deploymentId, boolean cascade)Deletes the given deployment and cascade deletion to app instances, history case instances and jobs.AppDefinitiongetAppDefinition(String appDefinitionId)Returns theAppDefinitionincluding all App information like additional Properties (e.g.AppModelgetAppModel(String appDefinitionId)Returns theAppModelincluding all App model info.List<String>getDeploymentResourceNames(String deploymentId)Retrieves a list of deployment resources for the given deployment, ordered alphabetically.InputStreamgetResourceAsStream(String deploymentId, String resourceName)Gives access to a deployment resource through a stream of bytes.voidsetAppDefinitionCategory(String appDefinitionId, String category)Sets the category of the app definition.
-
-
-
Method Detail
-
createDeployment
AppDeploymentBuilder 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.
-
getAppModel
AppModel getAppModel(String appDefinitionId)
Returns theAppModelincluding all App model info.
-
convertAppModelToJson
String convertAppModelToJson(String appDefinitionId)
Returns theAppModelas a JSON string.
-
getAppDefinition
AppDefinition getAppDefinition(String appDefinitionId)
Returns theAppDefinitionincluding all App information like additional Properties (e.g. documentation).
-
deleteDeployment
void deleteDeployment(String deploymentId, boolean cascade)
Deletes the given deployment and cascade deletion to app instances, history case instances and jobs.- Parameters:
deploymentId- id of the deployment, cannot be null.
-
createDeploymentQuery
AppDeploymentQuery createDeploymentQuery()
Query deployments
-
createAppDefinitionQuery
AppDefinitionQuery createAppDefinitionQuery()
Query app definitions
-
setAppDefinitionCategory
void setAppDefinitionCategory(String appDefinitionId, String category)
Sets the category of the app definition. App definitions can be queried by category: seeAppDefinitionBaseQuery.appDefinitionCategory(String).- Throws:
FlowableObjectNotFoundException- if no app definition with the provided id can be found.
-
-