org.jboss.deployment.scanner
Interface DeploymentScanner

All Superinterfaces:

Service (src)

All Known Implementing Classes:

AbstractDeploymentScanner (src) , URLDeploymentScanner (src) , URLDirectoryScanner (src)

public interface DeploymentScanner

extends Service (src)

Provides the basic interface for a deployment scanner.

A deployment scanner scans for new, removed or changed deployments.

setDeployer

public void setDeployer(ObjectName (src)  deployerName)

The ObjectName of the Deployer which we will use.

Parameters:

deployerName - The object name of the deployer to use.

getDeployer

public ObjectName (src)  getDeployer()

Get the ObjectName of the Deployer which we are using.

Returns:

The object name of the deployer we are using.

setScanPeriod

public void setScanPeriod(long period)

Set the scan period for the scanner.

Parameters:

period - This is the time in milliseconds between scans.

Throws:

java.lang.IllegalArgumentException - Period value out of range.

getScanPeriod

public long getScanPeriod()

Get the scan period for the scanner.

Returns:

This is the time in milliseconds between scans.

setScanEnabled

public void setScanEnabled(boolean flag)

Disable or enable the period based deployment scanning.

Manual scanning can still be performed by calling scan().

Parameters:

flag - True to enable or false to disable period based scanning.

isScanEnabled

public boolean isScanEnabled()

Check if period based scanning is enabled.

Returns:

True if enabled, false if disabled.

scan

public void scan()
          throws java.lang.Exception

Scan for deployment changes.

Throws:

java.lang.IllegalStateException - Not initialized.

java.lang.Exception - Scan failed.