|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
eFax Developer™
outbound processing.
See:
Description
Class Summary | |
---|---|
Base64Doc | Base64Doc |
DispositionCatcher | DispositionCatcher application interface |
DispositionCatcherServlet | DispositionCatcherServlet (Sample code) |
DocumentBundler | DocumentBundler |
EmailBundler | EmailBundler |
OutboundRequest | OutboundRequest application interface |
OutboundRequestServlet | OutboundRequestServlet (Sample code) |
OutboundResponse | OutboundResponse application interface |
StatusRequest | StatusRequest application interface |
StatusRequestServlet | StatusRequestServlet (Sample code) |
StatusResponse | StatusResponse application interface |
Java application interface for eFax Developer™ outbound processing.
Outbound Request
The client programmer will begin building their request by bundling all documents to be faxed using an instance of theDocumentBundler
class. If disposition emails are desired, the programmer can bundle disposition email addresses using an instance of theEmailBundler
class. The programmer creates a newOutboundRequest
instance and sets the request state via the object's various mutator methods. Finally, the programmer submits the outbound transmission request using the OutboundRequest object'ssendFax()
method and processes the response via theOutboundResponse
object's accessor methods.// Instantiate a new OutboundRequest object
OutboundRequest req = new OutboundRequest();
Set the OutboundRequest object's state...
// POST the outbound transmission request to eFax Developer
OutboundResponse response = req.sendFax();
Process the OutboundResponse...
Status Request
The client programmer can POST status requests to eFax Developer™ using the client's transmission identifier or the eFax Developer™ DOCID number as the search argument. The programmer creates a newStatusRequest
instance and sets the request state via the object's mutator methods. Finally, the programmer submits the status request using the StatusRequest object'sgetStatus()
method and processes the response via theStatusResponse
object's accessor methods.// Instantiate a new StatusRequest object
StatusRequest req = new StatusRequest()
Set the StatusRequest object's state...
// POST the status request to eFax Developer
StatusResponse response = req.getStatus();
Process the StatusResponse...
Outbound Disposition (DispositionCatcher)
Upon completion of the outbound transmission, eFax Developer™ can send an "Outbound Disposition" to a designated endpoint if one is specified in the OutboundRequest object'ssetDispositionURL(String)
. The processor that resides at the designated endpoint can use an instance of theDispositionCatcher
application interface to parse the XML-formatted content received from eFax Developer™ Outbound Services.// Instantiate a new DispositionCatcher instance
DispositionCatcher dc = new DispositionCatcher(request.getParameter("xml"));
Process the DispositionCatcher content...
|
||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |