org.fax4j.spi.java4less

Class RFaxFaxClientSpi

java.lang.Object

org.fax4j.spi.AbstractFaxClientSpi

org.fax4j.spi.AbstractFax4JClientSpi

org.fax4j.spi.java4less.RFaxFaxClientSpi

All Implemented Interfaces:

ConfigurationHolder, FaxClientActions, ProviderImplementation, FaxClientSpi

public class RFaxFaxClientSpi
extends AbstractFax4JClientSpi

This class implements the fax client service provider interface.
This implementation is based on the java4less commercial product.
This implementation is not meant to promote the java4less 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): Draft

Below table describes the configuration values relevant for this class.
Configuration:

Name	Description	Preconfigured Value	Default Value	Mandatory
org.fax4j.spi.rfax.port.name	See java4less website for more info.	none	none	true
org.fax4j.spi.rfax.fax.class	See java4less website for more info.	none	none	true

Limitations:

• See java4less web site.
• Currently this SPI only supports submitting new fax jobs.

Dependencies:

• See java4less web site.

Since:

0.1

Version:

1.10

Author:

Sagie Gur-Ari

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RFaxFaxClientSpi.FaxClientSpiConfigurationConstants This class holds the SPI configuration constants.
static class	RFaxFaxClientSpi.FaxJobExtendedPropertyConstants This class holds the fax job extended properties.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	initializeImpl() This function initializes the fax client SPI.
protected void	submitFaxJobImpl(FaxJob faxJob) This function will submit a new fax job. The fax job ID may be populated by this method in the provided fax job object.
protected void	submitFaxJobViaFaxModem(FaxJob faxJob) This function will submit a new fax job. The fax job ID may be populated by this method in the provided fax job object.

Methods inherited from class org.fax4j.spi.AbstractFax4JClientSpi

cancelFaxJobImpl, getFaxJobStatusImpl, getProvider, isFaxMonitorEventsSupported, pollForFaxJobStatues, pollForFaxJobStatuesImpl, resumeFaxJobImpl, suspendFaxJobImpl

Methods inherited from class org.fax4j.spi.AbstractFaxClientSpi

addFaxClientActionEventListener, addFaxMonitorEventListener, cancelFaxJob, createFaxJob, createFaxJobImpl, fireFaxEvent, fireFaxEvent, fireFaxMonitorEvent, getConfiguration, getConfigurationValue, getConfigurationValue, getFaxJobMonitor, getFaxJobStatus, getLogger, getPropertyPart, 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

Constructor Detail

RFaxFaxClientSpi

public RFaxFaxClientSpi()

This is the default constructor.

Method Detail

initializeImpl

protected void initializeImpl()

This function initializes the fax client SPI.

Specified by:

initializeImpl in class AbstractFaxClientSpi

submitFaxJobImpl

protected void submitFaxJobImpl(FaxJob faxJob)

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

Overrides:

submitFaxJobImpl in class AbstractFax4JClientSpi

Parameters:

faxJob - The fax job object containing the needed information

submitFaxJobViaFaxModem

protected void submitFaxJobViaFaxModem(FaxJob faxJob)
                                throws Exception

This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object.

Parameters:

faxJob - The fax job object containing the needed information

Throws:

Exception - Any exception