blackboard.platform.dataintegration
Class DataIntegrationLogFactory

java.lang.Object
  extended by blackboard.platform.dataintegration.DataIntegrationLogFactory

public class DataIntegrationLogFactory
extends java.lang.Object

Factory for getting Data Integration Loggers.

Since:
Bb 9.1 SP6

Constructor Summary
DataIntegrationLogFactory()
           
 
Method Summary
static java.lang.String finishAggregating(DataIntegration di)
          Finishes an aggregated log operation, and records all intercepted log entries to the DataIntegration log.
static java.lang.String finishAggregating(DataIntegration di, boolean recordChronologically)
          Finishes an aggregated log operation, and records all intercepted log entries to the DataIntegration log.
static AggregatingLogger getAggregatingLogger(DataIntegration di)
          Get the current aggregating logger for the specified data integration.
static Log getInstanceByDataIntegration(DataIntegration integration)
          Get the Log of the DataIntegration specified.
static Log getSystemInstance()
          Get the DataIntegrationLog that is not associated with any specific DataIntegration.
static void setOverrideLog(Log log)
           
static void setOverrideLogSink(blackboard.platform.log.impl.LogSink logSink)
           
static void startAggregating(DataIntegration di)
          Start aggregating log messages for the specified data integration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataIntegrationLogFactory

public DataIntegrationLogFactory()
Method Detail

getInstanceByDataIntegration

public static Log getInstanceByDataIntegration(DataIntegration integration)
Get the Log of the DataIntegration specified.

Parameters:
integration - The data integration whose logger should be retrieved.

getSystemInstance

public static Log getSystemInstance()
Get the DataIntegrationLog that is not associated with any specific DataIntegration.

This is the same as calling DataIntegrationLogFactory.getInstanceByDataIntegration( null ) .


setOverrideLog

public static void setOverrideLog(Log log)

setOverrideLogSink

public static void setOverrideLogSink(blackboard.platform.log.impl.LogSink logSink)

startAggregating

public static void startAggregating(DataIntegration di)
Start aggregating log messages for the specified data integration.

Parameters:
di - The data integration to start aggregating log messages for.

finishAggregating

public static java.lang.String finishAggregating(DataIntegration di)
Finishes an aggregated log operation, and records all intercepted log entries to the DataIntegration log.

Parameters:
di - Integration to stop agreggation for
Returns:
The agreggated text of all intercepted log entries

finishAggregating

public static java.lang.String finishAggregating(DataIntegration di,
                                                 boolean recordChronologically)
Finishes an aggregated log operation, and records all intercepted log entries to the DataIntegration log.

Parameters:
di - Integration to stop agreggation for
recordChronologically - Indicates that log entries should be recorded chronologically. If this is false, entries will be sorted by decreasing priority and then chronologically.
Returns:
The agreggated text of all intercepted log entries

getAggregatingLogger

public static AggregatingLogger getAggregatingLogger(DataIntegration di)
Get the current aggregating logger for the specified data integration.

Parameters:
di - Integration to get the aggregating logger for.
Returns:
The AggregatingLogger.
Throws:
java.lang.RuntimeException - if aggregation has not been started on the data integration.


Copyright © 2012 Blackboard, Inc. All Rights Reserved.