public class WindowsProcessFaxClientSpi extends ProcessFaxClientSpi
Name | Description | Preconfigured Value | Default Value | Mandatory |
org.fax4j.spi.windows.server.name | The fax server host name. | none | none | false |
Modifier and Type | Class and Description |
---|---|
static class |
WindowsProcessFaxClientSpi.Fax4jExeConstants
This class holds the fax4j exe constants.
|
static class |
WindowsProcessFaxClientSpi.FaxClientSpiConfigurationConstants
This class holds the SPI configuration constants.
|
AbstractFaxClientSpi.FaxJobExtendedPropertyConstants
useWindowsCommandPrefix, WINDOWS_EXECUTE_PREFIX_DEFAULT_VALUE
Constructor and Description |
---|
WindowsProcessFaxClientSpi()
This is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addCommandLineArgument(StringBuilder buffer,
String argument,
String value)
This function adds the given command line argument to the buffer.
|
protected String |
createCancelFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
createGetStatusFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
createProcessCommand(String commandArguments)
This function creates and returns the fax4j.exe command.
|
protected String |
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 |
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 ProcessOutputHandler |
createProcessOutputHandler()
This function creates and returns the process output handler.
|
protected ProcessOutputValidator |
createProcessOutputValidator()
This function creates and returns the process output validator.
|
protected String |
createResumeFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
createSubmitFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
protected String |
createSuspendFaxJobProcessCommand(FaxJob faxJob)
Creates the process command from the fax job data.
|
String |
getPropertyPart()
Returns the property part.
Property parts enables to replace the input request key with the part defined to enable to reuse services with different configuration blocks. Property parts will be replaced with the {0} values in the key, for example org.fax4j.{0}.somekey with part abc will be replaced to org.fax4j.abc.somekey |
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.
|
cancelFaxJobImpl, createProcessCommand, executeProcess, formatTemplate, getFaxJobStatus, getFaxJobStatusImpl, getProcessOutputHandler, getProcessOutputValidator, getTemplate, resumeFaxJobImpl, submitFaxJobImpl, suspendFaxJobImpl, updateFaxJob, validateProcessOutput
getProvider, pollForFaxJobStatues, pollForFaxJobStatuesImpl
addFaxClientActionEventListener, addFaxMonitorEventListener, cancelFaxJob, createFaxJob, createFaxJobImpl, fireFaxEvent, fireFaxEvent, fireFaxMonitorEvent, getConfiguration, getConfigurationValue, getConfigurationValue, getFaxJobMonitor, getFaxJobStatus, getLogger, initialize, invokeFaxJobIDValidation, invokeFaxJobNullValidation, removeAllFaxClientActionEventListeners, removeAllFaxMonitorEventListeners, removeFaxClientActionEventListener, removeFaxMonitorEventListener, resumeFaxJob, submitFaxJob, suspendFaxJob, throwUnsupportedException
public WindowsProcessFaxClientSpi()
protected void initializeImpl()
initializeImpl
in class ProcessFaxClientSpi
public boolean isFaxMonitorEventsSupported()
isFaxMonitorEventsSupported
in interface FaxClientSpi
isFaxMonitorEventsSupported
in class AbstractFax4JClientSpi
public String getPropertyPart()
getPropertyPart
in interface ConfigurationHolder
getPropertyPart
in class ProcessFaxClientSpi
protected ProcessOutputValidator createProcessOutputValidator()
createProcessOutputValidator
in class ProcessFaxClientSpi
protected ProcessOutputHandler createProcessOutputHandler()
createProcessOutputHandler
in class ProcessFaxClientSpi
protected void addCommandLineArgument(StringBuilder buffer, String argument, String value)
buffer
- The bufferargument
- The argumentvalue
- The argument valueprotected String createProcessCommand(String commandArguments)
commandArguments
- The command line argumentsprotected String createProcessCommandArgumentsForSubmitFaxJob(FaxJob faxJob)
faxJob
- The fax job objectprotected String createProcessCommandArgumentsForExistingFaxJob(String faxActionTypeArgument, FaxJob faxJob)
faxActionTypeArgument
- The fax action type argumentfaxJob
- The fax job objectprotected String createSubmitFaxJobProcessCommand(FaxJob faxJob)
createSubmitFaxJobProcessCommand
in class ProcessFaxClientSpi
faxJob
- The fax job objectprotected String createSuspendFaxJobProcessCommand(FaxJob faxJob)
createSuspendFaxJobProcessCommand
in class ProcessFaxClientSpi
faxJob
- The fax job objectprotected String createResumeFaxJobProcessCommand(FaxJob faxJob)
createResumeFaxJobProcessCommand
in class ProcessFaxClientSpi
faxJob
- The fax job objectprotected String createCancelFaxJobProcessCommand(FaxJob faxJob)
createCancelFaxJobProcessCommand
in class ProcessFaxClientSpi
faxJob
- The fax job objectprotected String createGetStatusFaxJobProcessCommand(FaxJob faxJob)
createGetStatusFaxJobProcessCommand
in class ProcessFaxClientSpi
faxJob
- The fax job objectCopyright © 2009–2020 fax4j. All rights reserved.