by.stub.client

Class StubbyClient

java.lang.Object

by.stub.client.StubbyClient

public final class StubbyClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
StubbyClient()

Method Summary

Modifier and Type	Method and Description
StubbyResponse	doDelete(java.lang.String host, java.lang.String uri, int stubsPort, Authorization authorization) Makes DELETE HTTP request to stubby Also can set basic authorisation HTTP header using encoded credentials (if provided).
StubbyResponse	doDeleteOverSsl(java.lang.String host, java.lang.String uri, int port, Authorization authorization) Makes DELETE HTTP request to stubby over TLS on stubby4j default TLS port: 7443 Also can set basic authorisation HTTP header using encoded credentials (if provided).
StubbyResponse	doGet(java.lang.String host, java.lang.String uri, int stubsPort) Makes GET HTTP request to stubby
StubbyResponse	doGet(java.lang.String host, java.lang.String uri, int stubsPort, Authorization authorization) Makes GET HTTP request to stubby Also sets basic authorisation HTTP header using provided encoded credentials.
StubbyResponse	doGetOverSsl(java.lang.String host, java.lang.String uri) Makes GET HTTP request to stubby over TLS on stubby4j default TLS port: 7443
StubbyResponse	doGetOverSsl(java.lang.String host, java.lang.String uri, int port) Makes GET HTTP request to stubby over TLS on stubby4j
StubbyResponse	doGetOverSsl(java.lang.String host, java.lang.String uri, int port, Authorization authorization) Makes GET HTTP request to stubby over TLS on stubby4j default TLS port: 7443 Also sets basic authorisation HTTP header using provided encoded credentials.
StubbyResponse	doGetUsingDefaults(java.lang.String uri) Makes GET HTTP request to stubby running on default host and port - localhost:8882
StubbyResponse	doGetUsingDefaults(java.lang.String uri, Authorization authorization) Makes GET HTTP request to stubby running on default host and port - localhost:8882.
StubbyResponse	doPost(java.lang.String host, java.lang.String uri, int stubsPort, Authorization authorization, java.lang.String payload) Makes POST HTTP request to stubby Also sets basic authorisation HTTP header using provided encoded credentials.
StubbyResponse	doPost(java.lang.String host, java.lang.String uri, int stubsPort, java.lang.String payload) Makes POST HTTP request to stubby
StubbyResponse	doPostUsingDefaults(java.lang.String uri, java.lang.String payload) Makes POST HTTP request to stubby running on default host and port - localhost:8882
StubbyResponse	doPostUsingDefaults(java.lang.String uri, java.lang.String payload, Authorization authorization) Makes POST HTTP request to stubby running on default host and port - localhost:8882.
StubbyResponse	doPut(java.lang.String host, java.lang.String uri, int stubsPort, Authorization authorization, java.lang.String payload) Makes PUT HTTP request to stubby Also can set basic authorisation HTTP header using encoded credentials (if provided).
StubbyResponse	doPutOverSsl(java.lang.String host, java.lang.String uri, int stubsPort, Authorization authorization, java.lang.String payload) Makes PUT HTTP request to stubby over TLS on stubby4j default TLS port: 7443 Also can set basic authorisation HTTP header using encoded credentials (if provided).
void	joinJetty() Blocks until Jetty has finished
StubbyResponse	makeRequest(java.lang.String scheme, java.lang.String method, java.lang.String host, java.lang.String uri, int port, java.lang.String post) Makes HTTP request to stubby.
StubbyResponse	makeRequest(java.lang.String scheme, java.lang.String method, java.lang.String host, java.lang.String uri, int port, java.lang.String post, Authorization authorization) Makes HTTP request to stubby.
void	startJetty(int stubsPort, int tlsPort, int adminPort, java.lang.String yamlConfigurationFilename) Starts stubby using given Stubs, TlsStubs and Admin portals ports on localhost.
void	startJetty(int stubsPort, int tlsPort, int adminPort, java.lang.String addressToBind, java.lang.String yamlConfigurationFilename) Starts stubby using given Stubs, TlsStubs, Admin portals ports and host address.
void	startJetty(int stubsPort, int adminPort, java.lang.String yamlConfigurationFilename) Starts stubby using default port of TlsStubs (7443), and given Stubs and Admin portals ports on localhost.
void	startJetty(int stubsPort, int adminPort, java.lang.String addressToBind, java.lang.String yamlConfigurationFilename) Starts stubby using default port of TlsStubs (7443), and given Stubs and Admin portals ports on a given host address.
void	startJetty(int stubsPort, java.lang.String yamlConfigurationFilename) Starts stubby using default ports of Admin (8889) and TlsStubs portals (7443), and given Stubs portal port on localhost.
void	startJetty(java.lang.String yamlConfigurationFilename) Starts stubby using default ports of Stubs (8882), Admin (8889) and TlsStubs portals (7443) on localhost.
void	startJettyYamless(int stubsPort, int tlsPort, int adminPort, java.lang.String addressToBind) Starts stubby using given Stubs, TlsStubs, Admin portals ports and host address without YAML configuration file.
void	stopJetty() Stops Jetty if it is up
StubbyResponse	updateStubbedData(java.lang.String url, java.lang.String stubsData) Updated stubbed data with new data.

Methods inherited from class java.lang.Object

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

Constructor Detail

StubbyClient

public StubbyClient()

Method Detail

startJetty

public void startJetty(java.lang.String yamlConfigurationFilename)
                throws java.lang.Exception

Starts stubby using default ports of Stubs (8882), Admin (8889) and TlsStubs portals (7443) on localhost.

Parameters:

yamlConfigurationFilename - an absolute or relative file path for YAML stubs configuration file

Throws:

java.lang.Exception

startJetty

public void startJetty(int stubsPort,
                       java.lang.String yamlConfigurationFilename)
                throws java.lang.Exception

Starts stubby using default ports of Admin (8889) and TlsStubs portals (7443), and given Stubs portal port on localhost.

Parameters:

stubsPort - Stubs portal port

yamlConfigurationFilename - an absolute or relative file path for YAML stubs configuration file

Throws:

java.lang.Exception

startJetty

public void startJetty(int stubsPort,
                       int adminPort,
                       java.lang.String yamlConfigurationFilename)
                throws java.lang.Exception

Starts stubby using default port of TlsStubs (7443), and given Stubs and Admin portals ports on localhost.

Parameters:

stubsPort - Stubs portal port

adminPort - Admin portal port

yamlConfigurationFilename - an absolute or relative file path for YAML stubs configuration file

Throws:

java.lang.Exception

startJetty

public void startJetty(int stubsPort,
                       int tlsPort,
                       int adminPort,
                       java.lang.String yamlConfigurationFilename)
                throws java.lang.Exception

Starts stubby using given Stubs, TlsStubs and Admin portals ports on localhost.

Parameters:

stubsPort - Stubs portal port

tlsPort - TLS Stubs portal port

adminPort - Admin portal port

yamlConfigurationFilename - an absolute or relative file path for YAML stubs configuration file

Throws:

java.lang.Exception

startJetty

public void startJetty(int stubsPort,
                       int adminPort,
                       java.lang.String addressToBind,
                       java.lang.String yamlConfigurationFilename)
                throws java.lang.Exception

Starts stubby using default port of TlsStubs (7443), and given Stubs and Admin portals ports on a given host address.

Parameters:

stubsPort - Stubs portal port

adminPort - Admin portal port

addressToBind - Address to bind Jetty

yamlConfigurationFilename - an absolute or relative file path for YAML stubs configuration file

Throws:

java.lang.Exception

startJetty

public void startJetty(int stubsPort,
                       int tlsPort,
                       int adminPort,
                       java.lang.String addressToBind,
                       java.lang.String yamlConfigurationFilename)
                throws java.lang.Exception

Starts stubby using given Stubs, TlsStubs, Admin portals ports and host address.

Parameters:

stubsPort - Stubs portal port

tlsPort - TLS Stubs portal port

adminPort - Admin portal port

addressToBind - Address to bind Jetty

yamlConfigurationFilename - an absolute or relative file path for YAML stubs configuration file.

Throws:

java.lang.Exception

startJettyYamless

public void startJettyYamless(int stubsPort,
                              int tlsPort,
                              int adminPort,
                              java.lang.String addressToBind)
                       throws java.lang.Exception

Starts stubby using given Stubs, TlsStubs, Admin portals ports and host address without YAML configuration file.

Parameters:

stubsPort - Stubs portal port

tlsPort - TLS Stubs portal port

adminPort - Admin portal port

addressToBind - Address to bind Jetty

Throws:

java.lang.Exception

stopJetty

public void stopJetty()
               throws java.lang.Exception

Stops Jetty if it is up

Throws:

java.lang.Exception

joinJetty

public void joinJetty()
               throws java.lang.Exception

Blocks until Jetty has finished

Throws:

java.lang.Exception

doGet

public StubbyResponse doGet(java.lang.String host,
                            java.lang.String uri,
                            int stubsPort)
                     throws java.lang.Exception

Makes GET HTTP request to stubby

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

stubsPort - port that stubby4j Stubs is running on

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doGetOverSsl

public StubbyResponse doGetOverSsl(java.lang.String host,
                                   java.lang.String uri)
                            throws java.lang.Exception

Makes GET HTTP request to stubby over TLS on stubby4j default TLS port: 7443

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doGetOverSsl

public StubbyResponse doGetOverSsl(java.lang.String host,
                                   java.lang.String uri,
                                   int port)
                            throws java.lang.Exception

Makes GET HTTP request to stubby over TLS on stubby4j

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

port - TLS port

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doGetOverSsl

public StubbyResponse doGetOverSsl(java.lang.String host,
                                   java.lang.String uri,
                                   int port,
                                   Authorization authorization)
                            throws java.lang.Exception

Makes GET HTTP request to stubby over TLS on stubby4j default TLS port: 7443 Also sets basic authorisation HTTP header using provided encoded credentials. The credentials should be base-64 encoded using the following format - username:password

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

port - TLS port

authorization - Authorization object holding the HTTP header authorization type and value

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doGet

public StubbyResponse doGet(java.lang.String host,
                            java.lang.String uri,
                            int stubsPort,
                            Authorization authorization)
                     throws java.lang.Exception

Makes GET HTTP request to stubby Also sets basic authorisation HTTP header using provided encoded credentials. The credentials should be base-64 encoded using the following format - username:password

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

stubsPort - port that stubby4j Stubs is running on

authorization - Authorization object holding the HTTP header authorization type and value

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doGetUsingDefaults

public StubbyResponse doGetUsingDefaults(java.lang.String uri)
                                  throws java.lang.Exception

Makes GET HTTP request to stubby running on default host and port - localhost:8882

Parameters:

uri - URI for the HTTP request

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doGetUsingDefaults

public StubbyResponse doGetUsingDefaults(java.lang.String uri,
                                         Authorization authorization)
                                  throws java.lang.Exception

Makes GET HTTP request to stubby running on default host and port - localhost:8882. Also sets basic authorisation HTTP header using provided encoded credentials. The credentials should be base-64 encoded using the following format - username:password

Parameters:

uri - URI for the HTTP request

authorization - Authorization object holding the HTTP header authorization type and value

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doPost

public StubbyResponse doPost(java.lang.String host,
                             java.lang.String uri,
                             int stubsPort,
                             java.lang.String payload)
                      throws java.lang.Exception

Makes POST HTTP request to stubby

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

stubsPort - port that stubby4j Stubs is running on

payload - data to POST to the server

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doPost

public StubbyResponse doPost(java.lang.String host,
                             java.lang.String uri,
                             int stubsPort,
                             Authorization authorization,
                             java.lang.String payload)
                      throws java.lang.Exception

Makes POST HTTP request to stubby Also sets basic authorisation HTTP header using provided encoded credentials. The credentials should be base-64 encoded using the following format - username:password

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

stubsPort - port that stubby4j Stubs is running on

authorization - Authorization object holding the HTTP header authorization type and value

payload - data to POST to the server

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doPostUsingDefaults

public StubbyResponse doPostUsingDefaults(java.lang.String uri,
                                          java.lang.String payload)
                                   throws java.lang.Exception

Makes POST HTTP request to stubby running on default host and port - localhost:8882

Parameters:

uri - URI for the HTTP request

payload - data to POST to the server

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doPostUsingDefaults

public StubbyResponse doPostUsingDefaults(java.lang.String uri,
                                          java.lang.String payload,
                                          Authorization authorization)
                                   throws java.lang.Exception

Makes POST HTTP request to stubby running on default host and port - localhost:8882. Also sets basic authorisation HTTP header using provided encoded credentials. The credentials should be base-64 encoded using the following format - username:password

Parameters:

uri - URI for the HTTP request

payload - data to POST to the server

authorization - Authorization object holding the HTTP header authorization type and value

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doPut

public StubbyResponse doPut(java.lang.String host,
                            java.lang.String uri,
                            int stubsPort,
                            Authorization authorization,
                            java.lang.String payload)
                     throws java.lang.Exception

Makes PUT HTTP request to stubby Also can set basic authorisation HTTP header using encoded credentials (if provided). The credentials should be base-64 encoded using the following format - username:password

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

stubsPort - port that stubby4j Stubs is running on

authorization - Authorization object holding the HTTP header authorization type and value (can be null)

payload - data to PUT to the server

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doPutOverSsl

public StubbyResponse doPutOverSsl(java.lang.String host,
                                   java.lang.String uri,
                                   int stubsPort,
                                   Authorization authorization,
                                   java.lang.String payload)
                            throws java.lang.Exception

Makes PUT HTTP request to stubby over TLS on stubby4j default TLS port: 7443 Also can set basic authorisation HTTP header using encoded credentials (if provided). The credentials should be base-64 encoded using the following format - username:password

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

stubsPort - port that stubby4j Stubs is running on

authorization - Authorization object holding the HTTP header authorization type and value (can be null)

payload - data to PUT to the server

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doDelete

public StubbyResponse doDelete(java.lang.String host,
                               java.lang.String uri,
                               int stubsPort,
                               Authorization authorization)
                        throws java.lang.Exception

Makes DELETE HTTP request to stubby Also can set basic authorisation HTTP header using encoded credentials (if provided). The credentials should be base-64 encoded using the following format - username:password

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

stubsPort - port that stubby4j Stubs is running on

authorization - Authorization object holding the HTTP header authorization type and value (can be null)

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

doDeleteOverSsl

public StubbyResponse doDeleteOverSsl(java.lang.String host,
                                      java.lang.String uri,
                                      int port,
                                      Authorization authorization)
                               throws java.lang.Exception

Makes DELETE HTTP request to stubby over TLS on stubby4j default TLS port: 7443 Also can set basic authorisation HTTP header using encoded credentials (if provided). The credentials should be base-64 encoded using the following format - username:password

Parameters:

host - host that stubby4j is running on

uri - URI for the HTTP request

port - TLS port

authorization - Authorization object holding the HTTP header authorization type and value

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

updateStubbedData

public StubbyResponse updateStubbedData(java.lang.String url,
                                        java.lang.String stubsData)
                                 throws java.lang.Exception

Updated stubbed data with new data. This method creates a POST request to Admin portal

Parameters:

url - fully constructed URL which included HTTP scheme, host and port

stubsData - data to post

Throws:

java.lang.Exception

makeRequest

public StubbyResponse makeRequest(java.lang.String scheme,
                                  java.lang.String method,
                                  java.lang.String host,
                                  java.lang.String uri,
                                  int port,
                                  java.lang.String post)
                           throws java.lang.Exception

Makes HTTP request to stubby.

Parameters:

scheme - HTTP protocol scheme, HTTP or HTTPS

method - HTTP method, currently supported: GET, HEAD, PUT, POST

host - host that stubby4j is running on

uri - URI for the HTTP request

port - port that stubby4j Stubs is running on

post - data to POST to the server

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception

makeRequest

public StubbyResponse makeRequest(java.lang.String scheme,
                                  java.lang.String method,
                                  java.lang.String host,
                                  java.lang.String uri,
                                  int port,
                                  java.lang.String post,
                                  Authorization authorization)
                           throws java.lang.Exception

Makes HTTP request to stubby.

Parameters:

scheme - HTTP protocol scheme, HTTP or HTTPS

method - HTTP method, currently supported: GET, HEAD, PUT, POST

host - host that stubby4j is running on

uri - URI for the HTTP request

port - port that stubby4j Stubs is running on

post - data to POST to the server

authorization - Authorization object holding the HTTP header authorization type and value

Returns:

StubbyResponse with HTTP status code and message from the server

Throws:

java.lang.Exception