com.endeca.soleng.eac.toolkit.component

Class LogServerComponent

java.lang.Object

com.endeca.soleng.eac.toolkit.base.EacElement

com.endeca.soleng.eac.toolkit.base.Provisionable

com.endeca.soleng.eac.toolkit.component.Component

com.endeca.soleng.eac.toolkit.component.ServerComponent

com.endeca.soleng.eac.toolkit.component.LogServerComponent

public class LogServerComponent
extends com.endeca.soleng.eac.toolkit.component.ServerComponent

Field Summary

Fields inherited from class com.endeca.soleng.eac.toolkit.base.EacElement

appName, dataPrefix, eacHost, eacPort, elementId, lockManager, logDir, sslEnabled, workingDir

Constructor Summary

Constructors

Constructor and Description
LogServerComponent()

Method Summary

Methods

Modifier and Type	Method and Description
com.endeca.eac.client.ComponentType	buildEacStub()
void	callLogserverRollUrl() Shells out to call curl on the logserver's /roll URL to trigger a log roll.
void	copyAllButLastLogFileToTargetDir() Copies all log files in the LogServer output to the target report gen directory, excluding the log file with the latest time stamp.
void	copyAllLogFilesToTargetDir() Copies all log files in the LogServer output to the target report gen directory.
void	copyDaySoFarLogFilesToTargetDir() Copies the log files required for the "DaySoFar" report to the target report gen directory.
void	copyLastWeekLogFilesToTargetDir() Copies the log files required for the "LastWeek" report to the target report gen directory.
void	copyLogFilesToTargetDir(Date startDate, Date endDate) Copies all log files in a specified date range from logserver output to target report gen directory.
void	copyWeekEndingYesterdayLogFilesToTargetDir() Copies the log files required for the week ending yesterday report to the target report gen directory.
void	copyYesterdayLogFilesToTargetDir() Copies the log files required for the "Yesterday" report to the target report gen directory.
void	cycle()
boolean	dateRangeIncludesLatestLogFile(Date startDate, Date endDate) Returns true if the requested date range would require the most recent log file.
SortedMap<Date,String>	getLogFilesByStartDate() Returns a map of all logserver output files, keyed by the date object parsed from the file's timestamp.
String	getOutputDir()
int	getPort()
String	getTargetReportGenDir()
String	getTargetReportGenHostId()
protected void	initializeEacStub(com.endeca.eac.client.LogServerComponentType stub)
boolean	isGzip()
boolean	lastWeekIncludesLatestLogFile() Returns true if the latest log file is included in the date range required for the "LastWeek" report.
void	setGzip(boolean gzip)
void	setOutputDir(String outputDir)
void	setPort(int port)
boolean	weekEndingYesterdayIncludesLatestLogFile() Returns true if the latest log file is included in the date range required for the week ending yesterday report.
boolean	yesterdayIncludesLatestLogFile() Returns true if the latest log file is included in the date range required for the "Yesterday" report.

Methods inherited from class com.endeca.soleng.eac.toolkit.component.ServerComponent

getNumIdleSecondsAfterStop, getPostStartupScript, getPreShutdownScript, getShutdownTimeout, getStartupTimeout, isRunning, isStarting, setPostStartupScript, setPreShutdownScript, setStartupTimeout, start, startAsynchronously, startInParallel, stop, stopAsynchronously, stopInParallel, waitForStarted, waitForStopped

Methods inherited from class com.endeca.soleng.eac.toolkit.component.Component

archiveLogDir, cleanDir, constructArchiveLogDir, constructCleanDir, getCustomDirectories, getDirProperties, getHost, getHostId, getLongPropertyValueOrDefault, getMaxMissedStatusChecksAllowed, getMaxWaitTimeSeconds, getMinWaitTimeSeconds, getNumLogBackups, getNumMissedStatusChecks, getProperties, getProperty, getSlowPollingIntervalMs, getStandardPollingIntervalMs, getStatus, incrementMissedStatusQueries, initializeEacStub, isActive, isDefined, isDefinitionChanged, isFailed, isHotUpdateDefinitionChange, isSkipTestingForFilesDuringCleanup, removeDefinition, setCustomDirectories, setDefinition, setDefinition, setHost, setHostId, setNumMissedStatusChecks, setProperties, updateDefinition, updateEacDefinition, updateEacDefinition, waitForFinished

Methods inherited from class com.endeca.soleng.eac.toolkit.base.Provisionable

getAppDefinitionFromEac, getCachedAppDefinition, getProvisioningPort, invalidateCachedAppDefinition, setCachedAppDefinition

Methods inherited from class com.endeca.soleng.eac.toolkit.base.EacElement

getAppName, getDataPrefix, getEacHost, getEacPort, getElementId, getLockManager, getLogDir, getWorkingDir, isSslEnabled, setAppName, setDataPrefix, setEacHost, setEacPort, setElementId, setLockManager, setLogDir, setSslEnabled, setWorkingDir

Methods inherited from class java.lang.Object

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

Constructor Detail

LogServerComponent

public LogServerComponent()

Method Detail

cycle

public void cycle()
           throws com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                  com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                  InterruptedException,
                  com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

Overrides:

cycle in class com.endeca.soleng.eac.toolkit.component.ServerComponent

Throws:

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

buildEacStub

public com.endeca.eac.client.ComponentType buildEacStub()

Overrides:

buildEacStub in class com.endeca.soleng.eac.toolkit.component.Component

initializeEacStub

protected void initializeEacStub(com.endeca.eac.client.LogServerComponentType stub)

callLogserverRollUrl

public void callLogserverRollUrl()
                          throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                 com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                 com.endeca.soleng.eac.toolkit.exception.EacComponentControlException,
                                 InterruptedException

Shells out to call curl on the logserver's /roll URL to trigger a log roll.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

InterruptedException

copyYesterdayLogFilesToTargetDir

public void copyYesterdayLogFilesToTargetDir()
                                      throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                             com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                             com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

Copies the log files required for the "Yesterday" report to the target report gen directory.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

copyDaySoFarLogFilesToTargetDir

public void copyDaySoFarLogFilesToTargetDir()
                                     throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                            com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                            com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

Copies the log files required for the "DaySoFar" report to the target report gen directory.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

yesterdayIncludesLatestLogFile

public boolean yesterdayIncludesLatestLogFile()
                                       throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                              com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

Returns true if the latest log file is included in the date range required for the "Yesterday" report.

Returns:

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

copyLastWeekLogFilesToTargetDir

public void copyLastWeekLogFilesToTargetDir()
                                     throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                            com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                            com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

Copies the log files required for the "LastWeek" report to the target report gen directory.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

lastWeekIncludesLatestLogFile

public boolean lastWeekIncludesLatestLogFile()
                                      throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                             com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

Returns true if the latest log file is included in the date range required for the "LastWeek" report.

Returns:

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

copyWeekEndingYesterdayLogFilesToTargetDir

public void copyWeekEndingYesterdayLogFilesToTargetDir()
                                                throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                                       com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                                       com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

Copies the log files required for the week ending yesterday report to the target report gen directory.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

weekEndingYesterdayIncludesLatestLogFile

public boolean weekEndingYesterdayIncludesLatestLogFile()
                                                 throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                                        com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

Returns true if the latest log file is included in the date range required for the week ending yesterday report.

Returns:

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

dateRangeIncludesLatestLogFile

public boolean dateRangeIncludesLatestLogFile(Date startDate,
                                     Date endDate)
                                       throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                              com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

Returns true if the requested date range would require the most recent log file. This method can be used to test whether the logserver should be "rolled" to free up the latest log file for report generation.

Parameters:

startDate -

endDate -

Returns:

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

copyAllLogFilesToTargetDir

public void copyAllLogFilesToTargetDir()
                                throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                       com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                       com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

Copies all log files in the LogServer output to the target report gen directory. Uses the date range-based log copier with date range starting at "start of epoch" (1/1/70) and ending 1 second from now.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

copyAllButLastLogFileToTargetDir

public void copyAllButLastLogFileToTargetDir()
                                      throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                             com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                             com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

Copies all log files in the LogServer output to the target report gen directory, excluding the log file with the latest time stamp. Uses the date range-based log copier with date range starting at the "start of epoch" (1/1/70) and ending at the date of the last file in the directory. This method may be used if the latest log file is being used by the active LogServer and all "unlocked" files are desired.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

copyLogFilesToTargetDir

public void copyLogFilesToTargetDir(Date startDate,
                           Date endDate)
                             throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                    com.endeca.soleng.eac.toolkit.exception.EacCommunicationException,
                                    com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

Copies all log files in a specified date range from logserver output to target report gen directory.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

com.endeca.soleng.eac.toolkit.exception.EacComponentControlException

getLogFilesByStartDate

public SortedMap<Date,String> getLogFilesByStartDate()
                                              throws com.endeca.soleng.eac.toolkit.exception.AppConfigurationException,
                                                     com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

Returns a map of all logserver output files, keyed by the date object parsed from the file's timestamp. This method retrieves a list of all files in the LogServer's output directory, matches them against a regex that looks for the pattern yyyy_MM_dd.HH_mm_ss and parses the matching timestamp into a date. If any files don't match or can't be parsed into a date, warnings are logged but ignored.

Returns:

Returns a sorted map of logserver output files, keyed by the date in the log's filename, containign the filename as a value.

Throws:

com.endeca.soleng.eac.toolkit.exception.AppConfigurationException

com.endeca.soleng.eac.toolkit.exception.EacCommunicationException

getTargetReportGenDir

public String getTargetReportGenDir()

getTargetReportGenHostId

public String getTargetReportGenHostId()

isGzip

public boolean isGzip()

setGzip

public void setGzip(boolean gzip)

getOutputDir

public String getOutputDir()

setOutputDir

public void setOutputDir(String outputDir)

getPort

public int getPort()

setPort

public void setPort(int port)