org.flowable.cmmn.engine.impl

Class CmmnRepositoryServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<CmmnEngineConfiguration>

org.flowable.cmmn.engine.impl.CmmnRepositoryServiceImpl

All Implemented Interfaces:

CmmnRepositoryService

public class CmmnRepositoryServiceImpl
extends CommonEngineServiceImpl<CmmnEngineConfiguration>
implements CmmnRepositoryService

Author:

Joram Barrez, Tijs Rademakers

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor and Description
CmmnRepositoryServiceImpl(CmmnEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method and Description
void	addCandidateStarterGroup(String caseDefinitionId, String groupId) Authorizes a candidate group for a case definition.
void	addCandidateStarterUser(String caseDefinitionId, String userId) Authorizes a candidate user for a case definition.
void	changeDeploymentParentDeploymentId(String deploymentId, String newParentDeploymentId) Changes the parent deployment id of a deployment.
CaseDefinitionQuery	createCaseDefinitionQuery() Query case definitions
CmmnDeploymentBuilder	createDeployment() Starts creating a new deployment
CmmnDeploymentQuery	createDeploymentQuery() Query deployments
void	deleteCandidateStarterGroup(String caseDefinitionId, String groupId) Removes the authorization of a candidate group for a case definition.
void	deleteCandidateStarterUser(String caseDefinitionId, String userId) Removes the authorization of a candidate user for a case definition.
void	deleteDeployment(String deploymentId, boolean cascade) Deletes the given deployment and cascade deletion to case instances, history case instances and jobs.
CmmnDeployment	deploy(CmmnDeploymentBuilderImpl deploymentBuilder)
CaseDefinition	getCaseDefinition(String caseDefinitionId) Returns the CaseDefinition including all CMMN information like additional Properties (e.g.
InputStream	getCaseDiagram(String caseDefinitionId) Gives access to a deployed case diagram, e.g., a PNG image, through a stream of bytes.
CmmnModel	getCmmnModel(String caseDefinitionId) Gives access to a deployed case model, e.g., a CMMN 1.1 XML file, through a stream of bytes.
List<DmnDecision>	getDecisionsForCaseDefinition(String caseDefinitionId) Retrieves the DmnDecisions associated with the given case definition.
List<DmnDecision>	getDecisionTablesForCaseDefinition(String caseDefinitionId) Deprecated.
List<String>	getDeploymentResourceNames(String deploymentId) Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
List<FormDefinition>	getFormDefinitionsForCaseDefinition(String caseDefinitionId) Retrieves the FormDefinitions associated with the given case definition.
List<IdentityLink>	getIdentityLinksForCaseDefinition(String caseDefinitionId) Retrieves the IdentityLinks associated with the given case definition.
InputStream	getResourceAsStream(String deploymentId, String resourceName) Gives access to a deployment resource through a stream of bytes.
void	setCaseDefinitionCategory(String caseDefinitionId, String category) Sets the category of the case definition.

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmmnRepositoryServiceImpl

public CmmnRepositoryServiceImpl(CmmnEngineConfiguration engineConfiguration)

Method Detail

createDeployment

public CmmnDeploymentBuilder createDeployment()

Description copied from interface: CmmnRepositoryService

Starts creating a new deployment

Specified by:

createDeployment in interface CmmnRepositoryService

getDeploymentResourceNames

public List<String> getDeploymentResourceNames(String deploymentId)

Description copied from interface: CmmnRepositoryService

Retrieves a list of deployment resources for the given deployment, ordered alphabetically.

Specified by:

getDeploymentResourceNames in interface CmmnRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

getResourceAsStream

public InputStream getResourceAsStream(String deploymentId,
                                       String resourceName)

Description copied from interface: CmmnRepositoryService

Gives access to a deployment resource through a stream of bytes.

Specified by:

getResourceAsStream in interface CmmnRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

resourceName - name of the resource, cannot be null.

deploy

public CmmnDeployment deploy(CmmnDeploymentBuilderImpl deploymentBuilder)

getCaseDefinition

public CaseDefinition getCaseDefinition(String caseDefinitionId)

Description copied from interface: CmmnRepositoryService

Returns the CaseDefinition including all CMMN information like additional Properties (e.g. documentation).

Specified by:

getCaseDefinition in interface CmmnRepositoryService

getCmmnModel

public CmmnModel getCmmnModel(String caseDefinitionId)

Description copied from interface: CmmnRepositoryService

Gives access to a deployed case model, e.g., a CMMN 1.1 XML file, through a stream of bytes.

Specified by:

getCmmnModel in interface CmmnRepositoryService

Parameters:

caseDefinitionId - id of a CaseDefinition, cannot be null.

getCaseDiagram

public InputStream getCaseDiagram(String caseDefinitionId)

Description copied from interface: CmmnRepositoryService

Gives access to a deployed case diagram, e.g., a PNG image, through a stream of bytes.

Specified by:

getCaseDiagram in interface CmmnRepositoryService

Parameters:

caseDefinitionId - id of a CaseDefinition, cannot be null.

Returns:

null when the diagram resource name of a CaseDefinition is null.

deleteDeployment

public void deleteDeployment(String deploymentId,
                             boolean cascade)

Description copied from interface: CmmnRepositoryService

Deletes the given deployment and cascade deletion to case instances, history case instances and jobs.

Specified by:

deleteDeployment in interface CmmnRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

createDeploymentQuery

public CmmnDeploymentQuery createDeploymentQuery()

Description copied from interface: CmmnRepositoryService

Query deployments

Specified by:

createDeploymentQuery in interface CmmnRepositoryService

createCaseDefinitionQuery

public CaseDefinitionQuery createCaseDefinitionQuery()

Description copied from interface: CmmnRepositoryService

Query case definitions

Specified by:

createCaseDefinitionQuery in interface CmmnRepositoryService

addCandidateStarterUser

public void addCandidateStarterUser(String caseDefinitionId,
                                    String userId)

Description copied from interface: CmmnRepositoryService

Authorizes a candidate user for a case definition.

Specified by:

addCandidateStarterUser in interface CmmnRepositoryService

Parameters:

caseDefinitionId - id of the case definition, cannot be null.

userId - id of the user involve, cannot be null.

addCandidateStarterGroup

public void addCandidateStarterGroup(String caseDefinitionId,
                                     String groupId)

Description copied from interface: CmmnRepositoryService

Authorizes a candidate group for a case definition.

Specified by:

addCandidateStarterGroup in interface CmmnRepositoryService

Parameters:

caseDefinitionId - id of the case definition, cannot be null.

groupId - id of the group involve, cannot be null.

deleteCandidateStarterGroup

public void deleteCandidateStarterGroup(String caseDefinitionId,
                                        String groupId)

Description copied from interface: CmmnRepositoryService

Removes the authorization of a candidate group for a case definition.

Specified by:

deleteCandidateStarterGroup in interface CmmnRepositoryService

Parameters:

caseDefinitionId - id of the case definition, cannot be null.

groupId - id of the group involve, cannot be null.

deleteCandidateStarterUser

public void deleteCandidateStarterUser(String caseDefinitionId,
                                       String userId)

Description copied from interface: CmmnRepositoryService

Removes the authorization of a candidate user for a case definition.

Specified by:

deleteCandidateStarterUser in interface CmmnRepositoryService

Parameters:

caseDefinitionId - id of the case definition, cannot be null.

userId - id of the user involve, cannot be null.

getIdentityLinksForCaseDefinition

public List<IdentityLink> getIdentityLinksForCaseDefinition(String caseDefinitionId)

Description copied from interface: CmmnRepositoryService

Retrieves the IdentityLinks associated with the given case definition. Such an IdentityLink informs how a certain identity (eg. group or user) is authorized for a certain case definition

Specified by:

getIdentityLinksForCaseDefinition in interface CmmnRepositoryService

setCaseDefinitionCategory

public void setCaseDefinitionCategory(String caseDefinitionId,
                                      String category)

Description copied from interface: CmmnRepositoryService

Sets the category of the case definition. Case definitions can be queried by category: see CaseDefinitionQuery.caseDefinitionCategory(String).

Specified by:

setCaseDefinitionCategory in interface CmmnRepositoryService

changeDeploymentParentDeploymentId

public void changeDeploymentParentDeploymentId(String deploymentId,
                                               String newParentDeploymentId)

Description copied from interface: CmmnRepositoryService

Changes the parent deployment id of a deployment. This is used to move deployments to a different app deployment parent.

Specified by:

changeDeploymentParentDeploymentId in interface CmmnRepositoryService

Parameters:

deploymentId - The id of the deployment of which the parent deployment identifier will be changed.

newParentDeploymentId - The new parent deployment identifier.

getDecisionsForCaseDefinition

public List<DmnDecision> getDecisionsForCaseDefinition(String caseDefinitionId)

Description copied from interface: CmmnRepositoryService

Retrieves the DmnDecisions associated with the given case definition.

Specified by:

getDecisionsForCaseDefinition in interface CmmnRepositoryService

Parameters:

caseDefinitionId - id of the case definition, cannot be null.

getDecisionTablesForCaseDefinition

@Deprecated
public List<DmnDecision> getDecisionTablesForCaseDefinition(String caseDefinitionId)

Deprecated.

Description copied from interface: CmmnRepositoryService

Retrieves the DmnDecisions associated with the given case definition.

Specified by:

getDecisionTablesForCaseDefinition in interface CmmnRepositoryService

Parameters:

caseDefinitionId - id of the case definition, cannot be null.

getFormDefinitionsForCaseDefinition

public List<FormDefinition> getFormDefinitionsForCaseDefinition(String caseDefinitionId)

Description copied from interface: CmmnRepositoryService

Retrieves the FormDefinitions associated with the given case definition.

Specified by:

getFormDefinitionsForCaseDefinition in interface CmmnRepositoryService

Parameters:

caseDefinitionId - id of the case definition, cannot be null.