public class HylaFaxClientSpi extends AbstractFax4JClientSpi
Name | Description | Preconfigured Value | Default Value | Mandatory |
org.fax4j.spi.hylafax.connection.factory.class.name | The connection factory class name | org.fax4j.spi.hylafax.HylaFAXClientConnectionFactoryImpl | org.fax4j.spi.hylafax.HylaFAXClientConnectionFactoryImpl | false |
org.fax4j.spi.hylafax.host | See gnu-hylafax project for more info. | none | none | true |
org.fax4j.spi.hylafax.port | See gnu-hylafax project for more info. | none | gnu.hylafax.HylaFAXClientProtocol.DEFAULT_PORT | false |
org.fax4j.spi.hylafax.user | See gnu-hylafax project for more info. | none | none | true |
org.fax4j.spi.hylafax.password | See gnu-hylafax project for more info. | none | none | false |
org.fax4j.spi.hylafax.admin | See gnu-hylafax project for more info. | false | false | false |
org.fax4j.spi.hylafax.mode | See gnu-hylafax project for more info. | Z | none | true |
org.fax4j.spi.hylafax.type | See gnu-hylafax project for more info. | A | none | true |
Modifier and Type | Class and Description |
---|---|
static class |
HylaFaxClientSpi.FaxClientSpiConfigurationConstants
This class holds the SPI configuration constants.
|
AbstractFaxClientSpi.FaxJobExtendedPropertyConstants
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_PORT_PROPERTY_VALUE
The fax server default port
|
Constructor and Description |
---|
HylaFaxClientSpi()
This is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
cancelFaxJob(HylaFaxJob faxJob,
gnu.hylafax.HylaFAXClient client)
This function will cancel an existing fax job.
|
protected void |
cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected FaxJob |
createFaxJobImpl()
This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.
|
protected HylaFAXClientConnectionFactory |
createHylaFAXClientConnectionFactory(String className)
Creates and returns the hylafax client connection factory.
|
protected void |
finalize()
Releases the connection if open.
|
protected gnu.hylafax.HylaFAXClient |
getHylaFAXClient()
Returns an instance of the hyla fax client.
|
protected void |
initializeImpl()
This function initializes the fax client SPI.
|
protected void |
resumeFaxJob(HylaFaxJob faxJob,
gnu.hylafax.HylaFAXClient client)
This function will resume an existing fax job.
|
protected void |
resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
submitFaxJob(HylaFaxJob faxJob,
gnu.hylafax.HylaFAXClient client)
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)
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 |
suspendFaxJob(HylaFaxJob faxJob,
gnu.hylafax.HylaFAXClient client)
This function will suspend an existing fax job.
|
protected void |
suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
getFaxJobStatusImpl, getProvider, isFaxMonitorEventsSupported, pollForFaxJobStatues, pollForFaxJobStatuesImpl
addFaxClientActionEventListener, addFaxMonitorEventListener, cancelFaxJob, createFaxJob, 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 DEFAULT_PORT_PROPERTY_VALUE
protected void initializeImpl()
initializeImpl
in class AbstractFaxClientSpi
protected final HylaFAXClientConnectionFactory createHylaFAXClientConnectionFactory(String className)
className
- The connection factory class nameprotected gnu.hylafax.HylaFAXClient getHylaFAXClient()
protected void finalize() throws Throwable
protected FaxJob createFaxJobImpl()
createFaxJobImpl
in class AbstractFaxClientSpi
protected void submitFaxJobImpl(FaxJob faxJob)
submitFaxJobImpl
in class AbstractFax4JClientSpi
faxJob
- The fax job object containing the needed informationprotected void suspendFaxJobImpl(FaxJob faxJob)
suspendFaxJobImpl
in class AbstractFax4JClientSpi
faxJob
- The fax job object containing the needed informationprotected void resumeFaxJobImpl(FaxJob faxJob)
resumeFaxJobImpl
in class AbstractFax4JClientSpi
faxJob
- The fax job object containing the needed informationprotected void cancelFaxJobImpl(FaxJob faxJob)
cancelFaxJobImpl
in class AbstractFax4JClientSpi
faxJob
- The fax job object containing the needed informationprotected void submitFaxJob(HylaFaxJob faxJob, gnu.hylafax.HylaFAXClient client) throws Exception
client
- The client instancefaxJob
- The fax job object containing the needed informationException
- Any exceptionprotected void suspendFaxJob(HylaFaxJob faxJob, gnu.hylafax.HylaFAXClient client) throws Exception
client
- The client instancefaxJob
- The fax job object containing the needed informationException
- Any exceptionprotected void resumeFaxJob(HylaFaxJob faxJob, gnu.hylafax.HylaFAXClient client) throws Exception
client
- The client instancefaxJob
- The fax job object containing the needed informationException
- Any exceptionprotected void cancelFaxJob(HylaFaxJob faxJob, gnu.hylafax.HylaFAXClient client) throws Exception
client
- The client instancefaxJob
- The fax job object containing the needed informationException
- Any exceptionCopyright © 2009–2020 fax4j. All rights reserved.