Package de.xima.fc.e2e.common

Class ServerTestSetupParams

java.lang.Object

de.xima.fc.e2e.common.ServerTestSetupParams

All Implemented Interfaces:

Serializable

public final class ServerTestSetupParams
extends Object
implements Serializable

Parameters for the ITestSetupAction.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ServerTestSetupParams(ETestCaseSetupMethod setupMethod, URI setupRoot, String contextUrl, String contextPath, Map<String,Serializable> params, MailServerSettings mailServerSettings)	Creates a new params instance with the given data.

Method Summary

Modifier and Type	Method	Description
String	getBaseUrl()
String	getContextPath()
MailServerSettings	getMailServerSettings()
Boolean	getParamBoolean(String name)
boolean	getParamBoolean(String name, boolean defaultValue)
Long	getParamLong(String name)
Map<String,Serializable>	getParams()
String	getParamString(String name)
ETestCaseSetupMethod	getSetupMethod()
URI	getSetupRoot()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerTestSetupParams

public ServerTestSetupParams(ETestCaseSetupMethod setupMethod,
                             URI setupRoot,
                             String contextUrl,
                             String contextPath,
                             Map<String,Serializable> params,
                             MailServerSettings mailServerSettings)

Creates a new params instance with the given data.

Parameters:

setupMethod - How to interpret the content of the getSetupRoot().

setupRoot - The absolute path to the setup directory or file for the setup method.

contextUrl - The base URL to the FC server (including the host etc.) For example http://localhost:8080/xima-formcycle.

contextPath - Context path of the FC server (the beginning of the URI path, without the host etc.). For example xima-formcycle.

params - A map with custom parameters for the test setup method.

mailServerSettings - Settings for the client mail server.

Method Detail

getBaseUrl

public String getBaseUrl()

Returns:

The base URL to the FC server (including the host etc.) For example http://localhost:8080/xima-formcycle.

getContextPath

public String getContextPath()

Returns:

Context path of the FC server (the beginning of the URI path, without the host etc.). For example xima-formcycle.

getMailServerSettings

public MailServerSettings getMailServerSettings()

Returns:

Settings for the client mail server.

getParams

public Map<String,Serializable> getParams()

Returns:

A map with custom parameters.

getParamLong

public Long getParamLong(String name)

Parameters:

name - Name of the parameter to retrieve.

Returns:

The custom parameter with the given name, as a long.

getParamBoolean

public Boolean getParamBoolean(String name)

Parameters:

name - Name of the parameter to retrieve.

Returns:

The custom parameter with the given name, as a boolean.

getParamBoolean

public boolean getParamBoolean(String name,
                               boolean defaultValue)

Parameters:

name - Name of the parameter to retrieve.

defaultValue - Default value to return when no parameter with the given name exists.

Returns:

The custom parameter with the given name, as a boolean.

getParamString

public String getParamString(String name)

Parameters:

name - Name of the parameter to retrieve.

Returns:

The custom parameter with the given name, as a string.

getSetupMethod

public ETestCaseSetupMethod getSetupMethod()

Returns:

How to interpret the content of the getSetupRoot().

getSetupRoot

public URI getSetupRoot()

Returns:

The absolute path to the setup directory or file for the setup method.