Package org.fax4j.spi.windows

Provides the native windows fax client SPI implementation.

See: Description

Class Summary

Class

Description

WindowsFaxClientSpi

This class implements the fax client service provider interface. This implementation will proxy the requests to windows native fax API. 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 org.fax4j.spi.windows.use.jni True to use JNI, false to use the external fax4j.exe false false false Limitations: This SPI will only work on Windows OS (windows 2000 and up). WindowsFaxClientSpiHelper This is a helper class for the windows based SPIs. WindowsJNIFaxClientSpi 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). WindowsProcessFaxClientSpi 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). WindowsProcessOutputHandler This class implements the windows process output handler which is used to update the fax job based on the process output information. WindowsProcessOutputValidator This process output validator checks the fax4j.exe output data for errors. Enum Summary Enum Description WindowsFaxClientSpi.FaxClientSpiConfigurationConstants This class holds the SPI configuration constants. WindowsFaxClientSpi.FaxJobExtendedPropertyConstants This class holds the fax job extended properties. WindowsProcessFaxClientSpi.Fax4jExeConstants This class holds the fax4j exe constants. WindowsProcessFaxClientSpi.FaxClientSpiConfigurationConstants This class holds the SPI configuration constants. Package org.fax4j.spi.windows Description Provides the native windows fax client SPI implementation. Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Package Next Package Frames No Frames All Classes Copyright © 2009–2020 fax4j. All rights reserved.