org.fax4j.spi

Class AbstractFax4JClientSpi

java.lang.Object

org.fax4j.spi.AbstractFaxClientSpi

org.fax4j.spi.AbstractFax4JClientSpi

All Implemented Interfaces:

ConfigurationHolder, FaxClientActions, ProviderImplementation, FaxClientSpi

Direct Known Subclasses:

AbstractAdapterFaxClientSpi, AbstractMailFaxClientSpi, CommFaxClientSpi, HTTPFaxClientSpi, HylaFaxClientSpi, MacFaxClientSpi, ProcessFaxClientSpi, RFaxFaxClientSpi, VBSFaxClientSpi, WindowsJNIFaxClientSpi

public abstract class AbstractFax4JClientSpi
extends AbstractFaxClientSpi

This class provides partial/common functionlity of the internal fax4j fax client service provider interface.
This class should be used only by internal fax4j SPIs, for SPIs written by vendors outside the fax4j, see the org.fax4j.spi.AbstractFaxClientSpi class.
This is the actual engine behind the fax4j framework.
It handles the fax client activities such as sending/suspending fax jobs and so on.
The SPI is an internal class that should be used internally only.

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.

For SPI specific configuration, see the relevant SPI class javadoc.

Since:

0.17

Version:

1.03

Author:

Sagie Gur-Ari

Nested Class Summary

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

AbstractFaxClientSpi.FaxJobExtendedPropertyConstants

Constructor Summary

Constructors

Constructor and Description
AbstractFax4JClientSpi() 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 FaxJobStatus	getFaxJobStatusImpl(FaxJob faxJob) This function returns the fax job status. Not all SPIs support extraction of the fax job status. In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.
Provider	getProvider() This function returns the provider.
boolean	isFaxMonitorEventsSupported() This function returns true if the fax monitor events are supported by this SPI.
FaxJobStatus[]	pollForFaxJobStatues(FaxJob[] faxJobs) This function polls the new statues for the provided fax jobs.
protected FaxJobStatus[]	pollForFaxJobStatuesImpl(FaxJob[] faxJobs) This function polls the new statues for the provided fax jobs.
protected void	resumeFaxJobImpl(FaxJob faxJob) This function will resume an existing fax job.
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	suspendFaxJobImpl(FaxJob faxJob) This function will suspend an existing fax job.

Methods inherited from class org.fax4j.spi.AbstractFaxClientSpi

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

AbstractFax4JClientSpi

public AbstractFax4JClientSpi()

This is the default constructor.

Method Detail

getProvider

public final Provider getProvider()

This function returns the provider.

Returns:

The provider

isFaxMonitorEventsSupported

public boolean isFaxMonitorEventsSupported()

This function returns true if the fax monitor events are supported by this SPI.

Returns:

True if the fax monitor events are supported by this SPI

pollForFaxJobStatues

public final FaxJobStatus[] pollForFaxJobStatues(FaxJob[] faxJobs)

This function polls the new statues for the provided fax jobs.

Parameters:

faxJobs - The fax jobs to poll

Returns:

The fax job statues

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.

Specified by:

submitFaxJobImpl in class AbstractFaxClientSpi

Parameters:

faxJob - The fax job object containing the needed information

suspendFaxJobImpl

protected void suspendFaxJobImpl(FaxJob faxJob)

This function will suspend an existing fax job.

Specified by:

suspendFaxJobImpl in class AbstractFaxClientSpi

Parameters:

faxJob - The fax job object containing the needed information

resumeFaxJobImpl

protected void resumeFaxJobImpl(FaxJob faxJob)

This function will resume an existing fax job.

Specified by:

resumeFaxJobImpl in class AbstractFaxClientSpi

Parameters:

faxJob - The fax job object containing the needed information

cancelFaxJobImpl

protected void cancelFaxJobImpl(FaxJob faxJob)

This function will cancel an existing fax job.

Specified by:

cancelFaxJobImpl in class AbstractFaxClientSpi

Parameters:

faxJob - The fax job object containing the needed information

getFaxJobStatusImpl

protected FaxJobStatus getFaxJobStatusImpl(FaxJob faxJob)

This function returns the fax job status.
Not all SPIs support extraction of the fax job status.
In case the SPI is unable to extract or does not support extracting of the fax job status, it will return the UNKNOWN status.

Specified by:

getFaxJobStatusImpl in class AbstractFaxClientSpi

Parameters:

faxJob - The fax job object containing the needed information

Returns:

The fax job status

pollForFaxJobStatuesImpl

protected FaxJobStatus[] pollForFaxJobStatuesImpl(FaxJob[] faxJobs)

This function polls the new statues for the provided fax jobs.

Parameters:

faxJobs - The fax jobs to poll

Returns:

The fax job statues