Interface | Description |
---|---|
FaxJob2HTTPRequestConverter |
The fax job to HTTP request converter interface enables to convert fax jobs to HTTP requests which will be submitted
to invoke the fax action remotly.
|
HTTPClient |
This interface defines the HTTP client used to submit HTTP requests.
|
HTTPClientConfiguration |
This interface holds the HTTP client configuration.
Each HTTP client will have different configuration requirements and therefore this interface is just a flagging interface. |
HTTPResponseHandler |
This interface defines the HTTP response handler which is used to update the fax job based on the HTTP response data.
|
Class | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AbstractFaxJob2HTTPRequestConverter |
This class provides partial implementation of the fax job to HTTP request converter interface.
|
||||||||||||||||||||||||||||||||||
AbstractHTTPClient |
This abstract HTTP client provides partial implementation for common functionality.
|
||||||||||||||||||||||||||||||||||
AbstractHTTPResponseHandler |
This class provides partial implementation of the HTTP response handler interface.
|
||||||||||||||||||||||||||||||||||
AbstractMappingHTTPResponseHandler<T> |
This class provides an abstract mapping based implementation of the HTTP response handler interface.
This class expects to get a data object and will update the fax job as needed. This class only supports extracting the fax job ID and fax job status from the response object, or in case of errors, extract the error message. |
||||||||||||||||||||||||||||||||||
AbstractMultiPart2JSONHTTPFaxClientSpi |
This class provides common base for HTTP based SPIs which submit multi part HTTP request and expect a JSON output.
|
||||||||||||||||||||||||||||||||||
ApacheHTTPClient |
This HTTP client is based on the Apache HTTP client and is used to submit HTTP requests.
|
||||||||||||||||||||||||||||||||||
CommonHTTPClientConfiguration |
This is the common HTTP client configuration.
|
||||||||||||||||||||||||||||||||||
EmptyHTTPResponseHandler |
This class provides empty implementation of the HTTP response handler interface.
|
||||||||||||||||||||||||||||||||||
HTTPFaxClientSpi |
This class implements the fax client service provider interface. This implementation will invoke the requests by sending HTTP requests to a web server that supports sending fax messages. The configuration of the fax4j framework is made up of 3 layers. The configuration is based on simple properties. Each layer overrides the lower layers by adding/changing the property values. The first layer is the internal fax4j.properties file located in the fax4j jar. This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers. The second layer is the external fax4j.properties file that is located on the classpath. This file is optional and provides the ability to override the internal configuration for the entire fax4j framework. The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client. These properties enable to override the configuration of the lower 2 layers. SPI Status (Draft, Beta, Stable): Stable Below table describes the configuration values relevant for this class. Configuration:
|