public abstract class AbstractAdapterFaxClientSpi extends AbstractFax4JClientSpi
AbstractFaxClientSpi.FaxJobExtendedPropertyConstants
Modifier and Type | Field and Description |
---|---|
protected FaxClientSpi |
faxClientSpi
The fax client SPI
|
Constructor and Description |
---|
AbstractAdapterFaxClientSpi()
This is the class constructor.
|
Modifier and Type | Method and Description |
---|---|
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 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 FaxClientSpi |
getInternalFaxClientSpi()
This function returns the internal fax client SPI.
|
protected abstract void |
initializeChildFaxClientSpi()
This function initializes the child fax client SPI.
|
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 FaxJobStatus[] |
pollForFaxJobStatuesImpl(FaxJob[] faxJobs)
This function polls the new statues for the provided fax jobs.
|
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.
|
getProvider, pollForFaxJobStatues
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
protected FaxClientSpi faxClientSpi
public AbstractAdapterFaxClientSpi()
protected void initializeImpl()
initializeImpl
in class AbstractFaxClientSpi
protected FaxClientSpi getInternalFaxClientSpi()
public boolean isFaxMonitorEventsSupported()
isFaxMonitorEventsSupported
in interface FaxClientSpi
isFaxMonitorEventsSupported
in class AbstractFax4JClientSpi
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 FaxJobStatus getFaxJobStatusImpl(FaxJob faxJob)
getFaxJobStatusImpl
in class AbstractFax4JClientSpi
faxJob
- The fax job object containing the needed informationprotected FaxJobStatus[] pollForFaxJobStatuesImpl(FaxJob[] faxJobs)
pollForFaxJobStatuesImpl
in class AbstractFax4JClientSpi
faxJobs
- The fax jobs to pollprotected abstract void initializeChildFaxClientSpi()
Copyright © 2009–2020 fax4j. All rights reserved.