Uses of Class
org.fax4j.spi.http.HTTPFaxClientSpi

Packages that use HTTPFaxClientSpi

Package	Description
org.fax4j.spi.hoiio	Provides the hoiio based fax client SPI implementation.
org.fax4j.spi.http	Provides the HTTP based fax client SPI implementation.
org.fax4j.spi.phaxio	Provides the phaxio based fax client SPI implementation.

Uses of HTTPFaxClientSpi in org.fax4j.spi.hoiio

Subclasses of HTTPFaxClientSpi in org.fax4j.spi.hoiio

Modifier and Type

Class and Description

class

HoiioFaxClientSpi This class implements the fax client service provider interface. This implementation will invoke the requests by sending HTTP requests to a Hoiio service. This implementation is not meant to promote the Hoiio commercial product but to serve as a service provider interface for those using this product. 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: Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.hoiio.client.class.name The HTTP client class name used to submit the HTTP requests org.fax4j.spi.http.ApacheHTTPClient org.fax4j.spi.http.ApacheHTTPClient false org.fax4j.spi.hoiio.app.id The hoiio Application ID none none true org.fax4j.spi.hoiio.access.token The hoiio access token none none true Dependencies: HTTP client required jars. Uses of HTTPFaxClientSpi in org.fax4j.spi.http Subclasses of HTTPFaxClientSpi in org.fax4j.spi.http Modifier and Type Class and Description class AbstractMultiPart2JSONHTTPFaxClientSpi This class provides common base for HTTP based SPIs which submit multi part HTTP request and expect a JSON output. Methods in org.fax4j.spi.http with parameters of type HTTPFaxClientSpi Modifier and Type Method and Description protected void MultiPartFaxJob2HTTPRequestConverter.addAdditionalContentParts(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, FaxJob faxJob, List<HTTPRequest.ContentPart<?>> contentList) This function enables extending classes to add additional content parts. protected HTTPRequest MultiPartFaxJob2HTTPRequestConverter.createCommonHTTPRequest(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType) Creates a HTTP request with the common data. protected HTTPRequest TemplateFaxJob2HTTPRequestConverter.createHTTPRequest(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, Enum<?> templateNameEnum, FaxJob faxJob) Creates the HTTP request from the fax job data. HTTPRequest FaxJob2HTTPRequestConverter.createHTTPRequest(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, FaxJob faxJob) Creates the HTTP request from the fax job data. HTTPRequest MultiPartFaxJob2HTTPRequestConverter.createHTTPRequest(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, FaxJob faxJob) Creates the HTTP request from the fax job data. HTTPRequest TemplateFaxJob2HTTPRequestConverter.createHTTPRequest(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, FaxJob faxJob) Creates the HTTP request from the fax job data. protected String TemplateFaxJob2HTTPRequestConverter.formatHTTPResource(HTTPFaxClientSpi faxClientSpi, FaxActionType faxActionType, FaxJob faxJob) This function formats the HTTP resource. protected String TemplateFaxJob2HTTPRequestConverter.formatHTTPURLParameters(HTTPFaxClientSpi faxClientSpi, FaxJob faxJob) This function formats the HTTP URL parameters. Uses of HTTPFaxClientSpi in org.fax4j.spi.phaxio Subclasses of HTTPFaxClientSpi in org.fax4j.spi.phaxio Modifier and Type Class and Description class PhaxioFaxClientSpi This class implements the fax client service provider interface. This implementation will invoke the requests by sending HTTP requests to a Phaxio service. This implementation is not meant to promote the Phaxio commercial product but to serve as a service provider interface for those using this product. 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: Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.phaxio.client.class.name The HTTP client class name used to submit the HTTP requests org.fax4j.spi.http.ApacheHTTPClient org.fax4j.spi.http.ApacheHTTPClient false org.fax4j.spi.phaxio.api.key The phaxio API key none none true org.fax4j.spi.phaxio.api.secret The phaxio API secret none none true Dependencies: HTTP client required jars. Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Next Frames No Frames All Classes Copyright © 2009–2020 fax4j. All rights reserved.