org.kaaproject.kaa.client.logging

Class DefaultLogUploadStrategy

java.lang.Object

org.kaaproject.kaa.client.logging.DefaultLogUploadStrategy

All Implemented Interfaces:

LogUploadStrategy

Direct Known Subclasses:

PeriodicLogUploadStrategy, RecordCountLogUploadStrategy, RecordCountWithTimeLimitLogUploadStrategy, StorageSizeLogUploadStrategy, StorageSizeWithTimeLimitLogUploadStrategy

public class DefaultLogUploadStrategy
extends Object
implements LogUploadStrategy

Reference implementation for LogUploadStrategy.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	batchCount
protected int	batchSize
protected int	countThreshold
protected boolean	isUploadLocked
protected int	maxParallelUploads
protected int	retryPeriod
protected int	timeout
protected int	uploadCheckPeriod
protected int	volumeThreshold

Constructor Summary

Constructors

Constructor and Description
DefaultLogUploadStrategy()

Method Summary

Modifier and Type	Method and Description
protected LogUploadStrategyDecision	checkUploadNeeded(LogStorageStatus status)
int	getCountThreshold()
int	getMaxParallelUploads() Returns max parallel upload count
int	getTimeout() Maximum time to wait log delivery response.
int	getUploadCheckPeriod() If there are records in storage we need to periodically check isUploadNeeded method.
int	getVolumeThreshold()
boolean	isUploadLocked()
LogUploadStrategyDecision	isUploadNeeded(LogStorageStatus status) Retrieves log upload decision based on current storage status and defined upload configuration.
void	lockUpload()
void	onFailure(LogFailoverCommand controller, org.kaaproject.kaa.common.endpoint.gen.LogDeliveryErrorCode code) Handles failure of log delivery
void	onTimeout(LogFailoverCommand controller) Handles timeout of log delivery
void	setBatch(int batch)
void	setBatchCount(int batchCount)
void	setCountThreshold(int countThreshold)
void	setMaxParallelUploads(int maxParallelUploads)
void	setRetryPeriod(int retryPeriod)
void	setTimeout(int timeout)
void	setUploadCheckPeriod(int uploadCheckPeriod)
void	setVolumeThreshold(int volumeThreshold)
void	unlockUpload()

Methods inherited from class java.lang.Object

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

Field Detail

timeout

protected int timeout

uploadCheckPeriod

protected int uploadCheckPeriod

retryPeriod

protected int retryPeriod

volumeThreshold

protected int volumeThreshold

countThreshold

protected int countThreshold

batchSize

protected int batchSize

batchCount

protected int batchCount

maxParallelUploads

protected int maxParallelUploads

isUploadLocked

protected volatile boolean isUploadLocked

Constructor Detail

DefaultLogUploadStrategy

public DefaultLogUploadStrategy()

Method Detail

isUploadNeeded

public LogUploadStrategyDecision isUploadNeeded(LogStorageStatus status)

Description copied from interface: LogUploadStrategy

Retrieves log upload decision based on current storage status and defined upload configuration.

Specified by:

isUploadNeeded in interface LogUploadStrategy

Parameters:

status - Log storage status

Returns:

Upload decision (LogUploadStrategyDecision)

checkUploadNeeded

protected LogUploadStrategyDecision checkUploadNeeded(LogStorageStatus status)

getTimeout

public int getTimeout()

Description copied from interface: LogUploadStrategy

Maximum time to wait log delivery response.

Specified by:

getTimeout in interface LogUploadStrategy

Returns:

Time in seconds.

onTimeout

public void onTimeout(LogFailoverCommand controller)

Description copied from interface: LogUploadStrategy

Handles timeout of log delivery

Specified by:

onTimeout in interface LogUploadStrategy

Parameters:

controller - the controller

onFailure

public void onFailure(LogFailoverCommand controller,
                      org.kaaproject.kaa.common.endpoint.gen.LogDeliveryErrorCode code)

Description copied from interface: LogUploadStrategy

Handles failure of log delivery

Specified by:

onFailure in interface LogUploadStrategy

Parameters:

controller - the controller

code - the code

setTimeout

public void setTimeout(int timeout)

setRetryPeriod

public void setRetryPeriod(int retryPeriod)

getVolumeThreshold

public int getVolumeThreshold()

setVolumeThreshold

public void setVolumeThreshold(int volumeThreshold)

getCountThreshold

public int getCountThreshold()

setCountThreshold

public void setCountThreshold(int countThreshold)

setBatch

public void setBatch(int batch)

setBatchCount

public void setBatchCount(int batchCount)

getUploadCheckPeriod

public int getUploadCheckPeriod()

Description copied from interface: LogUploadStrategy

If there are records in storage we need to periodically check isUploadNeeded method. This is useful if client want to upload logs on certain timing conditions instead of log storage checks

Specified by:

getUploadCheckPeriod in interface LogUploadStrategy

Returns:

Time in seconds

setUploadCheckPeriod

public void setUploadCheckPeriod(int uploadCheckPeriod)

lockUpload

public void lockUpload()

unlockUpload

public void unlockUpload()

isUploadLocked

public boolean isUploadLocked()

getMaxParallelUploads

public int getMaxParallelUploads()

Description copied from interface: LogUploadStrategy

Returns max parallel upload count

Specified by:

getMaxParallelUploads in interface LogUploadStrategy

Returns:

Max parallel upload count

setMaxParallelUploads

public void setMaxParallelUploads(int maxParallelUploads)