org.gridgain.grid.spi.deployment.uri.scanners

Class GridUriDeploymentScanner

java.lang.Object

org.gridgain.grid.spi.deployment.uri.scanners.GridUriDeploymentScanner

Direct Known Subclasses:

GridUriDeploymentFileScanner, GridUriDeploymentFtpScanner, GridUriDeploymentHttpScanner

public abstract class GridUriDeploymentScanner
extends Object

Base deployment scanner implementation. It simplifies scanner implementation by providing loggers, executors and file names parsing methods.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GridUriDeploymentScanner(String gridName, URI uri, File deployDir, long freq, FilenameFilter filter, GridUriDeploymentScannerListener lsnr, org.gridgain.grid.logger.GridLogger log) Creates new scanner.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels scanner execution.
protected File	createTempFile(String fileName, File tmpDir) Creates temp file in temp directory.
protected File	getDeployDirectory() Gets temporary deployment directory.
protected String	getFileUri(String name) Gets file URI for the given file name.
protected FilenameFilter	getFilter() Gets filter for found files.
protected long	getFrequency() Gets deployment frequency.
protected GridUriDeploymentScannerListener	getListener() Gets deployment listener.
protected org.gridgain.grid.logger.GridLogger	getLogger() Gets scanner logger.
protected URI	getUri() Gets deployment URI.
protected boolean	isCancelled() Tests whether scanner was cancelled before or not.
protected boolean	isFirstScan() Tests whether first scan completed or not.
void	join() Joins scanner thread.
protected abstract void	process() Scans URI for new, updated or deleted files.
void	start() Starts scanner.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GridUriDeploymentScanner

protected GridUriDeploymentScanner(String gridName,
                        URI uri,
                        File deployDir,
                        long freq,
                        FilenameFilter filter,
                        GridUriDeploymentScannerListener lsnr,
                        org.gridgain.grid.logger.GridLogger log)

Creates new scanner.

Parameters:

gridName - Grid name.

uri - URI which scanner should looks after.

deployDir - Temporary deployment directory.

freq - Scan frequency.

filter - Found files filter.

lsnr - Scanner listener which should be notifier about changes.

log - Logger.

Method Detail

process

protected abstract void process()

Scans URI for new, updated or deleted files.

start

public void start()

Starts scanner.

cancel

public void cancel()

Cancels scanner execution.

join

public void join()

Joins scanner thread.

isCancelled

protected boolean isCancelled()

Tests whether scanner was cancelled before or not.

Returns:

true if scanner was cancelled and false otherwise.

createTempFile

protected File createTempFile(String fileName,
                  File tmpDir)
                       throws IOException

Creates temp file in temp directory.

Parameters:

fileName - File name.

tmpDir - dir to creating file.

Returns:

created file.

Throws:

IOException - if error occur.

getFileUri

protected String getFileUri(String name)

Gets file URI for the given file name. It extends any given name with uri.

Parameters:

name - File name.

Returns:

URI for the given file name.

isFirstScan

protected boolean isFirstScan()

Tests whether first scan completed or not.

Returns:

true if first scan has been already completed and false otherwise.

getUri

protected final URI getUri()

Gets deployment URI.

Returns:

Deployment URI.

getFrequency

protected final long getFrequency()

Gets deployment frequency.

Returns:

Deployment frequency.

getDeployDirectory

protected final File getDeployDirectory()

Gets temporary deployment directory.

Returns:

Temporary deployment directory.

getFilter

protected final FilenameFilter getFilter()

Gets filter for found files. Before lsnr is notified about changes with certain file last should be accepted by filter.

Returns:

New, updated or deleted file filter.

getListener

protected final GridUriDeploymentScannerListener getListener()

Gets deployment listener.

Returns:

Listener which should be notified about all deployment events by scanner.

getLogger

protected final org.gridgain.grid.logger.GridLogger getLogger()

Gets scanner logger.

Returns:

Logger.

toString

public String toString()

Overrides:

toString in class Object