Package | Description |
---|---|
org.fax4j.common |
Contains common internal classes used by the fax4j library.
|
org.fax4j.spi.http |
Provides the HTTP based fax client SPI implementation.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractService
This class provides partial implementation of the service interface.
|
Modifier and Type | Method and Description |
---|---|
static Service |
ServiceFactory.createService(Enum<?> classNameKey,
String defaultClassName,
ConfigurationHolder configurationHolder,
String propertyPart)
This function creates, initializes and returns new service objects.
|
static Service |
ServiceFactory.createService(String classNameKey,
String defaultClassName,
ConfigurationHolder configurationHolder,
String propertyPart)
This function creates, initializes and returns new service objects.
|
Modifier and Type | Interface and Description |
---|---|
interface |
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.
|
interface |
HTTPResponseHandler
This interface defines the HTTP response handler which is used to update the fax job based on the HTTP response data.
|
Modifier and Type | Class and Description | ||
---|---|---|---|
class |
AbstractFaxJob2HTTPRequestConverter
This class provides partial implementation of the fax job to HTTP request converter interface.
|
||
class |
AbstractHTTPResponseHandler
This class provides partial implementation of the HTTP response handler interface.
|
||
class |
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. |
||
class |
EmptyHTTPResponseHandler
This class provides empty implementation of the HTTP response handler interface.
|
||
class |
JSONHTTPResponseHandler
This class provides a JSON based implementation of the HTTP response handler interface.
This class expects to get JSON response data and will update the fax job as needed. This class only supports extracting the fax job ID and fax job status from the JSON response object, or in case of errors, extract the error message. |
||
class |
MultiPartFaxJob2HTTPRequestConverter
This class implements the fax job to HTTP request converter interface.
This class will construct a multi part HTTP requests. The parameter names are set in the fax4j configuration and their values are extracted from the fax job. |
||
class |
TemplateFaxJob2HTTPRequestConverter
This class implements the fax job to HTTP request converter interface.
This class will use request templates to construct the HTTP requests. Only the HTTP resource, URL parameters and HTTP content accept template parameters. The HTTP resource is the URL part after the domain, for example http://www.mydomain.com/myresource. The HTTP URL parameters is the URL part after the ?, for example http://www.mydomain.com/myresource?param1=value1. The HTTP content is not part of the URL and contains the POST information. The template parameters are than updated with the values from the fax4j configuration or FaxJob data. All template parameters are defined as ${templatename} variables, for example: http://www.mydomain.com/myresource?faxnum=${target.address} Below table describes the template parameters. Template Parameters:
Copyright © 2009–2020 fax4j. All rights reserved. |