org.fax4j.spi.hoiio

Class HoiioFaxClientSpi

java.lang.Object

org.fax4j.spi.AbstractFaxClientSpi

org.fax4j.spi.AbstractFax4JClientSpi

org.fax4j.spi.http.HTTPFaxClientSpi

org.fax4j.spi.http.AbstractMultiPart2JSONHTTPFaxClientSpi

org.fax4j.spi.hoiio.HoiioFaxClientSpi

All Implemented Interfaces:

ConfigurationHolder, FaxClientActions, ProviderImplementation, FaxClientSpi

public class HoiioFaxClientSpi
extends AbstractMultiPart2JSONHTTPFaxClientSpi

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.

Since:

0.42.9

Version:

1.0

Author:

Sagie Gur-Ari

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HoiioFaxClientSpi.FaxClientSpiConfigurationConstants This class holds the SPI configuration constants.

Nested classes/interfaces inherited from class org.fax4j.spi.AbstractFaxClientSpi

AbstractFaxClientSpi.FaxJobExtendedPropertyConstants

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOIIO_PROPERTY_PART The Hoiio property part

Fields inherited from class org.fax4j.spi.http.HTTPFaxClientSpi

HTTP_PROPERTY_PART

Constructor Summary

Constructors

Constructor and Description
HoiioFaxClientSpi() This is the default constructor.

Method Summary

Modifier and Type	Method and Description
protected void	cancelFaxJobImpl(FaxJob faxJob) This function will cancel an existing fax job.
protected HTTPClientConfiguration	createHTTPClientConfiguration() This function creates and returns the HTTP configuration object.
String	getPropertyPart() Returns the property part. Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks. Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey
protected Map<FaxActionType,String>	initializeFaxActionType2ResourceMap() This function initializes the fax action type to resource mappings.
protected String	initializeURLParameters() This function returns the HTTP URL parameters from the configuration.
protected void	resumeFaxJobImpl(FaxJob faxJob) This function will resume an existing fax job.
protected void	suspendFaxJobImpl(FaxJob faxJob) This function will suspend an existing fax job.
protected void	updateFaxJob2HTTPRequestConverterConfiguration(Map<String,String> configuration) Hook for extending classes.
protected void	updateHTTPResponseHandlerConfiguration(Map<String,String> configuration) Hook for extending classes.

Methods inherited from class org.fax4j.spi.http.AbstractMultiPart2JSONHTTPFaxClientSpi

createFaxJob2HTTPRequestConverter, createHTTPResponseHandler

Methods inherited from class org.fax4j.spi.http.HTTPFaxClientSpi

createCancelFaxJobHTTPRequest, createGetFaxJobStatusHTTPRequest, createResumeFaxJobHTTPRequest, createSubmitFaxJobHTTPRequest, createSuspendFaxJobHTTPRequest, getFaxJob2HTTPRequestConverter, getFaxJobStatusImpl, getHTTPClient, getHTTPClientConfiguration, getHTTPResource, getHTTPResponseHandler, getHTTPURLParameters, initializeImpl, submitFaxJobImpl, submitHTTPRequest, submitHTTPRequestImpl, updateFaxJob

Methods inherited from class org.fax4j.spi.AbstractFax4JClientSpi

getProvider, isFaxMonitorEventsSupported, pollForFaxJobStatues, pollForFaxJobStatuesImpl

Methods inherited from class org.fax4j.spi.AbstractFaxClientSpi

addFaxClientActionEventListener, addFaxMonitorEventListener, cancelFaxJob, createFaxJob, createFaxJobImpl, fireFaxEvent, fireFaxEvent, fireFaxMonitorEvent, getConfiguration, getConfigurationValue, getConfigurationValue, getFaxJobMonitor, getFaxJobStatus, getLogger, initialize, invokeFaxJobIDValidation, invokeFaxJobNullValidation, removeAllFaxClientActionEventListeners, removeAllFaxMonitorEventListeners, removeFaxClientActionEventListener, removeFaxMonitorEventListener, resumeFaxJob, submitFaxJob, suspendFaxJob, throwUnsupportedException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HOIIO_PROPERTY_PART

public static final String HOIIO_PROPERTY_PART

The Hoiio property part

See Also:

Constant Field Values

Constructor Detail

HoiioFaxClientSpi

public HoiioFaxClientSpi()

This is the default constructor.

Method Detail

getPropertyPart

public String getPropertyPart()

Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks.
Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey

Specified by:

getPropertyPart in interface ConfigurationHolder

Overrides:

getPropertyPart in class HTTPFaxClientSpi

Returns:

The property part

createHTTPClientConfiguration

protected HTTPClientConfiguration createHTTPClientConfiguration()

This function creates and returns the HTTP configuration object.

Overrides:

createHTTPClientConfiguration in class HTTPFaxClientSpi

Returns:

The HTTP configuration object

updateFaxJob2HTTPRequestConverterConfiguration

protected void updateFaxJob2HTTPRequestConverterConfiguration(Map<String,String> configuration)

Hook for extending classes.

Specified by:

updateFaxJob2HTTPRequestConverterConfiguration in class AbstractMultiPart2JSONHTTPFaxClientSpi

Parameters:

configuration - The converter configuration

updateHTTPResponseHandlerConfiguration

protected void updateHTTPResponseHandlerConfiguration(Map<String,String> configuration)

Hook for extending classes.

Specified by:

updateHTTPResponseHandlerConfiguration in class AbstractMultiPart2JSONHTTPFaxClientSpi

Parameters:

configuration - The response handler configuration

initializeFaxActionType2ResourceMap

protected Map<FaxActionType,String> initializeFaxActionType2ResourceMap()

This function initializes the fax action type to resource mappings.

Overrides:

initializeFaxActionType2ResourceMap in class HTTPFaxClientSpi

Returns:

The fax action type to resource mappings

initializeURLParameters

protected String initializeURLParameters()

This function returns the HTTP URL parameters from the configuration.

Overrides:

initializeURLParameters in class HTTPFaxClientSpi

Returns:

The HTTP URL parameters

suspendFaxJobImpl

protected void suspendFaxJobImpl(FaxJob faxJob)

This function will suspend an existing fax job.

Overrides:

suspendFaxJobImpl in class HTTPFaxClientSpi

Parameters:

faxJob - The fax job object containing the needed information

resumeFaxJobImpl

protected void resumeFaxJobImpl(FaxJob faxJob)

This function will resume an existing fax job.

Overrides:

resumeFaxJobImpl in class HTTPFaxClientSpi

Parameters:

faxJob - The fax job object containing the needed information

cancelFaxJobImpl

protected void cancelFaxJobImpl(FaxJob faxJob)

This function will cancel an existing fax job.

Overrides:

cancelFaxJobImpl in class HTTPFaxClientSpi

Parameters:

faxJob - The fax job object containing the needed information