Package | Description |
---|---|
org.fax4j |
The fax4j library, is a standard on which java based applications can communicate with
fax devices in order to submit new faxes or perform other related actions.
|
org.fax4j.bridge |
Provides the API classes for the fax client bridge.
The fax4j bridge is used to transform applications to fax bridges for example an email server to provide email2fax functionality. |
org.fax4j.bridge.email |
Provides the API classes for the email2fax bridge.
|
org.fax4j.bridge.http |
Provides the API classes for a HTTP based web2fax bridge.
|
org.fax4j.bridge.process |
Provides the API classes for a standalone process based cli2fax bridge.
|
org.fax4j.common |
Contains common internal classes used by the fax4j library.
|
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. |
org.fax4j.spi.adapter |
Provides the adapter fax client SPI implementation.
|
org.fax4j.spi.comm |
Provides the COMM port communication based fax client SPI implementation.
|
org.fax4j.spi.email |
Provides the email based fax client SPI implementation.
|
org.fax4j.spi.hoiio |
Provides the hoiio based fax client SPI implementation.
|
org.fax4j.spi.http |
Provides the HTTP based fax client SPI implementation.
|
org.fax4j.spi.hylafax |
Provides the HylaFAX fax client SPI implementation.
|
org.fax4j.spi.interfax |
Provides the interfax based fax client SPI implementation.
|
org.fax4j.spi.java4less |
Provides the java4less RFax fax client SPI implementation.
|
org.fax4j.spi.mac |
Provides the native Mac fax client SPI implementation.
|
org.fax4j.spi.phaxio |
Provides the phaxio based fax client SPI implementation.
|
org.fax4j.spi.process |
Provides the process based fax client SPI implementation.
These implementations use external executables/scripts to invoke fax actions. |
org.fax4j.spi.vbs |
Provides the VB script based fax client SPI implementation.
|
org.fax4j.spi.windows |
Provides the native windows fax client SPI implementation.
|
org.fax4j.util |
Provides general utilities used internally by the fax4j library.
|
Modifier and Type | Method and Description |
---|---|
FaxJob |
FaxClient.createFaxJob()
This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.
|
FaxJob |
AbstractFaxEvent.getFaxJob()
This function returns the fax job.
|
Modifier and Type | Method and Description |
---|---|
void |
FaxClient.cancelFaxJob(FaxJob faxJob)
This function will cancel an existing fax job.
|
FaxJobStatus |
FaxClient.getFaxJobStatus(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. |
void |
FaxClient.resumeFaxJob(FaxJob faxJob)
This function will resume an existing fax job.
|
void |
FaxClient.submitFaxJob(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. |
void |
FaxClient.suspendFaxJob(FaxJob faxJob)
This function will suspend an existing fax job.
|
Constructor and Description |
---|
AbstractFaxEvent(FaxJob faxJob)
This is the class constructor.
|
FaxClientActionEvent(FaxClientActionEvent.FaxClientActionEventID id,
FaxJob faxJob)
This is the class constructor.
|
FaxMonitorEvent(FaxMonitorEvent.FaxMonitorEventID id,
FaxJob faxJob,
FaxJobStatus faxJobStatus)
This is the class constructor.
|
Modifier and Type | Method and Description |
---|---|
FaxJob |
AbstractFaxBridge.createFaxJob()
This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.
|
FaxJob |
FaxBridge.createFaxJob()
Returns the internal fax client.
|
FaxJob |
FaxBridgeFlowHelper.FlowResponse.getFaxJob()
This function returns the fax job.
|
FaxJob |
AbstractContextFaxBridge.submitFaxJob(T inputData)
This function will submit a new fax job.
|
FaxJob |
ContextFaxBridge.submitFaxJob(T inputData)
This function will submit a new fax job.
|
Modifier and Type | Method and Description |
---|---|
boolean |
AbstractVendorPolicy.invokePolicyForResponse(Object requestDataHolder,
FaxJob faxJob)
This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on. In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false. |
boolean |
VendorPolicy.invokePolicyForResponse(Object requestDataHolder,
FaxJob faxJob)
This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on. In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false. |
protected abstract boolean |
AbstractVendorPolicy.invokePolicyForResponseImpl(Object requestDataHolder,
FaxJob faxJob)
This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on. In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false. |
protected boolean |
EmptyVendorPolicy.invokePolicyForResponseImpl(Object requestDataHolder,
FaxJob faxJob)
This function invokes the vendor policy.
The policy may charge a customer for the service, or validate the user has permissions to invoke the action and so on. In case the policy takes over the flow and the fax bridge should not be invoked, this method should return false. |
void |
AbstractFaxBridge.submitFaxJob(FaxJob faxJob,
FileInfo fileInfo)
This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object. The file information in the provided fax job will be ignored by this method, instead the file data will be taken from the FileInfo. |
void |
FaxBridge.submitFaxJob(FaxJob faxJob,
FileInfo fileInfo)
This function will submit a new fax job.
The fax job ID may be populated by this method in the provided fax job object. The file information in the provided fax job will be ignored by this method, instead the file data will be taken from the FileInfo. |
void |
AbstractRequestParser.updateFaxJobFromInputData(T inputData,
FaxJob faxJob)
This function update the fax job from the input data.
This fax job will not have any file data. |
void |
RequestParser.updateFaxJobFromInputData(T inputData,
FaxJob faxJob)
This function update the fax job from the input data.
This fax job will not have any file data. |
protected abstract void |
AbstractRequestParser.updateFaxJobFromInputDataImpl(T inputData,
FaxJob faxJob)
This function update the fax job from the request data.
This fax job will not have any file data. |
protected abstract void |
AbstractFaxBridge.updateFaxJobWithFileInfo(FaxJob faxJob,
FileInfo fileInfo)
This function stores the file in the local machine and updates the fax job with the new file data.
|
protected void |
FaxBridgeImpl.updateFaxJobWithFileInfo(FaxJob faxJob,
FileInfo fileInfo)
This function stores the file in the local machine and updates the fax job with the new file data.
|
Constructor and Description |
---|
FlowResponse(FaxJob faxJob,
boolean continueFlow)
This is the class constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
DefaultMailMessageParser.updateFaxJobFromInputDataImpl(javax.mail.Message inputData,
FaxJob faxJob)
This function update the fax job from the request data.
This fax job will not have any file data. |
Modifier and Type | Method and Description |
---|---|
protected void |
MultiPartHTTPRequestParser.updateFaxJobFromInputDataImpl(HTTPRequest inputData,
FaxJob faxJob)
This function update the fax job from the request data.
This fax job will not have any file data. |
protected void |
SimpleHTTPRequestParser.updateFaxJobFromInputDataImpl(HTTPRequest inputData,
FaxJob faxJob)
This function update the fax job from the request data.
This fax job will not have any file data. |
protected void |
SimpleHTTPRequestParser.updateFaxJobFromRequestImpl(HTTPRequest request,
FaxJob faxJob,
Map<String,String> queryStringMap)
This function update the fax job from the request data.
This fax job will not have any file data. |
Modifier and Type | Method and Description |
---|---|
protected void |
DefaultCommandLineArgumentsParser.updateFaxJobFromInputDataImpl(String[] inputData,
FaxJob faxJob)
This function update the fax job from the request data.
This fax job will not have any file data. |
Modifier and Type | Method and Description |
---|---|
FaxJob |
FaxClientActions.createFaxJob()
This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.
|
Modifier and Type | Method and Description |
---|---|
void |
FaxClientActions.cancelFaxJob(FaxJob faxJob)
This function will cancel an existing fax job.
|
FaxJobStatus |
FaxClientActions.getFaxJobStatus(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. |
void |
FaxClientActions.resumeFaxJob(FaxJob faxJob)
This function will resume an existing fax job.
|
void |
FaxClientActions.submitFaxJob(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. |
void |
FaxClientActions.suspendFaxJob(FaxJob faxJob)
This function will suspend an existing fax job.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractFaxJob
This class provides common partial implementation of the fax job.
|
class |
FaxJobImpl
This class provides basic implementation of the fax job.
|
Modifier and Type | Method and Description |
---|---|
FaxJob |
AbstractFaxClientSpi.createFaxJob()
This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.
|
protected FaxJob |
AbstractFaxClientSpi.createFaxJobImpl()
This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractFaxClientSpi.cancelFaxJob(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected void |
AbstractFax4JClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected abstract void |
AbstractFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected void |
AbstractFaxClientSpi.fireFaxEvent(FaxClientActionEvent.FaxClientActionEventID id,
FaxJob faxJob)
This function fires a new fax event.
|
protected void |
AbstractFaxClientSpi.fireFaxEvent(FaxMonitorEvent.FaxMonitorEventID id,
FaxJob faxJob,
FaxJobStatus faxJobStatus)
This function fires a new fax event.
|
void |
AbstractFaxClientSpi.fireFaxMonitorEvent(FaxMonitorEvent.FaxMonitorEventID id,
FaxJob faxJob,
FaxJobStatus faxJobStatus)
This function fires a new fax monitor event.
|
void |
FaxClientSpi.fireFaxMonitorEvent(FaxMonitorEvent.FaxMonitorEventID id,
FaxJob faxJob,
FaxJobStatus faxJobStatus)
This function fires a new fax monitor event.
|
FaxJobStatus |
AbstractFaxClientSpi.getFaxJobStatus(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 FaxJobStatus |
AbstractFax4JClientSpi.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 abstract FaxJobStatus |
AbstractFaxClientSpi.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 void |
AbstractFaxClientSpi.invokeFaxJobIDValidation(FaxJob faxJob)
This function invokes the fax job null validation.
|
protected void |
AbstractFaxClientSpi.invokeFaxJobNullValidation(FaxJob faxJob)
This function invokes the fax job null validation.
|
void |
AbstractFaxJobMonitor.monitorFaxJob(FaxClientSpi faxClientSpi,
FaxJob faxJob)
This function starts monitoring the requested fax job.
|
void |
FaxJobMonitor.monitorFaxJob(FaxClientSpi faxClientSpi,
FaxJob faxJob)
This function starts monitoring the requested fax job.
|
abstract void |
AbstractFaxJobMonitor.monitorFaxJobImpl(FaxClientSpi faxClientSpi,
FaxJob faxJob)
This function starts monitoring the requested fax job.
|
void |
FaxJobMonitorImpl.monitorFaxJobImpl(FaxClientSpi faxClientSpi,
FaxJob faxJob)
This function starts monitoring the requested fax job.
|
FaxJobStatus[] |
AbstractFax4JClientSpi.pollForFaxJobStatues(FaxJob[] faxJobs)
This function polls the new statues for the provided fax jobs.
|
FaxJobStatus[] |
FaxClientSpi.pollForFaxJobStatues(FaxJob[] faxJobs)
This function polls the new statues for the provided fax jobs.
|
protected FaxJobStatus[] |
AbstractFax4JClientSpi.pollForFaxJobStatuesImpl(FaxJob[] faxJobs)
This function polls the new statues for the provided fax jobs.
|
void |
AbstractFaxClientSpi.resumeFaxJob(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
AbstractFax4JClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected abstract void |
AbstractFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
void |
AbstractFaxClientSpi.submitFaxJob(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 |
AbstractFax4JClientSpi.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 abstract void |
AbstractFaxClientSpi.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. |
void |
AbstractFaxClientSpi.suspendFaxJob(FaxJob faxJob)
This function will suspend an existing fax job.
|
protected void |
AbstractFax4JClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
protected abstract void |
AbstractFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
Modifier and Type | Method and Description |
---|---|
protected FaxJob |
AbstractAdapterFaxClientSpi.createFaxJobImpl()
This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractAdapterFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected FaxJobStatus |
AbstractAdapterFaxClientSpi.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 FaxJobStatus[] |
AbstractAdapterFaxClientSpi.pollForFaxJobStatuesImpl(FaxJob[] faxJobs)
This function polls the new statues for the provided fax jobs.
|
protected void |
AbstractAdapterFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
AbstractAdapterFaxClientSpi.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 |
AbstractAdapterFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
Modifier and Type | Method and Description |
---|---|
void |
AbstractFaxModemAdapter.submitFaxJob(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. |
void |
FaxModemAdapter.submitFaxJob(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. |
protected void |
CommFaxClientSpi.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 abstract void |
AbstractFaxModemAdapter.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. |
protected void |
CommFaxClientSpi.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. |
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractMailFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected abstract javax.mail.Message |
AbstractMailFaxClientSpi.createCancelFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
protected javax.mail.Message |
MailFaxClientSpi.createCancelFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
protected abstract javax.mail.Message |
AbstractMailFaxClientSpi.createResumeFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
protected javax.mail.Message |
MailFaxClientSpi.createResumeFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
protected abstract javax.mail.Message |
AbstractMailFaxClientSpi.createSubmitFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
protected javax.mail.Message |
MailFaxClientSpi.createSubmitFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
protected abstract javax.mail.Message |
AbstractMailFaxClientSpi.createSuspendFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
protected javax.mail.Message |
MailFaxClientSpi.createSuspendFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
protected void |
AbstractMailFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
AbstractMailFaxClientSpi.sendMail(FaxJob faxJob,
Connection<MailResourcesHolder> mailConnection,
javax.mail.Message message)
This function will send the mail message.
|
protected void |
AbstractMailFaxClientSpi.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 |
AbstractMailFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
Modifier and Type | Method and Description |
---|---|
protected void |
HoiioFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected void |
HoiioFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
HoiioFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
Modifier and Type | Method and Description |
---|---|
protected void |
MultiPartFaxJob2HTTPRequestConverter.addAdditionalContentParts(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob,
List<HTTPRequest.ContentPart<?>> contentList)
This function enables extending classes to add additional content parts.
|
protected void |
HTTPFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected HTTPRequest |
HTTPFaxClientSpi.createCancelFaxJobHTTPRequest(FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
protected HTTPRequest |
HTTPFaxClientSpi.createGetFaxJobStatusHTTPRequest(FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
protected HTTPRequest |
TemplateFaxJob2HTTPRequestConverter.createHTTPRequest(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
Enum<?> templateNameEnum,
FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
HTTPRequest |
FaxJob2HTTPRequestConverter.createHTTPRequest(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
HTTPRequest |
MultiPartFaxJob2HTTPRequestConverter.createHTTPRequest(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
HTTPRequest |
TemplateFaxJob2HTTPRequestConverter.createHTTPRequest(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
protected HTTPRequest |
HTTPFaxClientSpi.createResumeFaxJobHTTPRequest(FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
protected HTTPRequest |
HTTPFaxClientSpi.createSubmitFaxJobHTTPRequest(FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
protected HTTPRequest |
HTTPFaxClientSpi.createSuspendFaxJobHTTPRequest(FaxJob faxJob)
Creates the HTTP request from the fax job data.
|
protected String |
TemplateFaxJob2HTTPRequestConverter.formatHTTPResource(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob)
This function formats the HTTP resource.
|
protected String |
TemplateFaxJob2HTTPRequestConverter.formatHTTPURLParameters(HTTPFaxClientSpi faxClientSpi,
FaxJob faxJob)
This function formats the HTTP URL parameters.
|
protected String |
TemplateFaxJob2HTTPRequestConverter.formatTemplate(String template,
FaxJob faxJob)
This function formats the provided template.
|
protected FaxJobStatus |
HTTPFaxClientSpi.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 void |
HTTPFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
HTTPFaxClientSpi.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 HTTPResponse |
HTTPFaxClientSpi.submitHTTPRequest(FaxJob faxJob,
HTTPRequest httpRequest,
FaxActionType faxActionType)
Submits the HTTP request and returns the HTTP response.
|
protected void |
HTTPFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
void |
AbstractMappingHTTPResponseHandler.updateFaxJob(FaxJob faxJob,
HTTPResponse httpResponse,
FaxActionType faxActionType)
Updates the fax job based on the data from the HTTP response data.
|
void |
EmptyHTTPResponseHandler.updateFaxJob(FaxJob faxJob,
HTTPResponse httpResponse,
FaxActionType faxActionType)
Updates the fax job based on the data from the HTTP response data.
|
protected void |
HTTPFaxClientSpi.updateFaxJob(FaxJob faxJob,
HTTPResponse httpResponse,
FaxActionType faxActionType)
Updates the fax job based on the data from the HTTP response.
|
void |
HTTPResponseHandler.updateFaxJob(FaxJob faxJob,
HTTPResponse httpResponse,
FaxActionType faxActionType)
Updates the fax job based on the data from the HTTP response data.
|
Modifier and Type | Class and Description |
---|---|
class |
HylaFaxJob
This class provides the hylafax implementation of the fax job.
|
Modifier and Type | Method and Description |
---|---|
protected FaxJob |
HylaFaxClientSpi.createFaxJobImpl()
This function creates a new fax job instance to be used by the caller to submit a new fax job and so on.
|
Modifier and Type | Method and Description |
---|---|
protected void |
HylaFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected void |
HylaFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
HylaFaxClientSpi.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 |
HylaFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
Modifier and Type | Method and Description |
---|---|
protected javax.mail.Message |
InterfaxMailFaxClientSpi.createSubmitFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
Modifier and Type | Method and Description |
---|---|
protected void |
RFaxFaxClientSpi.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 |
RFaxFaxClientSpi.submitFaxJobViaFaxModem(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. |
Modifier and Type | Method and Description |
---|---|
protected String |
MacFaxClientSpi.createSubmitFaxCommand(FaxJob faxJob)
Creates and returns the submit fax command.
|
protected void |
MacFaxClientSpi.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. |
Modifier and Type | Method and Description |
---|---|
protected void |
PhaxioFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
PhaxioFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
Modifier and Type | Method and Description |
---|---|
protected void |
ProcessFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected String |
ProcessFaxClientSpi.createCancelFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
ProcessFaxClientSpi.createGetStatusFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
ProcessFaxClientSpi.createProcessCommand(Enum<?> templateNameEnum,
FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
ProcessFaxClientSpi.createResumeFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
ProcessFaxClientSpi.createSubmitFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
ProcessFaxClientSpi.createSuspendFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected ProcessExecutorHelper.ProcessOutput |
ProcessFaxClientSpi.executeProcess(FaxJob faxJob,
String command,
FaxActionType faxActionType)
Executes the process and returns the output.
|
protected String |
ProcessFaxClientSpi.formatTemplate(String template,
FaxJob faxJob)
This function formats the provided template.
|
protected FaxJobStatus |
ProcessFaxClientSpi.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 void |
ProcessFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
ProcessFaxClientSpi.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 |
ProcessFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
void |
ProcessOutputHandler.updateFaxJob(FaxClientSpi faxClientSpi,
FaxJob faxJob,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
Updates the fax job based on the data from the process output.
|
protected void |
ProcessFaxClientSpi.updateFaxJob(FaxJob faxJob,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
Updates the fax job based on the data from the process output.
|
Modifier and Type | Method and Description |
---|---|
protected void |
VBSFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected FaxJobStatus |
VBSFaxClientSpi.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 FaxJobStatus |
VBSFaxClientSpi.invokeExistingFaxJobAction(String scriptName,
FaxJob faxJob,
FaxActionType faxActionType)
Invokes a basic fax action
|
protected FaxJobStatus |
VBSFaxClientSpi.invokeScript(FaxJob faxJob,
String name,
Object[] input,
FaxActionType faxActionType)
Invokes the VB script and returns its output.
|
protected void |
VBSFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected Object[] |
VBSFaxClientSpi.setupSubmitFaxJobInput(FaxJob faxJob)
This function creates an input array with the needed info to submit a new fax job based on the provided data.
|
protected void |
VBSFaxClientSpi.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 |
VBSFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
void |
VBSProcessOutputHandler.updateFaxJob(FaxClientSpi faxClientSpi,
FaxJob faxJob,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
Updates the fax job based on the data from the process output.
|
Modifier and Type | Method and Description |
---|---|
protected void |
WindowsFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected void |
WindowsJNIFaxClientSpi.cancelFaxJobImpl(FaxJob faxJob)
This function will cancel an existing fax job.
|
protected String |
WindowsProcessFaxClientSpi.createCancelFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
WindowsProcessFaxClientSpi.createGetStatusFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
WindowsProcessFaxClientSpi.createProcessCommandArgumentsForExistingFaxJob(String faxActionTypeArgument,
FaxJob faxJob)
This function creates and returns the command line arguments for the fax4j external exe when running an action on
an existing fax job.
|
protected String |
WindowsProcessFaxClientSpi.createProcessCommandArgumentsForSubmitFaxJob(FaxJob faxJob)
This function creates and returns the command line arguments for the fax4j external exe when running the submit
fax job action.
|
protected String |
WindowsProcessFaxClientSpi.createResumeFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
WindowsProcessFaxClientSpi.createSubmitFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
WindowsProcessFaxClientSpi.createSuspendFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
static int |
WindowsFaxClientSpiHelper.getFaxJobID(FaxJob faxJob)
This function returns the fax job ID (if valid).
|
protected FaxJobStatus |
WindowsFaxClientSpi.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 FaxJobStatus |
WindowsJNIFaxClientSpi.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 void |
WindowsFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
WindowsJNIFaxClientSpi.resumeFaxJobImpl(FaxJob faxJob)
This function will resume an existing fax job.
|
protected void |
WindowsJNIFaxClientSpi.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 |
WindowsFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
protected void |
WindowsJNIFaxClientSpi.suspendFaxJobImpl(FaxJob faxJob)
This function will suspend an existing fax job.
|
void |
WindowsProcessOutputHandler.updateFaxJob(FaxClientSpi faxClientSpi,
FaxJob faxJob,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
Updates the fax job based on the data from the process output.
|
static void |
WindowsFaxClientSpiHelper.validateFaxJobID(FaxJob faxJob)
This function validates the provided fax job ID (not checking fax server, only format).
|
Modifier and Type | Method and Description |
---|---|
static String |
SpiUtil.formatTemplate(String template,
FaxJob faxJob,
org.fax4j.util.SpiUtil.TemplateParameterEncoder encoder,
boolean getFileContent,
boolean fullFilePath)
This function formats the provided template.
|
Copyright © 2009–2020 fax4j. All rights reserved.