Interface ConnectorInstanceService
- All Known Implementing Classes:
ConnectorInstanceServiceImpl
public interface ConnectorInstanceService
- Author:
- Elias Ricken de Medeiros, Baptiste Mesta, Matthieu Chaffotte
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
archiveConnectorInstance
(SConnectorInstance connectorInstance, long archiveDate) void
createConnectorInstance
(SConnectorInstance connectorInstance) Create connector instance by give connector instance, the connector instance will be stored in databasevoid
deleteArchivedConnectorInstances
(List<Long> containerIds, String containerType) Delete archived connector instances using a list of container ids and a container typevoid
deleteConnectorInstance
(SConnectorInstance connectorInstance) Delete the given connector instance from the databasevoid
deleteConnectors
(long containerId, String containerType) getConnectorInstance
(long connectorInstanceId) getConnectorInstances
(long containerId, String containerType, int from, int numberOfResult, String fieldName, OrderByType orderByType) getConnectorInstances
(long containerId, String containerType, org.bonitasoft.engine.bpm.connector.ConnectorEvent activationEvent, int from, int numberOfResult, String state) Get a list of connectorInstances for specified containergetConnectorInstancesWithFailureInfo
(long containerId, String containerType, String state, int from, int maxResults) Retrieves the connector instance with failure information for the given containergetConnectorInstanceWithFailureInfo
(long connectorInstanceId) Retrieves the connector instance with failure information for the given connector instance idgetNextExecutableConnectorInstance
(long containerId, String containerType, org.bonitasoft.engine.bpm.connector.ConnectorEvent activationEvent) long
getNumberArchivedConnectorInstance
(QueryOptions searchOptions, ReadPersistenceService persistenceService) long
getNumberOfConnectorInstances
(long containerId, String containerType) long
getNumberOfConnectorInstances
(QueryOptions searchOptions) searchArchivedConnectorInstance
(QueryOptions searchOptions, ReadPersistenceService persistenceService) searchConnectorInstances
(QueryOptions searchOptions) void
setConnectorInstanceFailureException
(SConnectorInstanceWithFailureInfo connectorInstanceWithFailure, Throwable throwable) Defines the exception associated to the connector failurevoid
setState
(SAbstractConnectorInstance sConnectorInstance, String state)
-
Field Details
-
CONNECTOR_INSTANCE
- See Also:
-
CONNECTOR_INSTANCE_STATE
- See Also:
-
CONNECTOR_INSTANCE_STATE_UPDATED
- See Also:
-
-
Method Details
-
getConnectorInstances
List<SConnectorInstance> getConnectorInstances(long containerId, String containerType, org.bonitasoft.engine.bpm.connector.ConnectorEvent activationEvent, int from, int numberOfResult, String state) throws SConnectorInstanceReadException Get a list of connectorInstances for specified container- Parameters:
containerId
- Identifier of containercontainerType
- Type of containeractivationEvent
- The event to indicate when the connector will be activated- Returns:
- list of connectorInstance objects
- Throws:
SConnectorInstanceReadException
- Error thrown if has exceptions during the connector retrieve
-
createConnectorInstance
void createConnectorInstance(SConnectorInstance connectorInstance) throws SConnectorInstanceCreationException Create connector instance by give connector instance, the connector instance will be stored in database- Parameters:
connectorInstance
- Connector instance- Throws:
SConnectorInstanceCreationException
- Error thrown if has exceptions during the connector instance creation
-
deleteConnectorInstance
void deleteConnectorInstance(SConnectorInstance connectorInstance) throws SConnectorInstanceDeletionException Delete the given connector instance from the database- Parameters:
connectorInstance
- the connector instance- Throws:
SConnectorInstanceDeletionException
- if has exceptions during the connector instance deletion
-
setState
void setState(SAbstractConnectorInstance sConnectorInstance, String state) throws SConnectorInstanceModificationException - Parameters:
sConnectorInstance
-state
-- Throws:
SConnectorInstanceModificationException
-
setConnectorInstanceFailureException
void setConnectorInstanceFailureException(SConnectorInstanceWithFailureInfo connectorInstanceWithFailure, Throwable throwable) throws SConnectorInstanceModificationException Defines the exception associated to the connector failure- Parameters:
connectorInstanceWithFailure
- failed connector instancethrowable
- exception responsible for connector failure- Throws:
SConnectorInstanceModificationException
- Since:
- 6.1
-
getConnectorInstance
SConnectorInstance getConnectorInstance(long connectorInstanceId) throws SConnectorInstanceReadException, SConnectorInstanceNotFoundException - Parameters:
connectorInstanceId
-- Returns:
- Throws:
SConnectorInstanceReadException
SConnectorInstanceNotFoundException
-
getConnectorInstanceWithFailureInfo
SConnectorInstanceWithFailureInfo getConnectorInstanceWithFailureInfo(long connectorInstanceId) throws SConnectorInstanceReadException, SConnectorInstanceNotFoundException Retrieves the connector instance with failure information for the given connector instance id- Parameters:
connectorInstanceId
-- Returns:
- the connector instance with failure information for the given connector instance id
- Throws:
SConnectorInstanceReadException
SConnectorInstanceNotFoundException
- Since:
- 6.1
-
getConnectorInstancesWithFailureInfo
List<SConnectorInstanceWithFailureInfo> getConnectorInstancesWithFailureInfo(long containerId, String containerType, String state, int from, int maxResults) throws SConnectorInstanceReadException Retrieves the connector instance with failure information for the given container- Parameters:
containerId
-containerType
-state
-from
-maxResults
-- Returns:
- the connector instance with failure information for the given connector instance id
- Throws:
SConnectorInstanceReadException
SConnectorInstanceNotFoundException
- Since:
- 6.1
-
getNumberOfConnectorInstances
long getNumberOfConnectorInstances(long containerId, String containerType) throws SConnectorInstanceReadException - Parameters:
containerId
-containerType
-- Returns:
- Throws:
SConnectorInstanceReadException
-
getConnectorInstances
List<SConnectorInstance> getConnectorInstances(long containerId, String containerType, int from, int numberOfResult, String fieldName, OrderByType orderByType) throws SConnectorInstanceReadException - Parameters:
containerId
-containerType
-from
-numberOfResult
-- Throws:
SConnectorInstanceReadException
-
getNextExecutableConnectorInstance
SConnectorInstance getNextExecutableConnectorInstance(long containerId, String containerType, org.bonitasoft.engine.bpm.connector.ConnectorEvent activationEvent) throws SConnectorInstanceReadException - Parameters:
containerId
-containerType
-- Returns:
- Throws:
SConnectorInstanceReadException
-
getNumberOfConnectorInstances
- Parameters:
searchOptions
-- Returns:
- Throws:
SBonitaReadException
-
searchConnectorInstances
List<SConnectorInstance> searchConnectorInstances(QueryOptions searchOptions) throws SBonitaReadException - Parameters:
searchOptions
-- Returns:
- Throws:
SBonitaReadException
-
archiveConnectorInstance
void archiveConnectorInstance(SConnectorInstance connectorInstance, long archiveDate) throws SConnectorInstanceCreationException - Parameters:
connectorInstance
-archiveDate
-- Throws:
SConnectorInstanceCreationException
-
getNumberArchivedConnectorInstance
long getNumberArchivedConnectorInstance(QueryOptions searchOptions, ReadPersistenceService persistenceService) throws SBonitaReadException - Parameters:
searchOptions
-persistenceService
-- Returns:
- Throws:
SBonitaReadException
-
searchArchivedConnectorInstance
List<SAConnectorInstance> searchArchivedConnectorInstance(QueryOptions searchOptions, ReadPersistenceService persistenceService) throws SBonitaReadException - Parameters:
searchOptions
-persistenceService
-- Returns:
- Throws:
SBonitaReadException
-
deleteConnectors
void deleteConnectors(long containerId, String containerType) throws SConnectorInstanceReadException, SConnectorInstanceDeletionException - Parameters:
containerId
-containerType
-- Throws:
SConnectorInstanceReadException
SConnectorInstanceDeletionException
- Since:
- 6.1
-
deleteArchivedConnectorInstances
void deleteArchivedConnectorInstances(List<Long> containerIds, String containerType) throws SBonitaException Delete archived connector instances using a list of container ids and a container type- Parameters:
containerIds
- ids on the container (source process instance id or source task id)containerType
-- Throws:
SBonitaException
-