public class CommFaxClientSpi extends AbstractFax4JClientSpi
Name | Description | Preconfigured Value | Default Value | Mandatory |
org.fax4j.spi.comm.port.name | The COMM port name (COM1, ...) property key | none | none | true |
org.fax4j.spi.comm.connection.factory.class.name | The connection factory class name | org.fax4j.spi.comm.CommPortConnectionFactoryImpl | org.fax4j.spi.comm.CommPortConnectionFactoryImpl | false |
org.fax4j.spi.comm.fax.modem.class.name | The fax modem class name | none | none | true |
org.fax4j.spi.comm.connection.timeout | The timeout value when trying to own a COMM port | 1500 | 1500 | false |
Modifier and Type | Class and Description |
---|---|
static class |
CommFaxClientSpi.FaxClientSpiConfigurationConstants
This class holds the SPI configuration constants.
|
AbstractFaxClientSpi.FaxJobExtendedPropertyConstants
Modifier and Type | Field and Description |
---|---|
static int |
TIMEOUT_DEFAULT_VALUE
The timeout default value
|
Constructor and Description |
---|
CommFaxClientSpi()
This is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected Connection<CommPortAdapter> |
createCommPortConnection()
Creates and returns the COMM port connection to be used.
|
protected CommPortConnectionFactory |
createCommPortConnectionFactory()
Creates and returns the COMM port connection factory.
|
protected FaxModemAdapter |
createFaxModemAdapter()
Creates and returns the fax modem adapter.
|
protected void |
finalize()
Releases the COMM port connection if open.
|
protected Connection<CommPortAdapter> |
getCommPortConnection()
Returns the COMM port connection to be used.
|
protected void |
initializeImpl()
This function initializes the fax client SPI.
|
protected void |
releaseCommPortConnection()
Releases the COMM port connection if open.
|
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 |
submitFaxJobImpl(FaxJob faxJob,
CommPortAdapter adapter)
This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object. |
cancelFaxJobImpl, getFaxJobStatusImpl, getProvider, isFaxMonitorEventsSupported, pollForFaxJobStatues, pollForFaxJobStatuesImpl, resumeFaxJobImpl, suspendFaxJobImpl
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
public static final int TIMEOUT_DEFAULT_VALUE
protected void initializeImpl()
initializeImpl
in class AbstractFaxClientSpi
protected final CommPortConnectionFactory createCommPortConnectionFactory()
protected final FaxModemAdapter createFaxModemAdapter()
protected void finalize() throws Throwable
protected Connection<CommPortAdapter> createCommPortConnection()
protected void releaseCommPortConnection()
protected Connection<CommPortAdapter> getCommPortConnection()
protected void submitFaxJobImpl(FaxJob faxJob)
submitFaxJobImpl
in class AbstractFax4JClientSpi
faxJob
- The fax job object containing the needed informationprotected void submitFaxJobImpl(FaxJob faxJob, CommPortAdapter adapter)
faxJob
- The fax job object containing the needed informationadapter
- The COMM port adapterCopyright © 2009–2020 fax4j. All rights reserved.