Package org.fax4j.spi

Provides the API classes for the fax client SPI.
The class/interfaces defined in this package should only be used internally by the fax4j library or by classes implemeting a new fax client SPI.

See: Description

Interface Summary

Interface	Description
FaxClientSpi	This interface defines the fax client service provider interface. 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.
FaxClientSpiInterceptor	This interface defines the fax client SPI interceptor which enables to invoke custom logic before and after the fax client SPI method invocations (such as logging).
FaxClientSpiProxy	This interface defines the fax client SPI proxy which enables to invoke interceptors before and after the fax client SPI method invocations. With this proxy, it is possible to intercept all calls to the fax client SPIs and perform custom logic such as logging.
FaxJobMonitor	This interface defines the fax job monitor capabilities.

Class Summary

Class	Description
AbstractFax4JClientSpi	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.
AbstractFaxClientSpi	This class provides partial/common functionlity of the fax client service provider interface. 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.
AbstractFaxClientSpiInterceptor	This class provides partial implementation of the fax client SPI interceptor which enables to invoke custom logic before and after the fax client SPI method invocations (such as logging).
AbstractFaxClientSpiProxy	This class provides partial implementation of the fax client SPI proxy which enables to invoke interceptors before and after the fax client SPI method invocations. With this proxy, it is possible to intercept all calls to the fax client SPIs and perform custom logic such as logging.
AbstractFaxJob	This class provides common partial implementation of the fax job.
AbstractFaxJobMonitor	This class provides partial implementation of the fax job monitor capabilities.
FaxClientSpiFactory	This is the fax client SPI factory which is used to create new instances of the fax client SPI. 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. Below table describes the configuration values relevant for this class, for SPI specific configuration, see the relevant SPI class javadoc. Configuration: Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.type.map.xxx For each SPI type, there is a property that (with prefix: org.fax4j.spi.type.map. FaxClientSpiProxyImpl This class provides basic implementation of the fax client SPI proxy which enables to invoke interceptors before and after the fax client SPI method invocations. With this proxy, it is possible to intercept all calls to the fax client SPIs and perform custom logic such as logging. FaxJobImpl This class provides basic implementation of the fax job. FaxJobMonitorImpl This class provides the default implementation of the fax job monitor. FaxJobMonitorImpl.PollerTask This class used the start the polling cycle. LogFaxClientSpiInterceptor This class provides the logging implementation of the fax client SPI interceptor which enables to log all fax client SPI method invocations. Enum Summary Enum Description AbstractFaxClientSpi.FaxJobExtendedPropertyConstants This class holds the fax job extended properties. FaxClientSpiProxy.FaxClientSpiProxyEventType This is the fax client SPI proxy event type. Package org.fax4j.spi Description Provides the API classes for the fax client SPI. The class/interfaces defined in this package should only be used internally by the fax4j library or by classes implemeting a new fax client SPI. 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.