ApiWebServiceClient (qtest-sdk-java 1.4.10 API)

java.lang.Object
- org.qas.api.ApiWebServiceClient<T>

Direct Known Subclasses:: QTestApiWebServiceClient

public abstract class ApiWebServiceClient<T extends ApiWebServiceClient<T>>
extends java.lang.Object

ApiWebServiceClient

Since:: 1.0

Field Summary

Fields
Modifier and Type	Field and Description
`protected HttpAuthClient`	`client` Low level client for sending request to services.
`protected ClientConfiguration`	`configuration` The client configuration.
`protected java.net.URI`	`endpoint` the service endpoint to which this client will send request.
`protected java.util.List<RequestHandler>`	`requestHandlers` Optional request handlers for additional request processing.
`protected int`	`timeOffset` Optional offset (in seconds) to use when signing request.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ApiWebServiceClient(ClientConfiguration configuration)
Constructs a ApiWebServiceClient object using the specified configuration.

Constructors
Modifier	Constructor and Description
`protected`	`ApiWebServiceClient(ClientConfiguration configuration)` Constructs a ApiWebServiceClient object using the specified configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRequestHandler(RequestHandler requestHandler)` Appends a request handler to the list of registered handlers that are run as part of a request's lifecycle.
`protected ExecutionContext`	`createExecutionContext()`
`protected HttpAuthClient`	`createHttpAuthClient(ClientConfiguration configuration)`
`int`	`getTimeOffset()`
`ApiWebServiceClient<T>`	`removeRequestHandler(RequestHandler requestHandler)` Removes the request handler from the list of registered handlers and returns the updated client object.
`void`	`setConfiguration(ClientConfiguration configuration)` Sets the client configuration.
`void`	`setEndpoint(java.lang.String endpoint)` Overrides the default endpoint for this client.
`void`	`setTimeOffset(int timeOffset)` Sets the optional value for time offset for this client.
`void`	`shutdown()` Shutdown this client object, release any resources that might be held open.
`ApiWebServiceClient<T>`	`withConfiguration(ClientConfiguration configuration)` Sets the client configuration and returns the updated client object.
`ApiWebServiceClient<T>`	`withRequestHandler(RequestHandler requestHandler)` Appends a request handler to the list of registered handlers that are run as part of a request's lifecycle and return the updated client object.
`ApiWebServiceClient<T>`	`withTimeOffset(int timeOffset)` Sets the optional value for time offset for this client.

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

- Field Detail
  - endpoint
```
protected java.net.URI endpoint
```
    the service endpoint to which this client will send request.
  - configuration
```
protected ClientConfiguration configuration
```
    The client configuration.
  - client
```
protected HttpAuthClient client
```
    Low level client for sending request to services.
  - requestHandlers
```
protected final java.util.List<RequestHandler> requestHandlers
```
    Optional request handlers for additional request processing.
  - timeOffset
```
protected int timeOffset
```
    Optional offset (in seconds) to use when signing request.
- Constructor Detail
  - ApiWebServiceClient
```
protected ApiWebServiceClient(ClientConfiguration configuration)
```
    Constructs a ApiWebServiceClient object using the specified configuration.
    
    Parameters:
    
    configuration - the client configuration for this client.
- Method Detail
  - setEndpoint
```
public void setEndpoint(java.lang.String endpoint)
                 throws java.lang.IllegalArgumentException
```
    Overrides the default endpoint for this client.
    
    Parameters:
    
    endpoint - The endpoint or a full URL, including the protocol of specified endpoint this client will communicate with.
    
    Throws:
    
    java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.
  - setConfiguration
```
public void setConfiguration(ClientConfiguration configuration)
```
    Sets the client configuration.
    
    Parameters:
    
    configuration - the client configuration to set.
  - withConfiguration
```
public ApiWebServiceClient<T> withConfiguration(ClientConfiguration configuration)
```
    Sets the client configuration and returns the updated client object.
    
    Parameters:
    
    configuration - the client configuration to set.
    
    Returns:
    
    the updated client object with new client configuration object.
  - shutdown
```
public void shutdown()
```
    Shutdown this client object, release any resources that might be held open.
  - addRequestHandler
```
public void addRequestHandler(RequestHandler requestHandler)
```
    Appends a request handler to the list of registered handlers that are run as part of a request's lifecycle.
    
    Parameters:
    
    requestHandler - The new handler to add to the current list of request handlers.
  - withRequestHandler
```
public ApiWebServiceClient<T> withRequestHandler(RequestHandler requestHandler)
```
    Appends a request handler to the list of registered handlers that are run as part of a request's lifecycle and return the updated client object.
    
    Parameters:
    
    requestHandler - The new handler to add to the current list of request handlers.
    
    Returns:
    
    the updated client object.
  - removeRequestHandler
```
public ApiWebServiceClient<T> removeRequestHandler(RequestHandler requestHandler)
```
    Removes the request handler from the list of registered handlers and returns the updated client object.
    
    Parameters:
    
    requestHandler - the handler to remove from the current list of request handlers.
    
    Returns:
    
    the updated client object.
  - setTimeOffset
```
public void setTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this client. This value will be applied to all requests processed through this client.
    
    Parameters:
    
    timeOffset - The optional value for time offset (in seconds) for this client.
  - withTimeOffset
```
public ApiWebServiceClient<T> withTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this client. This value will be applied to all request processed through this client and returns the updated client object.
    
    Parameters:
    
    timeOffset - The optional value of time offset (in seconds) for this client.
    
    Returns:
    
    the updated client object.
  - getTimeOffset
```
public int getTimeOffset()
```
    Returns:
    
    the optional value of time offset for this client.
  - createExecutionContext
```
protected ExecutionContext createExecutionContext()
```
    Returns:
    
    the execution context.
  - createHttpAuthClient
```
protected HttpAuthClient createHttpAuthClient(ClientConfiguration configuration)
```
    Parameters:
    
    configuration - configuration
    
    Returns:
    
    the HttpAuthClient from the given configuration.

Class ApiWebServiceClient<T extends ApiWebServiceClient<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

endpoint

configuration

client

requestHandlers

timeOffset

Constructor Detail

ApiWebServiceClient

Method Detail

setEndpoint

setConfiguration

withConfiguration

shutdown

addRequestHandler

withRequestHandler

removeRequestHandler

setTimeOffset

withTimeOffset

getTimeOffset

createExecutionContext

createHttpAuthClient