DriverConstant.DataServiceConstant (SAFS API DOCUMENT)

java.lang.Object
- org.safs.tools.drivers.DriverConstant.DataServiceConstant

Enclosing class:: DriverConstant

public abstract static class DriverConstant.DataServiceConstant
extends java.lang.Object

Defines the constants used for SAFS Data Service.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_BASE_NAME` 'safsdata' the default relative URI on which the SAFS Data service runs.
`static java.lang.String`	`DEFAULT_HOST` 'localhost' the default host on which the SAFS Data service runs.
`static java.lang.String`	`DEFAULT_ID` "SAFS_DATA_SERVICE" Default service ID.
`static java.lang.String`	`DEFAULT_INTERCEPT_STEP` "false"
`static java.lang.String`	`DEFAULT_PORT` '8080' the default port number on which the SAFS Data service runs.
`static int`	`DEFAULT_PORT_INT` 8080
`static java.lang.String`	`DEFAULT_PROTOCOL` 'http://' the default protocol with which the SAFS Data service runs.
`static java.lang.String`	`DEFAULT_SERVER_URL` 'http://localhost:8080/safsdata' the default server URL on which the SAFS Data service runs.
`static java.lang.String`	`ITEM_BASE_NAME` "base.name" defines the relative URI where the safs data service runs Examples: [SAFS_DATA_SERVICE] base.name=safsdata
`static java.lang.String`	`ITEM_HOST` "host" defines the name of host where the safs data service runs Examples: [SAFS_DATA_SERVICE] host=serverMachineName
`static java.lang.String`	`ITEM_INTERCEPT_STEP` "intercept.step" defines if the test step will be intercepted. If this is set to true, then each test step will be intercepted.
`static java.lang.String`	`ITEM_PORT` "port" defines the port number where the safs data service runs Examples: [SAFS_DATA_SERVICE] port=8080
`static java.lang.String`	`ITEM_PROTOCOL` "protocol" defines the protocol with which the safs data service runs.
`static java.lang.String`	`ITEM_SERVER_URL` "server.url" defines the whole URL of safs data service. If this is defined, then the 'protocol', 'host', 'port' and 'base.name' will not take effect anymore. Examples: [SAFS_DATA_SERVICE] server.url=http://host:8080/safsdata
`static java.lang.String`	`PROPERTY_BASE_NAME` "safs.data.base.name" defines the relative URI where the safs data service runs JVM command line: -Dsafs.data.base.name=relativeURI Examples: -Dsafs.data.base.name=safsdata
`static java.lang.String`	`PROPERTY_HOST` "safs.data.host" defines the name of host where the safs data service runs JVM command line: -Dsafs.data.host=serverMachineName
`static java.lang.String`	`PROPERTY_INTERCEPT_STEP` "safs.data.intercept.step" defines if the test step will be intercepted. If this is set to true, then each test step will be intercepted.
`static java.lang.String`	`PROPERTY_PORT` "safs.data.port" defines the port number where the safs data service runs JVM command line: -Dsafs.data.port=portNumber Examples: -Dsafs.data.port=8080
`static java.lang.String`	`PROPERTY_PROTOCOL` "safs.data.protocol" defines the protocol with which the safs data service runs JVM command line: -Dsafs.data.protocol=http://
`static java.lang.String`	`PROPERTY_SERVER_URL` "safs.data.server.url" defines the whole URL of safs data service If this is defined, then the 'safs.data.protocol', 'safs.data.host', 'safs.data.port' and 'safs.data.base.name' will not take effect anymore. JVM command line: -Dsafs.data.server.url=http://host:port/safsdata As always, "the property setting" has higher priority than configuration file setting. Examples: -Dsafs.data.server.url=http://host:8080/safsdata
`static java.lang.String`	`SECTION_NAME` "SAFS_DATA_SERVICE" Predefined "section" of a Driver Configuration source.

Constructor Summary

Constructors
Constructor and Description

DataServiceConstant()

Constructors
Constructor and Description
`DataServiceConstant()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getServiceURL(ConfigureInterface configInfo)` Try to get 'data service URL' from system property `PROPERTY_SERVER_URL` item `ITEM_SERVER_URL` of section `SECTION_NAME` from configuration.
`static boolean`	`isInterceptStep()` This should be called after calling `readInterceptions(ConfigureInterface)`.
`static void`	`readInterceptions(ConfigureInterface configInfo)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SECTION_NAME
```
public static final java.lang.String SECTION_NAME
```
    "SAFS_DATA_SERVICE"
    Predefined "section" of a Driver Configuration source.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ID
```
public static final java.lang.String DEFAULT_ID
```
    "SAFS_DATA_SERVICE"
    Default service ID. Usually it will be appended with a timestamp to create a unique ID, which is used to start a REST session.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT_INT
```
public static final int DEFAULT_PORT_INT
```
    8080
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HOST
```
public static final java.lang.String DEFAULT_HOST
```
    'localhost' the default host on which the SAFS Data service runs.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final java.lang.String DEFAULT_PORT
```
    '8080' the default port number on which the SAFS Data service runs.
  - DEFAULT_BASE_NAME
```
public static final java.lang.String DEFAULT_BASE_NAME
```
    'safsdata' the default relative URI on which the SAFS Data service runs.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PROTOCOL
```
public static final java.lang.String DEFAULT_PROTOCOL
```
    'http://' the default protocol with which the SAFS Data service runs.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SERVER_URL
```
public static final java.lang.String DEFAULT_SERVER_URL
```
    'http://localhost:8080/safsdata' the default server URL on which the SAFS Data service runs.
  - ITEM_PROTOCOL
```
public static final java.lang.String ITEM_PROTOCOL
```
    "protocol" defines the protocol with which the safs data service runs. It can be "http://" or "https://" etc.
    Examples:
    [SAFS_DATA_SERVICE]
    protocol=http://
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PROTOCOL
```
public static final java.lang.String PROPERTY_PROTOCOL
```
    "safs.data.protocol" defines the protocol with which the safs data service runs
    JVM command line: -Dsafs.data.protocol=http://
    
    See Also:
    
    Constant Field Values
  - ITEM_HOST
```
public static final java.lang.String ITEM_HOST
```
    "host" defines the name of host where the safs data service runs
    Examples:
    [SAFS_DATA_SERVICE]
    host=serverMachineName
    
    See Also:
    
    Constant Field Values
  - PROPERTY_HOST
```
public static final java.lang.String PROPERTY_HOST
```
    "safs.data.host" defines the name of host where the safs data service runs
    JVM command line: -Dsafs.data.host=serverMachineName
    
    See Also:
    
    Constant Field Values
  - ITEM_PORT
```
public static final java.lang.String ITEM_PORT
```
    "port" defines the port number where the safs data service runs
    Examples:
    [SAFS_DATA_SERVICE]
    port=8080
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PORT
```
public static final java.lang.String PROPERTY_PORT
```
    "safs.data.port" defines the port number where the safs data service runs
    JVM command line: -Dsafs.data.port=portNumber
    Examples:
    -Dsafs.data.port=8080
    
    See Also:
    
    Constant Field Values
  - ITEM_BASE_NAME
```
public static final java.lang.String ITEM_BASE_NAME
```
    "base.name" defines the relative URI where the safs data service runs
    Examples:
    [SAFS_DATA_SERVICE]
    base.name=safsdata
    
    See Also:
    
    Constant Field Values
  - PROPERTY_BASE_NAME
```
public static final java.lang.String PROPERTY_BASE_NAME
```
    "safs.data.base.name" defines the relative URI where the safs data service runs
    JVM command line: -Dsafs.data.base.name=relativeURI
    Examples:
    -Dsafs.data.base.name=safsdata
    
    See Also:
    
    Constant Field Values
  - ITEM_SERVER_URL
```
public static final java.lang.String ITEM_SERVER_URL
```
    "server.url" defines the whole URL of safs data service.
    If this is defined, then the 'protocol', 'host', 'port' and 'base.name' will not take effect anymore.
    Examples:
    [SAFS_DATA_SERVICE]
    server.url=http://host:8080/safsdata
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SERVER_URL
```
public static final java.lang.String PROPERTY_SERVER_URL
```
    "safs.data.server.url" defines the whole URL of safs data service
    If this is defined, then the 'safs.data.protocol', 'safs.data.host', 'safs.data.port' and 'safs.data.base.name' will not take effect anymore.
    JVM command line: -Dsafs.data.server.url=http://host:port/safsdata
    As always, "the property setting" has higher priority than configuration file setting.
    Examples:
    -Dsafs.data.server.url=http://host:8080/safsdata
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INTERCEPT_STEP
```
public static final java.lang.String DEFAULT_INTERCEPT_STEP
```
    "false"
    
    See Also:
    
    Constant Field Values
  - ITEM_INTERCEPT_STEP
```
public static final java.lang.String ITEM_INTERCEPT_STEP
```
    "intercept.step" defines if the test step will be intercepted.
    If this is set to true, then each test step will be intercepted. The default is false.
    Examples:
    [SAFS_DATA_SERVICE]
    intercept.step=true|false
    
    See Also:
    
    Constant Field Values
  - PROPERTY_INTERCEPT_STEP
```
public static final java.lang.String PROPERTY_INTERCEPT_STEP
```
    "safs.data.intercept.step" defines if the test step will be intercepted.
    If this is set to true, then each test step will be intercepted. The default is false.
    JVM command line: -Dsafs.data.intercept.step=true|false
    As always, "the property setting" has higher priority than configuration file setting.
    Examples:
    -Dsafs.data.intercept.step=true|false
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataServiceConstant
```
public DataServiceConstant()
```
- Method Detail
  - getServiceURL
```
public static final java.lang.String getServiceURL(ConfigureInterface configInfo)
```
    Try to get 'data service URL' from
    1. system property PROPERTY_SERVER_URL
    2. item ITEM_SERVER_URL of section SECTION_NAME from configuration.
    If not found, then try to get the 'protocol', 'host', 'port' and 'baseName' by
    1. PROPERTY_PROTOCOL, PROPERTY_HOST, PROPERTY_PORT and PROPERTY_BASE_NAME from system property
    2. ITEM_PROTOCOL, ITEM_SERVER_URL, ITEM_HOST, ITEM_PORT from configuration
    and concatenate them into a URL as protocol+host+":"+port+"/"+baseName
    Parameters:
    
    configInfo - ConfigureInterface, the configuration to find ITEM_SERVER_URL, ITEM_HOST, ITEM_PORT etc.
    
    Returns:
    
    String, the SAFS data service URL.
  - readInterceptions
```
public static final void readInterceptions(ConfigureInterface configInfo)
```
  - isInterceptStep
```
public static boolean isInterceptStep()
```
    This should be called after calling readInterceptions(ConfigureInterface).
    
    Returns:
    
    boolean, indicates if the test step will be intercepted.

Class DriverConstant.DataServiceConstant

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SECTION_NAME

DEFAULT_ID

DEFAULT_PORT_INT

DEFAULT_HOST

DEFAULT_PORT

DEFAULT_BASE_NAME

DEFAULT_PROTOCOL

DEFAULT_SERVER_URL

ITEM_PROTOCOL

PROPERTY_PROTOCOL

ITEM_HOST

PROPERTY_HOST

ITEM_PORT

PROPERTY_PORT

ITEM_BASE_NAME

PROPERTY_BASE_NAME

ITEM_SERVER_URL

PROPERTY_SERVER_URL

DEFAULT_INTERCEPT_STEP

ITEM_INTERCEPT_STEP

PROPERTY_INTERCEPT_STEP

Constructor Detail

DataServiceConstant

Method Detail

getServiceURL

readInterceptions

isInterceptStep