Package org.refcodes.logger

Class PartedLoggerImpl<T,P extends T>

  • Type Parameters:
    T - the generic type
    P - The type of the Column's value used for partitioning the Logger.
    All Implemented Interfaces:
    java.io.Flushable, org.refcodes.component.Closable, org.refcodes.component.CompositeComponent, org.refcodes.component.Decomposeable, org.refcodes.component.Destroyable, org.refcodes.component.Flushable, org.refcodes.component.Initializable, org.refcodes.component.LifeCycleComponent, org.refcodes.component.LinkComponent, org.refcodes.component.Openable, org.refcodes.component.Pausable, org.refcodes.component.Resetable, org.refcodes.component.Resumable, org.refcodes.component.Startable, org.refcodes.component.Stoppable, Logger<T>, org.refcodes.mixin.Disposable
    public class PartedLoggerImpl<T,P extends T>
extends java.lang.Object
implements org.refcodes.component.CompositeComponent
    The PartedLoggerImpl is a ready to use implementation of a parted Logger extending the AbstractPartedLogger.
    See Also:
    AbstractPartedLogger

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.refcodes.component.Closable

        org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>

      • Nested classes/interfaces inherited from interface org.refcodes.component.CompositeComponent

        org.refcodes.component.CompositeComponent.ExtendedCompositeComponent<CTX extends java.lang.Object,CON extends java.lang.Object>

      • 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.mixin.Disposable

        org.refcodes.mixin.Disposable.Disposedable

      • 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

      • Nested classes/interfaces inherited from interface org.refcodes.component.LifeCycleComponent

        org.refcodes.component.LifeCycleComponent.LifeCycleAutomaton, org.refcodes.component.LifeCycleComponent.UncheckedLifeCycleComponent

      • Nested classes/interfaces inherited from interface org.refcodes.component.LinkComponent

        org.refcodes.component.LinkComponent.LinkAutomaton, org.refcodes.component.LinkComponent.LinkComponentBuilder<B extends org.refcodes.component.LinkComponent.LinkComponentBuilder<B>>

      • Nested classes/interfaces inherited from interface org.refcodes.component.Openable

        org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<B extends org.refcodes.component.Openable.OpenBuilder<B>>

      • Nested classes/interfaces inherited from interface org.refcodes.component.Pausable

        org.refcodes.component.Pausable.PauseAutomaton, org.refcodes.component.Pausable.PauseBuilder<B extends org.refcodes.component.Pausable.PauseBuilder<B>>, org.refcodes.component.Pausable.UncheckedPausable

      • Nested classes/interfaces inherited from interface org.refcodes.component.Resumable

        org.refcodes.component.Resumable.ResumeAutomaton, org.refcodes.component.Resumable.ResumeBuilder<B extends org.refcodes.component.Resumable.ResumeBuilder<B>>, org.refcodes.component.Resumable.UncheckedResumable

      • Nested classes/interfaces inherited from interface org.refcodes.component.Startable

        org.refcodes.component.Startable.StartAutomaton, org.refcodes.component.Startable.StartBuilder<B extends org.refcodes.component.Startable.StartBuilder<B>>, org.refcodes.component.Startable.UncheckedStartable

      • Nested classes/interfaces inherited from interface org.refcodes.component.Stoppable

        org.refcodes.component.Stoppable.StopAutomaton, org.refcodes.component.Stoppable.StopBuilder<B extends org.refcodes.component.Stoppable.StopBuilder<B>>, org.refcodes.component.Stoppable.UncheckedStoppable

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static RuntimeLogger LOGGER  

    • Constructor Summary

      Constructors 
      Constructor Description
      PartedLoggerImpl​(org.refcodes.controlflow.ExecutionStrategy aComponentExecutionStrategy, org.refcodes.tabular.Column<P> aPartitionColumn, java.lang.String aDefaultLoggerName, LoggerFactory<Logger<T>> aLoggerFactory, boolean isPartitionAutoInitialize)
      Similar to the PartedLoggerImpl(Column, LoggerFactory, boolean) with the additional option of determining the execution strategy of the state change request calls for the encapsulated Logger instances (as of CompositeComponent).
      PartedLoggerImpl​(org.refcodes.controlflow.ExecutionStrategy aComponentExecutionStrategy, org.refcodes.tabular.Column<P> aPartitionColumn, LoggerFactory<Logger<T>> aLoggerFactory, boolean isPartitionAutoInitialize)
      Similar to the PartedLoggerImpl(Column, LoggerFactory, boolean) with the additional option of determining the execution strategy of the state change request calls for the encapsulated Logger instances (as of CompositeComponent).
      PartedLoggerImpl​(org.refcodes.tabular.Column<P> aPartitionColumn, java.lang.String aDefaultLoggerName, LoggerFactory<Logger<T>> aLoggerFactory, boolean isPartitionAutoInitialize)
      Instantiates a new parted logger impl.
      PartedLoggerImpl​(org.refcodes.tabular.Column<P> aPartitionColumn, LoggerFactory<Logger<T>> aLoggerFactory, boolean isPartitionAutoInitialize)
      Instantiates a new parted logger impl.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      void decompose()
      void decomposePartition​(P aPartition)
      Decomposes the given partition.
      void destroy()
      void destroyPartition​(P aPartition)
      Destroys the given partition.
      void dispose()
      void flush()
      void flushPartition​(P aPartition)
      Flushes the given partition, all buffered data is to be forwarded to the physical data sink.
      protected L getFallbackLogger()
      Returns the fallback Logger.
      protected java.util.Collection<L> getLoggers()
      Provides access to the partitions managed by the AbstractPartedLogger.
      protected org.refcodes.tabular.Column<P> getPartitionColumn()
      Provides access to the Column used to identify partitions.
      protected L getPartitionLogger​(P aPartition)
      Returns the Logger being responsible for the given partition.
      protected java.lang.String getPartitionUid​(P aPartition)
      Depending whether the partition object provides a Universal-ID or not we return the string representation of the partition's object or the UID.
      boolean hasPartition​(P aPartition)
      Tests whether the provided partition exists.
      void initialize()
      L initPartition​(P aPartition)
      Initializes the given partition.
      void log​(org.refcodes.tabular.Record<? extends T> aRecord)
      Logs a Record.
      void open()
      void pause()
      void reset()
      void resume()
      void start()
      void stop()

      • Methods inherited from interface org.refcodes.component.Closable

        closeIn, closeQuietly, closeUnchecked

      • Methods inherited from interface org.refcodes.component.Flushable

        flushUnchecked, isFlushable

      • Methods inherited from interface org.refcodes.component.Initializable

        initializeUnchecked

      • 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.Openable

        openUnchecked

      • Methods inherited from interface org.refcodes.component.Pausable

        pauseUnchecked

      • Methods inherited from interface org.refcodes.component.Resumable

        resumeUnchecked

      • Methods inherited from interface org.refcodes.component.Startable

        startUnchecked

      • Methods inherited from interface org.refcodes.component.Stoppable

        stopUnchecked

    • Constructor Detail

      • PartedLoggerImpl

        public PartedLoggerImpl​(org.refcodes.tabular.Column<P> aPartitionColumn,
                        LoggerFactory<Logger<T>> aLoggerFactory,
                        boolean isPartitionAutoInitialize)
        Instantiates a new parted logger impl.
        Parameters:
        aPartitionColumn - the partition column
        aLoggerFactory - the logger factory
        isPartitionAutoInitialize - the is partition auto initialize

      • PartedLoggerImpl

        public PartedLoggerImpl​(org.refcodes.tabular.Column<P> aPartitionColumn,
                        java.lang.String aDefaultLoggerName,
                        LoggerFactory<Logger<T>> aLoggerFactory,
                        boolean isPartitionAutoInitialize)
        Instantiates a new parted logger impl.
        Parameters:
        aPartitionColumn - the partition column
        aDefaultLoggerName - the default logger name
        aLoggerFactory - the logger factory
        isPartitionAutoInitialize - the is partition auto initialize

      • PartedLoggerImpl

        public PartedLoggerImpl​(org.refcodes.controlflow.ExecutionStrategy aComponentExecutionStrategy,
                        org.refcodes.tabular.Column<P> aPartitionColumn,
                        LoggerFactory<Logger<T>> aLoggerFactory,
                        boolean isPartitionAutoInitialize)
        Similar to the PartedLoggerImpl(Column, LoggerFactory, boolean) with the additional option of determining the execution strategy of the state change request calls for the encapsulated Logger instances (as of CompositeComponent).
        Parameters:
        aComponentExecutionStrategy - The strategy to be used when invoking a component's (encapsulated Logger instance's) state change request call (as of CompositeComponent).

      • PartedLoggerImpl

        public PartedLoggerImpl​(org.refcodes.controlflow.ExecutionStrategy aComponentExecutionStrategy,
                        org.refcodes.tabular.Column<P> aPartitionColumn,
                        java.lang.String aDefaultLoggerName,
                        LoggerFactory<Logger<T>> aLoggerFactory,
                        boolean isPartitionAutoInitialize)
        Similar to the PartedLoggerImpl(Column, LoggerFactory, boolean) with the additional option of determining the execution strategy of the state change request calls for the encapsulated Logger instances (as of CompositeComponent).
        Parameters:
        aComponentExecutionStrategy - The strategy to be used when invoking a component's (encapsulated Logger instance's) state change request call (as of CompositeComponent).

    • Method Detail

      • initialize

        public void initialize()
                throws org.refcodes.component.InitializeException
        Specified by:
        initialize in interface org.refcodes.component.Initializable
        Throws:
        org.refcodes.component.InitializeException

      • start

        public void start()
           throws org.refcodes.component.StartException
        Specified by:
        start in interface org.refcodes.component.Startable
        Throws:
        org.refcodes.component.StartException

      • pause

        public void pause()
           throws org.refcodes.component.PauseException
        Specified by:
        pause in interface org.refcodes.component.Pausable
        Throws:
        org.refcodes.component.PauseException

      • resume

        public void resume()
            throws org.refcodes.component.ResumeException
        Specified by:
        resume in interface org.refcodes.component.Resumable
        Throws:
        org.refcodes.component.ResumeException

      • stop

        public void stop()
          throws org.refcodes.component.StopException
        Specified by:
        stop in interface org.refcodes.component.Stoppable
        Throws:
        org.refcodes.component.StopException

      • decompose

        public void decompose()
        Specified by:
        decompose in interface org.refcodes.component.Decomposeable

      • flush

        public void flush()
           throws org.refcodes.component.OpenException
        Specified by:
        flush in interface java.io.Flushable
        Specified by:
        flush in interface org.refcodes.component.Flushable
        Throws:
        org.refcodes.component.OpenException

      • destroy

        public void destroy()
        Specified by:
        destroy in interface org.refcodes.component.Destroyable

      • reset

        public void reset()
        Specified by:
        reset in interface org.refcodes.component.Resetable

      • open

        public void open()
          throws org.refcodes.component.OpenException
        Specified by:
        open in interface org.refcodes.component.Openable
        Throws:
        org.refcodes.component.OpenException

      • close

        public void close()
        Specified by:
        close in interface org.refcodes.component.Closable

      • dispose

        public void dispose()
        Specified by:
        dispose in interface org.refcodes.mixin.Disposable

      • log

        public void log​(org.refcodes.tabular.Record<? extends T> aRecord)
         throws IllegalRecordRuntimeException,
                UnexpectedLogRuntimeException
        Logs a Record. The targeted data sink for the Record instances (where them are physically stored) depends on the implementation of the Logger. It can be a console, a file, a stream or a database.
        Specified by:
        log in interface Logger<L extends Logger<T>>
        Parameters:
        aRecord - The Record to be logged.
        Throws:
        IllegalRecordRuntimeException - Thrown in case the record cannot be logged as a specific implementation might expect some dedicated Column instances to be contained in the provided Record.
        UnexpectedLogRuntimeException - Thrown in case some other problems regarding logging occurred, e.g. the data sink (physical system where to log to) experiences problems.

      • hasPartition

        public boolean hasPartition​(P aPartition)
        Tests whether the provided partition exists.
        Parameters:
        aPartition - The value of the Column in a Record specifying the partition which is to be addressed (or even auto initialized).
        Returns:
        True in case the partition exists, else false.

      • initPartition

        public L initPartition​(P aPartition)
                throws org.refcodes.component.InitializeException
        Initializes the given partition.
        Parameters:
        aPartition - The value of the Column in a Record specifying the partition which is to be auto initialized.
        Returns:
        the l
        Throws:
        org.refcodes.component.InitializeException - in case initialization failed e.g. when the partition already exists or the system was not able to create the required amount of endpoints.

      • destroyPartition

        public void destroyPartition​(P aPartition)
        Destroys the given partition. External resources might stay untouched! In case the partition does not exist, then there is no partition to be destroyed. To make things easier, this is not considered an exceptional state as after the call we expect that there is none such partition (any more) which is not destroyed.
        Parameters:
        aPartition - the partition

      • flushPartition

        public void flushPartition​(P aPartition)
                    throws java.io.IOException
        Flushes the given partition, all buffered data is to be forwarded to the physical data sink.
        Parameters:
        aPartition - The partition to be flushed.
        Throws:
        java.io.IOException - in case there were problems when flushing, e.g. there is none such partition.

      • decomposePartition

        public void decomposePartition​(P aPartition)
        Decomposes the given partition. External resources might get deleted (such as files or DB schemas)! In case the partition does not exist, then there is no partition to be decomposed. To make things easier, this is not considered an exceptional state as after the call we expect that there is none such partition (any more).
        Parameters:
        aPartition - The partition to be decomposed.

      • getLoggers

        protected java.util.Collection<L> getLoggers()
        Provides access to the partitions managed by the AbstractPartedLogger. This is especially useful for extensions of this class such as the AbstractPartedQueryLogger or the AbstractPartedTrimLogger.
        Returns:
        The Logger instances managed by the AbstractPartedLogger instance.

      • getPartitionUid

        protected java.lang.String getPartitionUid​(P aPartition)
        Depending whether the partition object provides a Universal-ID or not we return the string representation of the partition's object or the UID.
        Parameters:
        aPartition - The partition for which to get the identifier
        Returns:
        The UID in case the partition provides a UID, else the partition's string representation.

      • getPartitionColumn

        protected org.refcodes.tabular.Column<P> getPartitionColumn()
        Provides access to the Column used to identify partitions.
        Returns:
        The Column identifying partitions.

      • getPartitionLogger

        protected L getPartitionLogger​(P aPartition)
        Returns the Logger being responsible for the given partition.
        Parameters:
        aPartition - The partition for which to get the responsible Logger.
        Returns:
        The Logger responsible for the given partition or null if none was found for the partition.

      • getFallbackLogger

        protected L getFallbackLogger()
        Returns the fallback Logger.
        Returns:
        The fallback logger or null if none was enabled.