com.github.noraui.data.rest

Class RestDataProvider

java.lang.Object

com.github.noraui.data.CommonDataProvider

com.github.noraui.data.rest.RestDataProvider

All Implemented Interfaces:

DataInputProvider, DataOutputProvider, DataProvider

public class RestDataProvider
extends CommonDataProvider
implements DataInputProvider, DataOutputProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestDataProvider.types

Nested classes/interfaces inherited from class com.github.noraui.data.CommonDataProvider

CommonDataProvider.ResultColumnNames

Nested classes/interfaces inherited from interface com.github.noraui.data.DataProvider

DataProvider.type

Field Summary

Fields inherited from class com.github.noraui.data.CommonDataProvider

columns, dataInPath, dataOutPath, indexData, resultColumnName, scenarioName

Constructor Summary

Constructors

Constructor and Description
RestDataProvider(String type, String host, String port) Constructor of REST DataProvider.

Method Summary

Modifier and Type	Method and Description
int	getNbLines() Gets the number of readable lines of current opened file.
void	prepare(String scenario)
String[]	readLine(int line, boolean readResult)
String	readValue(String column, int line) Reads a cell of opened input file.
protected void	setHttpService(HttpService httpService) HttpService setter for mock
protected void	writeValue(String column, int line, String value) Defines how to write values.

Methods inherited from class com.github.noraui.data.CommonDataProvider

getIndexData, getModel, getNbGherkinExample, getResultColumnName, isResultColumnNameAuthorized, setDataInPath, setDataOutPath, setIndexData, writeDataResult, writeFailedResult, writeSuccessResult, writeWarningResult

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.noraui.data.DataOutputProvider

writeDataResult, writeFailedResult, writeSuccessResult, writeWarningResult

Methods inherited from interface com.github.noraui.data.DataProvider

getIndexData, getModel, getNbGherkinExample, getResultColumnName, isResultColumnNameAuthorized, setDataInPath, setDataOutPath, setIndexData

Constructor Detail

RestDataProvider

public RestDataProvider(String type,
                        String host,
                        String port)
                 throws WebServicesException

Constructor of REST DataProvider.

Parameters:

type - (JSON or XML).

host - is host of REST Web Services.

port - is port of REST Web Services.

Throws:

WebServicesException - if technical Exception occurred but for a Web Services.

Method Detail

prepare

public void prepare(String scenario)
             throws TechnicalException

Specified by:

prepare in interface DataProvider

Throws:

TechnicalException

getNbLines

public int getNbLines()

Gets the number of readable lines of current opened file. If a line does not contain 'ID' column of if it is empty, then the line is not taken into account.

Specified by:

getNbLines in interface DataInputProvider

Returns:

number of opened input file

readValue

public String readValue(String column,
                        int line)

Reads a cell of opened input file.

Specified by:

readValue in interface DataInputProvider

Parameters:

column - index of the column to read

line - index of the line to read

Returns:

a String with the value of cell

readLine

public String[] readLine(int line,
                         boolean readResult)

Specified by:

readLine in interface DataInputProvider

Parameters:

line - id of the line to read (line=0 for reading headers ; line=1 for reading 1st line, ...)

readResult - true if result must be returned, false otherwise

Returns:

all content of read line split by cell in a String array

writeValue

protected void writeValue(String column,
                          int line,
                          String value)

Defines how to write values. This method is a stub and must be overridden by children classes.

Overrides:

writeValue in class CommonDataProvider

Parameters:

column - The column name

line - The line number

value - The value to write

setHttpService

protected void setHttpService(HttpService httpService)

HttpService setter for mock

Parameters:

httpService - The HTTP Service