Package com.flowable.content.engine.impl.repository

Class DocumentRepositoryServiceImpl

java.lang.Object

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

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

com.flowable.content.engine.impl.repository.DocumentRepositoryServiceImpl

All Implemented Interfaces:

DocumentRepositoryService

public class DocumentRepositoryServiceImpl
extends CommonEngineServiceImpl<ContentEngineConfiguration>
implements DocumentRepositoryService

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	Description
DocumentRepositoryServiceImpl(ContentEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method	Description
String	convertDocumentDefinitionModelToJson(String documentDefinitionId)	Returns the DocumentDefinitionModel as a JSON string.
DocumentDeploymentBuilder	createDeployment()	Starts creating a new deployment
DocumentDeploymentQuery	createDeploymentQuery()	Query deployments
DocumentDefinitionQuery	createDocumentDefinitionQuery()	Query case definitions
void	deleteDeployment(String deploymentId)	Deletes the given deployment.
DocumentDeployment	deploy(DocumentDeploymentBuilderImpl deploymentBuilder)
List<String>	getDeploymentResourceNames(String deploymentId)	Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
DocumentDefinition	getDocumentDefinition(String documentDefinitionId)	Returns the DocumentDefinition including all action information like additional Properties (e.g.
DocumentDefinition	getDocumentDefinitionByKey(String documentDefinitionKey)	Returns the latest DocumentDefinition for the given key.
DocumentDefinition	getDocumentDefinitionByKeyAndTenantId(String documentDefinitionKey, String tenantId)	Returns the latest DocumentDefinition for the given key in the given tenant.
DocumentDefinitionModel	getDocumentDefinitionModel(String documentDefinitionId)	Returns the DocumentDefinitionModel including all action model info.
InputStream	getResourceAsStream(String deploymentId, String resourceName)	Gives access to a deployment resource through a stream of bytes.
void	setDocumentDefinitionCategory(String documentDefinitionId, String category)

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

DocumentRepositoryServiceImpl

public DocumentRepositoryServiceImpl(ContentEngineConfiguration engineConfiguration)

Method Detail

createDeployment

public DocumentDeploymentBuilder createDeployment()

Description copied from interface: DocumentRepositoryService

Starts creating a new deployment

Specified by:

createDeployment in interface DocumentRepositoryService

getDeploymentResourceNames

public List<String> getDeploymentResourceNames(String deploymentId)

Description copied from interface: DocumentRepositoryService

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

Specified by:

getDeploymentResourceNames in interface DocumentRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

getResourceAsStream

public InputStream getResourceAsStream(String deploymentId,
                                       String resourceName)

Description copied from interface: DocumentRepositoryService

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

Specified by:

getResourceAsStream in interface DocumentRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

resourceName - name of the resource, cannot be null.

deploy

public DocumentDeployment deploy(DocumentDeploymentBuilderImpl deploymentBuilder)

getDocumentDefinition

public DocumentDefinition getDocumentDefinition(String documentDefinitionId)

Description copied from interface: DocumentRepositoryService

Returns the DocumentDefinition including all action information like additional Properties (e.g. documentation).

Specified by:

getDocumentDefinition in interface DocumentRepositoryService

getDocumentDefinitionByKey

public DocumentDefinition getDocumentDefinitionByKey(String documentDefinitionKey)

Description copied from interface: DocumentRepositoryService

Returns the latest DocumentDefinition for the given key.

Specified by:

getDocumentDefinitionByKey in interface DocumentRepositoryService

getDocumentDefinitionByKeyAndTenantId

public DocumentDefinition getDocumentDefinitionByKeyAndTenantId(String documentDefinitionKey,
                                                                String tenantId)

Description copied from interface: DocumentRepositoryService

Returns the latest DocumentDefinition for the given key in the given tenant.

Specified by:

getDocumentDefinitionByKeyAndTenantId in interface DocumentRepositoryService

getDocumentDefinitionModel

public DocumentDefinitionModel getDocumentDefinitionModel(String documentDefinitionId)

Description copied from interface: DocumentRepositoryService

Returns the DocumentDefinitionModel including all action model info.

Specified by:

getDocumentDefinitionModel in interface DocumentRepositoryService

setDocumentDefinitionCategory

public void setDocumentDefinitionCategory(String documentDefinitionId,
                                          String category)

Specified by:

setDocumentDefinitionCategory in interface DocumentRepositoryService

convertDocumentDefinitionModelToJson

public String convertDocumentDefinitionModelToJson(String documentDefinitionId)

Description copied from interface: DocumentRepositoryService

Returns the DocumentDefinitionModel as a JSON string.

Specified by:

convertDocumentDefinitionModelToJson in interface DocumentRepositoryService

deleteDeployment

public void deleteDeployment(String deploymentId)

Description copied from interface: DocumentRepositoryService

Deletes the given deployment.

Specified by:

deleteDeployment in interface DocumentRepositoryService

Parameters:

deploymentId - id of the deployment, cannot be null.

createDeploymentQuery

public DocumentDeploymentQuery createDeploymentQuery()

Description copied from interface: DocumentRepositoryService

Query deployments

Specified by:

createDeploymentQuery in interface DocumentRepositoryService

createDocumentDefinitionQuery

public DocumentDefinitionQuery createDocumentDefinitionQuery()

Description copied from interface: DocumentRepositoryService

Query case definitions

Specified by:

createDocumentDefinitionQuery in interface DocumentRepositoryService