SMILA (incubation) API documentation

org.eclipse.smila.connectivity.queue.worker
Interface RecordRecycler

All Known Implementing Classes:
RecordRecyclerImpl

public interface RecordRecycler

The Interface RecordRecycler.


Method Summary
 java.lang.String[] getConfigurations()
          Gets the configurations.
 long getRecordsRecycled(java.lang.String dataSourceID)
          Gets the records recycled.
 RecordRecyclerStatus getStatus(java.lang.String dataSourceID)
          Gets the status.
 void recycle(java.lang.String configurationId, java.lang.String dataSourceId)
          Recycle.
 void recycleAsync(java.lang.String configurationId, java.lang.String dataSourceId)
          Recycle async.
 void stopRecycle(java.lang.String dataSourceId)
          Stop.
 

Method Detail

getConfigurations

java.lang.String[] getConfigurations()
                                     throws RecordRecyclerException
Gets the configurations.

Returns:
the configurations
Throws:
RecordRecyclerException - the record recycler exception

recycle

void recycle(java.lang.String configurationId,
             java.lang.String dataSourceId)
             throws RecordRecyclerException
Recycle.

Parameters:
configurationId - the configuration id
dataSourceId - the data source id
Throws:
RecordRecyclerException - the record recycler exception

recycleAsync

void recycleAsync(java.lang.String configurationId,
                  java.lang.String dataSourceId)
                  throws RecordRecyclerException
Recycle async.

Parameters:
configurationId - the configuration id
dataSourceId - the data source id
Throws:
RecordRecyclerException - the record recycler exception

stopRecycle

void stopRecycle(java.lang.String dataSourceId)
                 throws RecordRecyclerException
Stop.

Parameters:
dataSourceId - the data source id
Throws:
RecordRecyclerException - the record recycler exception

getStatus

RecordRecyclerStatus getStatus(java.lang.String dataSourceID)
Gets the status.

Parameters:
dataSourceID - the data source id
Returns:
the status

getRecordsRecycled

long getRecordsRecycled(java.lang.String dataSourceID)
Gets the records recycled.

Parameters:
dataSourceID - the data source id
Returns:
the records recycled

SMILA (incubation) API documentation