com.kdgregory.logging.aws.facade

Interface KinesisFacade

public interface KinesisFacade

Exposes the CloudWatch Logs APIs used by KinesisLogWriter.

Instances are created by FacadeFactory, and are tied to a single writer's configuration.

All operations may throw KinesisFacadeException. Callers are expected to catch this exception (it's checked), and take action based on the reason code that it exposes.

Method Summary

Modifier and Type	Method and Description
void	createStream() Creates the stream.
List<LogMessage>	putRecords(List<LogMessage> batch) Attempts to send records to the stream.
KinesisConstants.StreamStatus	retrieveStreamStatus() Returns the current status of the stream, null if the status cannot be determined due to a retryable condition.
void	setRetentionPeriod() Sets the stream's retention period, iff configuration specifies a non-null period.
void	shutdown() Shuts down the underlying client.

Method Detail

retrieveStreamStatus

KinesisConstants.StreamStatus retrieveStreamStatus()

Returns the current status of the stream, null if the status cannot be determined due to a retryable condition.

createStream

void createStream()

Creates the stream. Note that the stream will not be active for up to 60 seconds after this call returns. Caller must be prepared to retry if the call is throttled.

setRetentionPeriod

void setRetentionPeriod()

Sets the stream's retention period, iff configuration specifies a non-null period. Caller must be prepared to retry if the call is throttled.

putRecords

List<LogMessage> putRecords(List<LogMessage> batch)

Attempts to send records to the stream. The entire call may fail, or individual records may be rejected. The returned list contains any records that were not successfully written.

shutdown

void shutdown()

Shuts down the underlying client.