Package | Description |
---|---|
org.fax4j.common |
Contains common internal classes used by the fax4j library.
|
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.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.
|
Modifier and Type | Method and Description |
---|---|
static FaxActionType |
FaxActionType.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static FaxActionType[] |
FaxActionType.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
Modifier and Type | Method and Description |
---|---|
protected Map<FaxActionType,String> |
HoiioFaxClientSpi.initializeFaxActionType2ResourceMap()
This function initializes the fax action type to resource mappings.
|
Modifier and Type | Method and Description |
---|---|
protected Map<FaxActionType,String> |
HTTPFaxClientSpi.initializeFaxActionType2ResourceMap()
This function initializes the fax action type to resource mappings.
|
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 HTTPRequest |
MultiPartFaxJob2HTTPRequestConverter.createCommonHTTPRequest(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType)
Creates a HTTP request with the common 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 String |
TemplateFaxJob2HTTPRequestConverter.formatHTTPResource(HTTPFaxClientSpi faxClientSpi,
FaxActionType faxActionType,
FaxJob faxJob)
This function formats the HTTP resource.
|
protected String |
HTTPFaxClientSpi.getHTTPResource(FaxActionType faxActionType)
This function returns the HTTP resource.
|
HTTPClient.HTTPMethod |
CommonHTTPClientConfiguration.getMethod(FaxActionType faxActionType)
This function returns the HTTP method based on the provided fax action type.
|
HTTPClient.HTTPMethod |
HTTPClientConfiguration.getMethod(FaxActionType faxActionType)
This function returns the HTTP method based on the provided fax action type.
|
protected String |
AbstractMappingHTTPResponseHandler.getPathToResponseData(FaxActionType faxActionType)
This function returns the path to the relevant response data.
|
protected void |
AbstractMappingHTTPResponseHandler.populateFaxActionType2ReponseDataPathMappings(FaxActionType[] faxActionTypes,
Enum<?>[] configurationKeys)
This function populates the fax action type to response data path mappings based on the configuration of the
handler.
|
void |
CommonHTTPClientConfiguration.setMethod(FaxActionType faxActionType,
HTTPClient.HTTPMethod httpMethod)
This function sets the HTTP method based on the provided fax action type.
|
protected HTTPResponse |
HTTPFaxClientSpi.submitHTTPRequest(FaxJob faxJob,
HTTPRequest httpRequest,
FaxActionType faxActionType)
Submits the HTTP request and returns the HTTP response.
|
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 | Method and Description |
---|---|
protected ProcessExecutorHelper.ProcessOutput |
MacFaxClientSpi.executeProcess(String command,
FaxActionType faxActionType)
This function executes the external command to send the fax.
|
Modifier and Type | Method and Description |
---|---|
protected Map<FaxActionType,String> |
PhaxioFaxClientSpi.initializeFaxActionType2ResourceMap()
This function initializes the fax action type to resource mappings.
|
Modifier and Type | Method and Description |
---|---|
protected ProcessExecutorHelper.ProcessOutput |
ProcessFaxClientSpi.executeProcess(FaxJob faxJob,
String command,
FaxActionType faxActionType)
Executes the process and returns the output.
|
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.
|
void |
ExitCodeProcessOutputValidator.validateProcessOutput(FaxClientSpi faxClientSpi,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
This function validates the process output for errors.
If not valid, an exception should be thrown. |
void |
ProcessOutputValidator.validateProcessOutput(FaxClientSpi faxClientSpi,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
This function validates the process output for errors.
If not valid, an exception should be thrown. |
protected void |
ProcessFaxClientSpi.validateProcessOutput(ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
This function validates the process output for errors.
If not valid, an exception should be thrown. |
Modifier and Type | Method and Description |
---|---|
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.
|
void |
VBSProcessOutputHandler.updateFaxJob(FaxClientSpi faxClientSpi,
FaxJob faxJob,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
Updates the fax job based on the data from the process output.
|
void |
VBSProcessOutputValidator.validateProcessOutput(FaxClientSpi faxClientSpi,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
This function validates the process output for errors.
If not valid, an exception should be thrown. |
Modifier and Type | Method and Description |
---|---|
void |
WindowsProcessOutputHandler.updateFaxJob(FaxClientSpi faxClientSpi,
FaxJob faxJob,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
Updates the fax job based on the data from the process output.
|
void |
WindowsProcessOutputValidator.validateProcessOutput(FaxClientSpi faxClientSpi,
ProcessExecutorHelper.ProcessOutput processOutput,
FaxActionType faxActionType)
This function validates the process output for errors.
If not valid, an exception should be thrown. |
Copyright © 2009–2020 fax4j. All rights reserved.