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.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.http |
Provides the HTTP 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 |
---|---|
FaxJobStatus |
FaxMonitorEvent.getFaxJobStatus()
This function returns the fax job status.
|
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. |
static FaxJobStatus |
FaxJobStatus.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static FaxJobStatus[] |
FaxJobStatus.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
Constructor and Description |
---|
FaxMonitorEvent(FaxMonitorEvent.FaxMonitorEventID id,
FaxJob faxJob,
FaxJobStatus faxJobStatus)
This is the class constructor.
|
Modifier and Type | Method and Description |
---|---|
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. |
Modifier and Type | Method and Description |
---|---|
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. |
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Modifier and Type | Method and Description |
---|---|
FaxJobStatus |
AbstractMappingHTTPResponseHandler.getFaxJobStatus(HTTPResponse httpResponse)
This function extracts the fax job status from the HTTP response data.
|
FaxJobStatus |
EmptyHTTPResponseHandler.getFaxJobStatus(HTTPResponse httpResponse)
This function extracts the fax job status from the HTTP response data.
|
FaxJobStatus |
HTTPResponseHandler.getFaxJobStatus(HTTPResponse httpResponse)
This function extracts the fax job status from the HTTP response data.
|
protected FaxJobStatus |
AbstractMappingHTTPResponseHandler.getFaxJobStatusFromStatusString(String faxJobStatusStr)
This function returns the fax job status value based on the fax job status string value.
|
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. |
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractMappingHTTPResponseHandler.populateStatusString2FaxStatusMappings(FaxJobStatus[] faxJobStatuses,
Enum<?>[] configurationKeys)
This function populates the status strings to fax status enum values based on the configuration of the handler.
|
Modifier and Type | Method and Description |
---|---|
FaxJobStatus |
ProcessOutputHandler.getFaxJobStatus(FaxClientSpi faxClientSpi,
ProcessExecutorHelper.ProcessOutput processOutput)
This function extracts the fax job status from the process output.
|
protected FaxJobStatus |
ProcessFaxClientSpi.getFaxJobStatus(ProcessExecutorHelper.ProcessOutput processOutput)
This function extracts the fax job status from the process output.
|
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. |
Modifier and Type | Method and Description |
---|---|
FaxJobStatus |
VBSProcessOutputHandler.getFaxJobStatus(FaxClientSpi faxClientSpi,
ProcessExecutorHelper.ProcessOutput processOutput)
This function extracts the fax job status from the process output.
|
protected FaxJobStatus |
VBSProcessOutputHandler.getFaxJobStatusFromWindowsFaxJobStatusString(String faxJobStatusStr)
This function returns the fax job status based on the windows fax job status string value.
|
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.
|
Modifier and Type | Method and Description |
---|---|
FaxJobStatus |
WindowsProcessOutputHandler.getFaxJobStatus(FaxClientSpi faxClientSpi,
ProcessExecutorHelper.ProcessOutput processOutput)
This function extracts the fax job status from the process output.
|
static FaxJobStatus |
WindowsFaxClientSpiHelper.getFaxJobStatusFromWindowsFaxJobStatusString(String faxJobStatusStr)
This function returns the fax job status based on the windows fax job status string value.
|
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. |
Copyright © 2009–2020 fax4j. All rights reserved.