org.apache.cactus.integration.api.deployable
Interface DeployableFile

All Known Implementing Classes:

AbstractDeployableFile, EarDeployableFile, WarDeployableFile

public interface DeployableFile

Represents a component to deploy in a container. It can either be a WAR or an EAR file.

Version:

$Id: DeployableFile.java 239003 2004-05-31 20:05:27Z vmassol $

Method Summary

java.lang.Object	clone() Clone the object.
java.io.File	getFile()
java.lang.String	getFilterRedirectorMapping() Returns the first URL-pattern to which the Cactus filter redirector is mapped in the deployment descriptor.
java.lang.String	getJspRedirectorMapping() Returns the first URL-pattern to which the Cactus JSP redirector is mapped in the deployment descriptor.
java.lang.String	getServletRedirectorMapping() Returns the first URL-pattern to which the Cactus servlet redirector is mapped in the deployment descriptor.
java.lang.String	getTestContext()
org.codehaus.cargo.module.webapp.WarArchive	getWarArchive()
boolean	isEar() Returns whether the deployable file is an enterprise application archive (EAR).
boolean	isWar() Returns whether the deployable file is a web-app archive (WAR).
void	setTestContext(java.lang.String theTestContext)

Method Detail

getFile

java.io.File getFile()

Returns:

the file to deploy in a container (either WAR or EAR)

isWar

boolean isWar()

Returns whether the deployable file is a web-app archive (WAR).

Returns:

true if the deployable file is a WAR

isEar

boolean isEar()

Returns whether the deployable file is an enterprise application archive (EAR).

Returns:

true if the deployable file is a EAR

getWarArchive

org.codehaus.cargo.module.webapp.WarArchive getWarArchive()

Returns:

the WAR deployment descriptor object for the WAR containing the Cactus Servlet redirector

getTestContext

java.lang.String getTestContext()

Returns:

the webapp context which holds the Cactus tests

setTestContext

void setTestContext(java.lang.String theTestContext)

Parameters:

theTestContext - the test context that will be used to test if the container is started or not

getServletRedirectorMapping

java.lang.String getServletRedirectorMapping()

Returns the first URL-pattern to which the Cactus servlet redirector is mapped in the deployment descriptor.

Returns:

The mapping, or null if the servlet redirector is not defined or mapped in the descriptor

getFilterRedirectorMapping

java.lang.String getFilterRedirectorMapping()

Returns the first URL-pattern to which the Cactus filter redirector is mapped in the deployment descriptor.

Returns:

The mapping, or null if the filter redirector is not defined or mapped in the descriptor

getJspRedirectorMapping

java.lang.String getJspRedirectorMapping()

Returns the first URL-pattern to which the Cactus JSP redirector is mapped in the deployment descriptor.

Returns:

The mapping, or null if the JSP redirector is not defined or mapped in the descriptor

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone the object.

Returns:

the object clone

Throws:

java.lang.CloneNotSupportedException - If clone is not supported (duh)