Uses of Package
org.fax4j.spi.http

Packages that use org.fax4j.spi.http

Package	Description
org.fax4j.bridge.http	Provides the API classes for a HTTP based web2fax bridge.
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.

Classes in org.fax4j.spi.http used by org.fax4j.bridge.http

Class and Description
HTTPRequest Holds the HTTP request data used to send the fax data to the web server. This class is not thread safe.
HTTPRequest.ContentPart This class holds the content part data.

Classes in org.fax4j.spi.http used by org.fax4j.spi.hoiio

Class and Description
AbstractMultiPart2JSONHTTPFaxClientSpi This class provides common base for HTTP based SPIs which submit multi part HTTP request and expect a JSON output.
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.
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: Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.http.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.http.faxjob2request.converter.class.name The fax job to HTTP request converter class name used to convert the fax job data into the relevant HTTP request. org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter false org.fax4j.spi.http.response.handler.class.name The HTTP response handler class name used to update the fax job data based on the HTTP response. org.fax4j.spi.http.JSONHTTPResponseHandler org.fax4j.spi.http.JSONHTTPResponseHandler false org.fax4j.spi.http.host.name The target (service provider) host name. none none true org.fax4j.spi.http.port The target port number. none none false org.fax4j.spi.http.ssl True to use SSL (HTTPS), false for simple HTTP false false false org.fax4j.spi.http.submit.resource The default HTTP resource of the submit fax job request none none false org.fax4j.spi.http.suspend.resource The default HTTP resource of the suspend fax job request none none false org.fax4j.spi.http.resume.resource The default HTTP resource of the resume fax job request none none false org.fax4j.spi.http.cancel.resource The default HTTP resource of the cancel fax job request none none false org.fax4j.spi.http.get.status.resource The default HTTP resource of the get fax job status request none none false org.fax4j.spi.http.url.parameters The default HTTP URL parameters of the request none none false org.fax4j.spi.http.submit.method The HTTP method for the submit action POST POST false org.fax4j.spi.http.suspend.method The HTTP method for the suspend action POST POST false org.fax4j.spi.http.resume.method The HTTP method for the resume action POST POST false org.fax4j.spi.http.cancel.method The HTTP method for the cancel action POST POST false org.fax4j.spi.http.get.status.method The HTTP method for the get fax job status action POST POST false Dependencies: HTTP client required jars. Classes in org.fax4j.spi.http used by org.fax4j.spi.http Class and 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 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. CommonHTTPClientConfiguration.HTTPClientConfigurationConstants This class holds the configuration constants. 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. HTTPClient.HTTPMethod This enum holds the supported HTTP methods. 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. 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: Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.http.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.http.faxjob2request.converter.class.name The fax job to HTTP request converter class name used to convert the fax job data into the relevant HTTP request. org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter false org.fax4j.spi.http.response.handler.class.name The HTTP response handler class name used to update the fax job data based on the HTTP response. org.fax4j.spi.http.JSONHTTPResponseHandler org.fax4j.spi.http.JSONHTTPResponseHandler false org.fax4j.spi.http.host.name The target (service provider) host name. none none true org.fax4j.spi.http.port The target port number. none none false org.fax4j.spi.http.ssl True to use SSL (HTTPS), false for simple HTTP false false false org.fax4j.spi.http.submit.resource The default HTTP resource of the submit fax job request none none false org.fax4j.spi.http.suspend.resource The default HTTP resource of the suspend fax job request none none false org.fax4j.spi.http.resume.resource The default HTTP resource of the resume fax job request none none false org.fax4j.spi.http.cancel.resource The default HTTP resource of the cancel fax job request none none false org.fax4j.spi.http.get.status.resource The default HTTP resource of the get fax job status request none none false org.fax4j.spi.http.url.parameters The default HTTP URL parameters of the request none none false org.fax4j.spi.http.submit.method The HTTP method for the submit action POST POST false org.fax4j.spi.http.suspend.method The HTTP method for the suspend action POST POST false org.fax4j.spi.http.resume.method The HTTP method for the resume action POST POST false org.fax4j.spi.http.cancel.method The HTTP method for the cancel action POST POST false org.fax4j.spi.http.get.status.method The HTTP method for the get fax job status action POST POST false Dependencies: HTTP client required jars. HTTPFaxClientSpi.FaxClientSpiConfigurationConstants This class holds the SPI configuration constants. HTTPRequest Holds the HTTP request data used to send the fax data to the web server. This class is not thread safe. HTTPRequest.ContentPart This class holds the content part data. HTTPRequest.ContentPartType This enum defines the content part types which are supported. HTTPRequest.ContentType This enum defines the content types which are supported. HTTPResponse Holds the HTTP response data extracted after the fax request was sent to the web server. This class is not thread safe. HTTPResponseHandler This interface defines the HTTP response handler which is used to update the fax job based on the HTTP response data. JSONHTTPResponseHandler.JSONHTTPResponseHandlerConfigurationConstants This class holds the configuration constants. MultiPartFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants This class holds the configuration constants. TemplateFaxJob2HTTPRequestConverter.FaxJob2HTTPRequestConverterConfigurationConstants This class holds the configuration constants. XMLHTTPResponseHandler.XMLHTTPResponseHandlerConfigurationConstants This class holds the configuration constants. Classes in org.fax4j.spi.http used by org.fax4j.spi.phaxio Class and Description AbstractMultiPart2JSONHTTPFaxClientSpi This class provides common base for HTTP based SPIs which submit multi part HTTP request and expect a JSON output. 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. 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: Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.http.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.http.faxjob2request.converter.class.name The fax job to HTTP request converter class name used to convert the fax job data into the relevant HTTP request. org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter org.fax4j.spi.http.MultiPartFaxJob2HTTPRequestConverter false org.fax4j.spi.http.response.handler.class.name The HTTP response handler class name used to update the fax job data based on the HTTP response. org.fax4j.spi.http.JSONHTTPResponseHandler org.fax4j.spi.http.JSONHTTPResponseHandler false org.fax4j.spi.http.host.name The target (service provider) host name. none none true org.fax4j.spi.http.port The target port number. none none false org.fax4j.spi.http.ssl True to use SSL (HTTPS), false for simple HTTP false false false org.fax4j.spi.http.submit.resource The default HTTP resource of the submit fax job request none none false org.fax4j.spi.http.suspend.resource The default HTTP resource of the suspend fax job request none none false org.fax4j.spi.http.resume.resource The default HTTP resource of the resume fax job request none none false org.fax4j.spi.http.cancel.resource The default HTTP resource of the cancel fax job request none none false org.fax4j.spi.http.get.status.resource The default HTTP resource of the get fax job status request none none false org.fax4j.spi.http.url.parameters The default HTTP URL parameters of the request none none false org.fax4j.spi.http.submit.method The HTTP method for the submit action POST POST false org.fax4j.spi.http.suspend.method The HTTP method for the suspend action POST POST false org.fax4j.spi.http.resume.method The HTTP method for the resume action POST POST false org.fax4j.spi.http.cancel.method The HTTP method for the cancel action POST POST false org.fax4j.spi.http.get.status.method The HTTP method for the get fax job status action POST POST false 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.