org.jboss.testharness.spi
Interface Containers

public interface Containers

Incontainer mode deployment related operations The TCK porting package must provide an implementation of this interface which is suitable for the target implementation and application server

Author:

Pete Muir

Field Summary

static java.lang.String

PROPERTY_NAME

Method Summary

void	cleanup() Called after the TCK finishes executing the testsuite.
boolean	deploy(java.io.InputStream archive, java.lang.String name) The war/ear to deploy to the container, it should be read using a JarInputStream.
DeploymentException	getDeploymentException() If the deployment failed, obtain the cause of the deployment failure.
void	setup() Called before the TCK starts executing the testsuite, but after the suite has been configured.
void	undeploy(java.lang.String name) Undeploy the war/ear from the container.

Field Detail

PROPERTY_NAME

static final java.lang.String PROPERTY_NAME

Method Detail

deploy

boolean deploy(java.io.InputStream archive,
               java.lang.String name)
               throws java.io.IOException

The war/ear to deploy to the container, it should be read using a JarInputStream. Any deployment exceptions can be found through getDeploymentException(). For a successful deployment, a symmetric undeploy(String) will be called.

Parameters:

archive - the archive

name - the name the TCK uses to refer to this archive, unique within this tck run

Returns:

true if the deployment suceeded, otherwise false

Throws:

java.io.IOException - if any communication problems with the server occur during deployment. These will cause the test suite to fail.

See Also:

undeploy(String)

getDeploymentException

DeploymentException getDeploymentException()

If the deployment failed, obtain the cause of the deployment failure. The true cause of the deployment failure must be included in the cause stack returned by Throwable.getCause().

Returns:

a DeploymentException wrapping the deployment failure, or null if the deployment suceeded

undeploy

void undeploy(java.lang.String name)
              throws java.io.IOException

Undeploy the war/ear from the container.

Parameters:

name - the name the TCK uses to refer to this archive, unique within this tck run

Throws:

java.io.IOException - if any communication problems with the server occur during deployment. These will cause the test suite to fail.

See Also:

deploy(InputStream, String)

setup

void setup()
           throws java.io.IOException

Called before the TCK starts executing the testsuite, but after the suite has been configured. A TCK suite lifecycle callback, useful for setting up the container. This method may be a no-op if no setup is required.

Throws:

java.io.IOException - if any communication problems with the server occur during setup. These will cause the test suite to fail.

cleanup

void cleanup()
             throws java.io.IOException

Called after the TCK finishes executing the testsuite. A TCK suite lifecycle callback, useful for cleaning up and shutting down the container. This method may be a no-op if no setup is required.

Throws:

java.io.IOException - if any communication problems with the server occur during cleanup. These will cause the test suite to fail.