Package org.bonitasoft.engine.dependency

Interface DependencyService

All Known Implementing Classes:

AbstractDependencyService, PlatformDependencyService, TenantDependencyService

public interface DependencyService

Since:

6.0

Author:

Matthieu Chaffotte, Celine Souchet

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEPENDENCY
static java.lang.String	DEPENDENCYMAPPING

Method Summary

Modifier and Type	Method	Description
AbstractSDependency	createMappedDependency(java.lang.String name, byte[] jarContent, java.lang.String fileName, long artifactId, ScopeType scopeType)
void	deleteDependencies(long id, ScopeType type)
void	deleteDependency(java.lang.String name)	Delete the dependency specified by name
void	deleteDependency(AbstractSDependency dependency)	Delete the specific dependency
java.util.List<AbstractSDependency>	getDependencies(java.util.Collection<java.lang.Long> ids)	Get dependencies for the specified ids
java.util.stream.Stream<BonitaResource>	getDependenciesResources(ScopeType type, long id)
AbstractSDependency	getDependency(long id)	Get dependency by its id
DependencyContent	getDependencyContentOnly(long id)	Get only the content and file name of a dependency.
java.util.List<java.lang.Long>	getDependencyIds(long artifactId, ScopeType artifactType, int startIndex, int maxResult)	Get all dependency ids for specific artifact
java.util.List<SDependencyMapping>	getDependencyMappings(QueryOptions queryOptions)	Get all dependencyMappings for specific the queryOptions
AbstractSDependency	getDependencyOfArtifact(long artifactId, ScopeType artifactType, java.lang.String fileName)
java.util.Optional<java.lang.Long>	getIdOfDependencyOfArtifact(java.lang.Long artifactId, ScopeType artifactType, java.lang.String fileName)
AbstractSDependency	updateDependencyOfArtifact(java.lang.String name, byte[] jarContent, java.lang.String fileName, long artifactId, ScopeType scopeType)

Field Detail

DEPENDENCY

static final java.lang.String DEPENDENCY

See Also:

Constant Field Values

DEPENDENCYMAPPING

static final java.lang.String DEPENDENCYMAPPING

See Also:

Constant Field Values

Method Detail

deleteDependency

void deleteDependency(AbstractSDependency dependency)
               throws SDependencyException

Delete the specific dependency

Parameters:

dependency - The dependency will be deleted

Throws:

SDependencyNotFoundException - Error thrown if the dependency not found.

SDependencyDeletionException - Error thrown if has exception during the dependency deletion.

SDependencyException

deleteDependency

void deleteDependency(java.lang.String name)
               throws SDependencyException

Delete the dependency specified by name

Parameters:

name -

Throws:

SDependencyNotFoundException - Error thrown if no dependency have a name corresponding to the parameter.

SDependencyDeletionException - Error thrown if has exception during the dependency deletion.

SDependencyException

getDependency

AbstractSDependency getDependency(long id)
                           throws SDependencyNotFoundException

Get dependency by its id

Parameters:

id - Identifier of dependency

Returns:

Throws:

SDependencyNotFoundException - Error thrown if no dependency have an id corresponding to the parameter.

getDependencyContentOnly

DependencyContent getDependencyContentOnly(long id)
                                    throws SDependencyNotFoundException,
                                           SBonitaReadException

Get only the content and file name of a dependency. This object will not be connected to the hibernate session and therefore will avoid issues related to dirty checking mechanism, see https://bonitasoft.atlassian.net/browse/BS-19262

Parameters:

id - of the dependency

Returns:

an object containing the file content and name

Throws:

SDependencyNotFoundException

SBonitaReadException

getDependencies

java.util.List<AbstractSDependency> getDependencies(java.util.Collection<java.lang.Long> ids)
                                             throws SDependencyException

Get dependencies for the specified ids

Parameters:

ids - Identifiers of dependencies

Returns:

a list of SDependency object

Throws:

SDependencyException

getDependencyMappings

java.util.List<SDependencyMapping> getDependencyMappings(QueryOptions queryOptions)
                                                  throws SDependencyException

Get all dependencyMappings for specific the queryOptions

Parameters:

queryOptions - QueryOptions object, it contains some query conditions.

Returns:

a list of SDependencyMapping objects

Throws:

SDependencyException

getDependenciesResources

java.util.stream.Stream<BonitaResource> getDependenciesResources(ScopeType type,
                                                                 long id)
                                                          throws SDependencyException

Throws:

SDependencyException

getDependencyIds

java.util.List<java.lang.Long> getDependencyIds(long artifactId,
                                                ScopeType artifactType,
                                                int startIndex,
                                                int maxResult)
                                         throws SDependencyException

Get all dependency ids for specific artifact

Parameters:

artifactId - Identifier of artifact

artifactType - Type of artifact

startIndex -

maxResult -

Returns:

a list of Long objects

Throws:

SDependencyException

deleteDependencies

void deleteDependencies(long id,
                        ScopeType type)
                 throws SDependencyException

Parameters:

id -

type -

Throws:

SDependencyException

createMappedDependency

AbstractSDependency createMappedDependency(java.lang.String name,
                                           byte[] jarContent,
                                           java.lang.String fileName,
                                           long artifactId,
                                           ScopeType scopeType)
                                    throws SDependencyException

Throws:

SDependencyException

updateDependencyOfArtifact

AbstractSDependency updateDependencyOfArtifact(java.lang.String name,
                                               byte[] jarContent,
                                               java.lang.String fileName,
                                               long artifactId,
                                               ScopeType scopeType)
                                        throws SDependencyException

Throws:

SDependencyException

getDependencyOfArtifact

AbstractSDependency getDependencyOfArtifact(long artifactId,
                                            ScopeType artifactType,
                                            java.lang.String fileName)
                                     throws SBonitaReadException

Throws:

SBonitaReadException

getIdOfDependencyOfArtifact

java.util.Optional<java.lang.Long> getIdOfDependencyOfArtifact(java.lang.Long artifactId,
                                                               ScopeType artifactType,
                                                               java.lang.String fileName)
                                                        throws SBonitaReadException

Throws:

SBonitaReadException