org.jboss.as.server.deployment.scanner.api

Interface DeploymentScanner

public interface DeploymentScanner

The deployment scanner.

Author:

Emanuel Muckenhuber

Field Summary

Fields

Modifier and Type	Field and Description
static org.jboss.msc.service.ServiceName	BASE_SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
long	getScanInterval() Get the current scan interval
boolean	isAutoDeployExplodedContent() Gets whether the scanner will attempt to deploy exploded content based solely on detecting a change in the content; i.e.
boolean	isAutoDeployXMLContent() Gets whether the scanner will attempt to deploy XML content based solely on detecting a change in the content; i.e.
boolean	isAutoDeployZippedContent() Gets whether the scanner will attempt to deploy zipped content based solely on detecting a change in the content; i.e.
boolean	isEnabled() Check whether the scanner is enabled.
void	setAutoDeployExplodedContent(boolean autoDeployExploded) Sets whether the scanner will attempt to deploy exploded content based solely on detecting a change in the content; i.e.
void	setAutoDeployXMLContent(boolean autoDeployXML) Sets whether the scanner will attempt to deploy XML content based solely on detecting a change in the content; i.e.
void	setAutoDeployZippedContent(boolean autoDeployZip) Sets whether the scanner will attempt to deploy zipped content based solely on detecting a change in the content; i.e.
void	setDeploymentTimeout(long timeout) Set the timeout used for deployments.
void	setRuntimeFailureCausesRollback(boolean rollback) Sets whether a runtime failure of a deployment causes a rollback of the deployment as well as all other (maybe unrelated) deployments as part of the scan operation.
void	setScanInterval(long scanInterval) Set the scan interval.
void	startScanner() Start the scanner, if not already started, using a default DeploymentOperations.
void	startScanner(DeploymentOperations deploymentOperations) Start the scanner, if not already started.
void	stopScanner() Stop the scanner, if not already stopped.

Field Detail

BASE_SERVICE_NAME

static final org.jboss.msc.service.ServiceName BASE_SERVICE_NAME

Method Detail

isEnabled

boolean isEnabled()

Check whether the scanner is enabled.

Returns:

true if enabled, false otherwise

getScanInterval

long getScanInterval()

Get the current scan interval

Returns:

the scan interval in ms

setScanInterval

void setScanInterval(long scanInterval)

Set the scan interval.

Parameters:

scanInterval - the scan interval in ms

startScanner

void startScanner()

Start the scanner, if not already started, using a default DeploymentOperations.

See Also:

startScanner(DeploymentOperations)

startScanner

void startScanner(DeploymentOperations deploymentOperations)

Start the scanner, if not already started.

stopScanner

void stopScanner()

Stop the scanner, if not already stopped.

isAutoDeployZippedContent

boolean isAutoDeployZippedContent()

Gets whether the scanner will attempt to deploy zipped content based solely on detecting a change in the content; i.e. without requiring a marker file to trigger the deployment.

Returns:

true if auto-deployment of zipped content is enabled

setAutoDeployZippedContent

void setAutoDeployZippedContent(boolean autoDeployZip)

Sets whether the scanner will attempt to deploy zipped content based solely on detecting a change in the content; i.e. without requiring a marker file to trigger the deployment. param autoDeployZip true if auto-deployment of zipped content is enabled

isAutoDeployExplodedContent

boolean isAutoDeployExplodedContent()

Gets whether the scanner will attempt to deploy exploded content based solely on detecting a change in the content; i.e. without requiring a marker file to trigger the deployment.

Returns:

true if auto-deployment of exploded content is enabled

setAutoDeployExplodedContent

void setAutoDeployExplodedContent(boolean autoDeployExploded)

Sets whether the scanner will attempt to deploy exploded content based solely on detecting a change in the content; i.e. without requiring a marker file to trigger the deployment. param autoDeployZip true if auto-deployment of exploded content is enabled

isAutoDeployXMLContent

boolean isAutoDeployXMLContent()

Gets whether the scanner will attempt to deploy XML content based solely on detecting a change in the content; i.e. without requiring a marker file to trigger the deployment.

Returns:

true if auto-deployment of XML content is enabled

setAutoDeployXMLContent

void setAutoDeployXMLContent(boolean autoDeployXML)

Sets whether the scanner will attempt to deploy XML content based solely on detecting a change in the content; i.e. without requiring a marker file to trigger the deployment. param autoDeployXML true if auto-deployment of XML content is enabled

setDeploymentTimeout

void setDeploymentTimeout(long timeout)

Set the timeout used for deployments.

Parameters:

timeout - The deployment timeout

setRuntimeFailureCausesRollback

void setRuntimeFailureCausesRollback(boolean rollback)

Sets whether a runtime failure of a deployment causes a rollback of the deployment as well as all other (maybe unrelated) deployments as part of the scan operation.

Parameters:

rollback - true if runtime failures should trigger a rollback