Package org.refcodes.logger.alt.simpledb

Class SimpleDbQueryLogger<T>

java.lang.Object
org.refcodes.logger.alt.simpledb.SimpleDbLogger<T>
org.refcodes.logger.alt.simpledb.SimpleDbQueryLogger<T>
Type Parameters:
T - The type of the Record instances managed by the Logger.
All Implemented Interfaces:
Flushable, org.refcodes.component.Component, org.refcodes.component.Decomposeable, org.refcodes.component.Destroyable, org.refcodes.component.Flushable, org.refcodes.component.Initializable, org.refcodes.logger.LogDecorator, org.refcodes.logger.Logger<T>, org.refcodes.logger.QueryLogger<T>
Direct Known Subclasses:
SimpleDbTrimLogger
public class SimpleDbQueryLogger<T>
extends SimpleDbLogger<T>
implements org.refcodes.logger.QueryLogger<T>, org.refcodes.component.Component, org.refcodes.component.Initializable, org.refcodes.component.Decomposeable, org.refcodes.component.Flushable
The SimpleDbQueryLogger extends the SimpleDbLogger implementation with the QueryLogger functionality.

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    protected class  SimpleDbQueryLogger.SimpleDbRecords
    This iterator encapsulates an Amazon select request for the business logic to simply iterate through the results.

    Nested classes/interfaces inherited from interface org.refcodes.component.Decomposeable

    org.refcodes.component.Decomposeable.DecomposeAutomaton

    Nested classes/interfaces inherited from interface org.refcodes.component.Destroyable

    org.refcodes.component.Destroyable.DestroyAutomaton

    Nested classes/interfaces inherited from interface org.refcodes.component.Flushable

    org.refcodes.component.Flushable.FlushBuilder<B extends org.refcodes.component.Flushable.FlushBuilder<B>>

    Nested classes/interfaces inherited from interface org.refcodes.component.Initializable

    org.refcodes.component.Initializable.InitializeAutomaton, org.refcodes.component.Initializable.InitializeBuilder<B extends org.refcodes.component.Initializable.InitializeBuilder<B>>, org.refcodes.component.Initializable.UncheckedInitializable

  • Field Summary

    Fields inherited from class org.refcodes.logger.alt.simpledb.SimpleDbLogger

    LOGGER

  • Constructor Summary

    Constructors
    Constructor Description
    SimpleDbQueryLogger​(String aDomainName, String aAccessKey, String aSecretKey, String aEndPoint, org.refcodes.tabular.ColumnFactory<T> aColumnFactory)
    Constructs the SimpleDbQueryLogger for a given SimpleDB domain.
    SimpleDbQueryLogger​(String aDomainName, String aAccessKey, String aSecretKey, org.refcodes.tabular.ColumnFactory<T> aColumnFactory)
    Constructs the SimpleDbQueryLogger for a given SimpleDB domain.

  • Method Summary

    Modifier and Type Method Description
    protected static void clearDomain​(com.amazonaws.services.simpledb.AmazonSimpleDB aAmazonSimpleDbClient, String aDomainName)
    Clears all content from the given Amazon SimpleDB domain.
    void destroy()
    org.refcodes.tabular.Records<T> findLogs()
    org.refcodes.tabular.Records<T> findLogs​(int aLimit)
    org.refcodes.tabular.Records<T> findLogs​(org.refcodes.criteria.Criteria aCriteria)
    org.refcodes.tabular.Records<T> findLogs​(org.refcodes.criteria.Criteria aCriteria, int aLimit)
    org.refcodes.tabular.Records<T> findLogs​(org.refcodes.criteria.Criteria aCriteria, org.refcodes.tabular.Header<T> aHeader)
    org.refcodes.tabular.Records<T> findLogs​(org.refcodes.criteria.Criteria aCriteria, org.refcodes.tabular.Header<T> aHeader, int aLimit)
    org.refcodes.tabular.Records<T> findLogs​(org.refcodes.tabular.Header<T> aHeader, int aLimit)
    protected com.amazonaws.services.simpledb.AmazonSimpleDB getAmazonSimpleDbClient()
    Retrieves the amazon SimpleDB client to be used.
    protected static com.amazonaws.services.simpledb.AmazonSimpleDB getAmazonSimpleDbClient​(File aConfigFile)
    Retrieves an AmazonSimpleDBClient from a configuration file containing the access- and the secret key.
    protected String getAmazonSimpleDbDomainName()
    Retrieves the domain name to be used.
    protected static List<String> getDomainNames​(com.amazonaws.services.simpledb.AmazonSimpleDBClient aAmazonSimpleDbClient)
    Retrieves a list of domain names retrievable from the given AmazonSimpleDBClient.
    protected static boolean hasDomain​(com.amazonaws.services.simpledb.AmazonSimpleDBClient aAmazonSimpleDbClient, String aDomainName)
    Tests whether the given domain exists in Amazon SimpleDB.
    protected static boolean isRequestTimeoutException​(Exception aException)
    Checks if is request timeout exception.
    protected static boolean isServiceUnavailableException​(Exception aException)
    Checks if is service unavailable exception.
    protected void setAmazonSimpleDbDomainName​(String aAmazonSimpleDbDomainName)
    Sets the domain name to be used.
    protected static String toMessage​(Throwable aThrowable)
    Creates an Amazon AWS specific exception message from the given throwable containing additional information such as the AWS error code, the AWS error type, the request ID, the service name and the status code.
    protected String toSqlQuery​(org.refcodes.criteria.Criteria aCriteria, int aLimit)
    Creates an SQL SELECT query from the given Criteria and the provided limit.

    Methods inherited from class org.refcodes.logger.alt.simpledb.SimpleDbLogger

    addHeaderColumn, decompose, flush, flushBuffer, getHeader, initialize, log

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.refcodes.component.Decomposeable

    decompose

    Methods inherited from interface org.refcodes.component.Flushable

    flush, flushUnchecked, isFlushable

    Methods inherited from interface org.refcodes.component.Initializable

    initialize, initializeUnchecked

    Methods inherited from interface org.refcodes.logger.LogDecorator

    printHead, printSeparator, printTail

    Methods inherited from interface org.refcodes.logger.Logger

    log

  • Constructor Details

    • SimpleDbQueryLogger

      public SimpleDbQueryLogger​(String aDomainName, String aAccessKey, String aSecretKey, org.refcodes.tabular.ColumnFactory<T> aColumnFactory)
      Constructs the SimpleDbQueryLogger for a given SimpleDB domain.
      Parameters:
      aDomainName - The name for the Amazon SimpleDB domain
      aAccessKey - The Amazon access key for Amazon SimpleDB
      aSecretKey - The Amazon secret key for Amazon SimpleDB
      aColumnFactory - The ColumnFactory to create default Column instances for Record instances to be processed

    • SimpleDbQueryLogger

      public SimpleDbQueryLogger​(String aDomainName, String aAccessKey, String aSecretKey, String aEndPoint, org.refcodes.tabular.ColumnFactory<T> aColumnFactory)
      Constructs the SimpleDbQueryLogger for a given SimpleDB domain.
      Parameters:
      aDomainName - The name for the Amazon SimpleDB domain
      aAccessKey - The Amazon access key for Amazon SimpleDB
      aSecretKey - The Amazon secret key for Amazon SimpleDB
      aEndPoint - The end-point (Amazon region) to use (see AbstractSimpleDbClient's constructor documentation for possible values).
      aColumnFactory - The ColumnFactory to create default Column instances for Record instances to be processed

  • Method Details

    • findLogs

      public org.refcodes.tabular.Records<T> findLogs()
      Specified by:
      findLogs in interface org.refcodes.logger.QueryLogger<T>

    • findLogs

      public org.refcodes.tabular.Records<T> findLogs​(int aLimit)
      Specified by:
      findLogs in interface org.refcodes.logger.QueryLogger<T>

    • findLogs

      public org.refcodes.tabular.Records<T> findLogs​(org.refcodes.criteria.Criteria aCriteria)
      Specified by:
      findLogs in interface org.refcodes.logger.QueryLogger<T>

    • findLogs

      public org.refcodes.tabular.Records<T> findLogs​(org.refcodes.criteria.Criteria aCriteria, int aLimit)
      Specified by:
      findLogs in interface org.refcodes.logger.QueryLogger<T>

    • findLogs

      public org.refcodes.tabular.Records<T> findLogs​(org.refcodes.criteria.Criteria aCriteria, org.refcodes.tabular.Header<T> aHeader)
      Specified by:
      findLogs in interface org.refcodes.logger.QueryLogger<T>

    • findLogs

      public org.refcodes.tabular.Records<T> findLogs​(org.refcodes.tabular.Header<T> aHeader, int aLimit)
      Specified by:
      findLogs in interface org.refcodes.logger.QueryLogger<T>

    • findLogs

      public org.refcodes.tabular.Records<T> findLogs​(org.refcodes.criteria.Criteria aCriteria, org.refcodes.tabular.Header<T> aHeader, int aLimit)
      Specified by:
      findLogs in interface org.refcodes.logger.QueryLogger<T>

    • destroy

      public void destroy()
      Specified by:
      destroy in interface org.refcodes.component.Destroyable
      Overrides:
      destroy in class SimpleDbLogger<T>

    • toSqlQuery

      protected String toSqlQuery​(org.refcodes.criteria.Criteria aCriteria, int aLimit)
      Creates an SQL SELECT query from the given Criteria and the provided limit.
      Parameters:
      aCriteria - The Criteria from which to create the SQL query.
      aLimit - The limit to be applied to the result set of the query.
      Returns:
      A (No)SQL query for SimpleDB.

    • getAmazonSimpleDbDomainName

      protected String getAmazonSimpleDbDomainName()
      Retrieves the domain name to be used.
      Returns:
      The domain name.

    • setAmazonSimpleDbDomainName

      protected void setAmazonSimpleDbDomainName​(String aAmazonSimpleDbDomainName)
      Sets the domain name to be used.
      Parameters:
      aAmazonSimpleDbDomainName - the new amazon simple db domain name

    • getAmazonSimpleDbClient

      protected com.amazonaws.services.simpledb.AmazonSimpleDB getAmazonSimpleDbClient()
      Retrieves the amazon SimpleDB client to be used.
      Returns:
      The SimpleDB client to be used.

    • isRequestTimeoutException

      protected static boolean isRequestTimeoutException​(Exception aException)
      Checks if is request timeout exception.
      Parameters:
      aException - the exception
      Returns:
      true, if is request timeout exception

    • isServiceUnavailableException

      protected static boolean isServiceUnavailableException​(Exception aException)
      Checks if is service unavailable exception.
      Parameters:
      aException - the exception
      Returns:
      true, if is service unavailable exception

    • toMessage

      protected static String toMessage​(Throwable aThrowable)
      Creates an Amazon AWS specific exception message from the given throwable containing additional information such as the AWS error code, the AWS error type, the request ID, the service name and the status code.
      Parameters:
      aThrowable - The throwable from which to generate the Amazon AWS specific exception message.
      Returns:
      The according exception message.

    • clearDomain

      protected static void clearDomain​(com.amazonaws.services.simpledb.AmazonSimpleDB aAmazonSimpleDbClient, String aDomainName)
      Clears all content from the given Amazon SimpleDB domain.
      Parameters:
      aAmazonSimpleDbClient - The AmazonSimpleDBClient.
      aDomainName - The domain name of the domain to be cleared.

    • getAmazonSimpleDbClient

      protected static com.amazonaws.services.simpledb.AmazonSimpleDB getAmazonSimpleDbClient​(File aConfigFile) throws IOException
      Retrieves an AmazonSimpleDBClient from a configuration file containing the access- and the secret key.
      Parameters:
      aConfigFile - The configuration file used to configure the AmazonSimpleDBClient.
      Returns:
      An AmazonSimpleDBClient.
      Throws:
      IOException - In case there were problems reading the configuration file.

    • getDomainNames

      protected static List<String> getDomainNames​(com.amazonaws.services.simpledb.AmazonSimpleDBClient aAmazonSimpleDbClient)
      Retrieves a list of domain names retrievable from the given AmazonSimpleDBClient.
      Parameters:
      aAmazonSimpleDbClient - The AmazonSimpleDBClient.
      Returns:
      A list containing String instances representing the retrievable domain names.

    • hasDomain

      protected static boolean hasDomain​(com.amazonaws.services.simpledb.AmazonSimpleDBClient aAmazonSimpleDbClient, String aDomainName)
      Tests whether the given domain exists in Amazon SimpleDB.
      Parameters:
      aAmazonSimpleDbClient - The AmazonSimpleDBClient.
      aDomainName - The domain name to be tested.
      Returns:
      True in case the domain with the given name exists, else false.