weblogic.management.deploy

Class GenericAppPoller

java.lang.Object

weblogic.management.deploy.GenericAppPoller

Direct Known Subclasses:

ApplicationsDirPoller

public abstract class GenericAppPoller
extends java.lang.Object

Excluded in public API Reference.

This class is a generic polling class. It keeps track of files in a directory, and determines on each run of the poller whether files have been added, modified, or deleted since the last time the poller ran. It calls doActivate on all new and modified files and doDeactivate on all the deleted files. This class can be run in polling mode, or in a runOnce mode. If run in runOnce mode, the Object keeps track of its state with a temp file that are placed in the current directory. The temp file contains the information store in the lastRunFileMap. (the files that existed on the last run of the tool). doActivate and doDeactivate are abstract methods that must be implemented in a subclass. there are always different requirements for what to do with new/modified/deleted files for every application. shouldActivate and shouldDeactivate are also protected non-final methods, and can be overridden by a subclass. The default behavior for shouldActivate is whether the file timestamp of the current file is newer than the timestamp of the recorded file. The default behavior of shouldDeactivate is if the file existed in the last poller run, but does not exist now. Subclasses should override these methods to implement filename filters, to ignore specific files or directories, etc. IMPORTANT NOTE TO ANYONE MAINTAINING THIS CLASS This Object stores files in HashMaps and ArrayLists, keyed on the full path of a file. It is important to always use canonical paths and canonical files, and NOT absolute paths. Absolute paths can contain a lot of cruft that makes string compares a mess. For example, the following are all the same file, but a String compare will not be able to determine this. NEITHER WILL A File.compareTo or File.equals!!! File.compareTo and File.equals only seem to work on Canonical Files. any of these could be the value in File.getAbsolutePath for the same file object, depending on how it was constructed. d:\foo\.\bar\baz D:\foo\.\bar\baz d:\foo\bar\baz D:\foo\bar\baz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	GenericAppPoller.PollerTimerListener PollerTrigger implements a WLS trigger that periodically calls the doit() method every pollInterval millisec's.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList	activateFileList
private java.util.HashMap	currentRunFileMap
private java.util.ArrayList	deactivateFileList
protected static boolean	debug
private java.util.HashMap	lastRunFileMap
private java.lang.String	lastRunFilename
protected static boolean	methodTrace
private weblogic.timers.Timer	pollerTimer
private long	pollInterval
private boolean	runOnce
private boolean	searchRecursively
private java.io.File	startDir
protected boolean	startDirFound
protected boolean	verbose

Constructor Summary

Constructors

Constructor and Description
GenericAppPoller(java.io.File startDir, boolean searchRecursively, long pollInterval)
GenericAppPoller(java.io.File startDir, boolean searchRecursively, long pollInterval, java.lang.String runFileName)

Method Summary

Modifier and Type	Method and Description
private void	cancelPollerTimerListener()
abstract void	doActivate()
abstract void	doDeactivate()
protected void	doit()
protected void	dumpArrayList(java.lang.String msg, java.util.ArrayList rl)
protected void	dumpHashMap(java.lang.String msg, java.util.Map hashmap)
protected void	dumpStringArray(java.lang.String msg, java.lang.String[] str)
private void	generateActivateFileList()
private void	generateDeactivateFileList()
protected java.util.ArrayList	getActivateFileList()
protected java.util.ArrayList	getDeactivateFileList()
protected java.lang.Long	getLastCheckPoint(java.io.File f)
private void	getLastRunFileMap()
long	getPollInterval()
protected java.io.File	getStartDir()
private boolean	ignoreFile(java.io.File f)
(package private) void	removeFileFromMap(java.io.File file)
void	runInSameThread()
protected void	setCheckPoint(java.io.File f, long time)
private void	setCurrentRunMap(java.io.File startDir)
private void	setLastRunFileMap()
void	setSleepInterval(long pollInterval)
protected boolean	shouldActivate(java.io.File file)
protected boolean	shouldDeactivate(java.io.File file)
void	start()
private void	startPollerTimerListener()

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected static boolean debug

methodTrace

protected static boolean methodTrace

verbose

protected boolean verbose

searchRecursively

private boolean searchRecursively

startDir

private java.io.File startDir

currentRunFileMap

private java.util.HashMap currentRunFileMap

lastRunFileMap

private java.util.HashMap lastRunFileMap

activateFileList

private java.util.ArrayList activateFileList

deactivateFileList

private java.util.ArrayList deactivateFileList

pollInterval

private long pollInterval

runOnce

private boolean runOnce

pollerTimer

private weblogic.timers.Timer pollerTimer

lastRunFilename

private java.lang.String lastRunFilename

startDirFound

protected boolean startDirFound

Constructor Detail

GenericAppPoller

public GenericAppPoller(java.io.File startDir,
                        boolean searchRecursively,
                        long pollInterval)

GenericAppPoller

public GenericAppPoller(java.io.File startDir,
                        boolean searchRecursively,
                        long pollInterval,
                        java.lang.String runFileName)

Method Detail

doActivate

public abstract void doActivate()

doDeactivate

public abstract void doDeactivate()

runInSameThread

public final void runInSameThread()

start

public void start()

setSleepInterval

public void setSleepInterval(long pollInterval)

shouldActivate

protected boolean shouldActivate(java.io.File file)

shouldDeactivate

protected boolean shouldDeactivate(java.io.File file)

getActivateFileList

protected final java.util.ArrayList getActivateFileList()

getDeactivateFileList

protected final java.util.ArrayList getDeactivateFileList()

doit

protected final void doit()

getStartDir

protected java.io.File getStartDir()

setCurrentRunMap

private void setCurrentRunMap(java.io.File startDir)
                       throws java.io.IOException

Throws:

java.io.IOException

removeFileFromMap

void removeFileFromMap(java.io.File file)

getPollInterval

public long getPollInterval()

generateActivateFileList

private void generateActivateFileList()

generateDeactivateFileList

private void generateDeactivateFileList()

ignoreFile

private boolean ignoreFile(java.io.File f)

getLastRunFileMap

private void getLastRunFileMap()
                        throws java.io.IOException

Throws:

java.io.IOException

setLastRunFileMap

private void setLastRunFileMap()
                        throws java.io.IOException

Throws:

java.io.IOException

startPollerTimerListener

private void startPollerTimerListener()

cancelPollerTimerListener

private void cancelPollerTimerListener()

setCheckPoint

protected final void setCheckPoint(java.io.File f,
                                   long time)

getLastCheckPoint

protected final java.lang.Long getLastCheckPoint(java.io.File f)

dumpArrayList

protected final void dumpArrayList(java.lang.String msg,
                                   java.util.ArrayList rl)

dumpHashMap

protected final void dumpHashMap(java.lang.String msg,
                                 java.util.Map hashmap)

dumpStringArray

protected final void dumpStringArray(java.lang.String msg,
                                     java.lang.String[] str)