org.fax4j.spi.windows

Class WindowsJNIFaxClientSpi

java.lang.Object

org.fax4j.spi.AbstractFaxClientSpi

org.fax4j.spi.AbstractFax4JClientSpi

org.fax4j.spi.windows.WindowsJNIFaxClientSpi

All Implemented Interfaces:

ConfigurationHolder, FaxClientActions, ProviderImplementation, FaxClientSpi

public class WindowsJNIFaxClientSpi
extends AbstractFax4JClientSpi

This class implements the fax client service provider interface.
This implementation will proxy the requests to windows native fax API.
This SPI should not be used directly and instead the WindowsFaxClientSpi should be used, as it will proxy the requests to this internal SPI based on the configuration and machine setup.
It is possible to see all faxes submitted from this SPI in the windows fax window available from the Start→Settings→Printers and Faxes→Fax

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.windows.server.name	The fax server host name.	none	none	false

Limitations:

• This SPI will only work on Windows OS (windows 2000 and up).
• See windows fax/tapi limitations.
• JNI only supported on 32 bit JVMs (Windows OS can be 64 bit).

Dependencies:

• Required native libraries: winfax.dll
• Windows OS (windows 2000 and up) - see http://msdn.microsoft.com/en-us/library/ms692855(VS.85).aspx for more info.
• Windows fax component installed.

Since:

0.41.5

Version:

1.01

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
WindowsJNIFaxClientSpi() 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.
protected void	initializeImpl() This function initializes the fax client SPI.
boolean	isFaxMonitorEventsSupported() This function returns true if the fax monitor events are supported by this SPI.
protected void	preNativeCall() This function is invoked before any native call to set the native layer debug mode.
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.AbstractFax4JClientSpi

getProvider, pollForFaxJobStatues, pollForFaxJobStatuesImpl

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

WindowsJNIFaxClientSpi

public WindowsJNIFaxClientSpi()

This is the default constructor.

Method Detail

initializeImpl

protected void initializeImpl()

This function initializes the fax client SPI.

Specified by:

initializeImpl in class AbstractFaxClientSpi

isFaxMonitorEventsSupported

public boolean isFaxMonitorEventsSupported()

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

Specified by:

isFaxMonitorEventsSupported in interface FaxClientSpi

Overrides:

isFaxMonitorEventsSupported in class AbstractFax4JClientSpi

Returns:

True if the fax monitor events are supported by this SPI

preNativeCall

protected void preNativeCall()

This function is invoked before any native call to set the native layer debug mode.

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

suspendFaxJobImpl

protected void suspendFaxJobImpl(FaxJob faxJob)

This function will suspend an existing fax job.

Overrides:

suspendFaxJobImpl in class AbstractFax4JClientSpi

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 AbstractFax4JClientSpi

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 AbstractFax4JClientSpi

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.

Overrides:

getFaxJobStatusImpl in class AbstractFax4JClientSpi

Parameters:

faxJob - The fax job object containing the needed information

Returns:

The fax job status