Package org.jboss.as.arquillian.setup

Class SystemPropertyServerSetupTask

java.lang.Object
org.jboss.as.arquillian.setup.SystemPropertyServerSetupTask
All Implemented Interfaces:
ServerSetupTask
public abstract class SystemPropertyServerSetupTask extends Object implements ServerSetupTask
A setup task for Arquillian tests which set system properties in WildFly and remove them when the test is complete.
Author:
James R. Perkins

  • Constructor Details

    • SystemPropertyServerSetupTask

      protected SystemPropertyServerSetupTask(Map<String,String> properties)
      Creates a new setup task which defines the provided properties.
      Parameters:
      properties - the properties to add

  • Method Details

    • setup

      public void setup(ManagementClient managementClient, String containerId) throws Exception
      Description copied from interface: ServerSetupTask
      Execute any necessary setup work that needs to happen before the first deployment to the given container.

      Note on exception handling: If an implementation of this method throws any exception, the implementation can assume the following:

      1. Any subsequent ServerSetupTasks associated with test class will not be executed.
      2. The deployment event that triggered the call to this method will be skipped.
      3. The tearDown method of the instance that threw the exception will not be invoked. Therefore, implementations that throw AssumptionViolatedException, or any other exception, should do so before altering any system state.
      4. The tearDown method for any previously executed ServerSetupTasks associated with test class will be invoked.

      If any other exception is thrown, the ServerSetupTask.tearDown(ManagementClient, String) will be executed, including this implementations tearDown(), re-throwing the original exception. The original exception will have any other exceptions thrown in the tearDown() methods add as suppressed messages.

      Specified by:
      setup in interface ServerSetupTask
      Parameters:
      managementClient - management client to use to interact with the container
      containerId - id of the container to which the deployment will be deployed
      Throws:
      Exception - if a failure occurs

    • tearDown

      public void tearDown(ManagementClient managementClient, String containerId) throws Exception
      Description copied from interface: ServerSetupTask
      Execute any tear down work that needs to happen after the last deployment associated with the given container has been undeployed.
      Specified by:
      tearDown in interface ServerSetupTask
      Parameters:
      managementClient - management client to use to interact with the container
      containerId - id of the container to which the deployment will be deployed
      Throws:
      Exception - if a failure occurs