Skip navigation links

oracle.xdo.delivery
Interface DeliveryRequest

All Superinterfaces:

DeliveryStatusDefinitions

All Known Implementing Classes:

AbstractDeliveryRequest

public interface DeliveryRequest

extends DeliveryStatusDefinitions

Delivery request internface.

Author:

Kei Saito (kei.saito@oracle.com)

Field Summary

static java.lang.String

RCS_ID

Fields inherited from interface oracle.xdo.delivery.DeliveryStatusDefinitions

STATUS_CLIENT_IN_PROCESS, STATUS_FAILED_BUSY, STATUS_FAILED_CLIENT_ERROR, STATUS_FAILED_INVALID_RECIPIENT, STATUS_FAILED_INVALID_REQUEST, STATUS_FAILED_INVALID_USER, STATUS_FAILED_IO_ERROR, STATUS_FAILED_SERVER_ERROR, STATUS_FAILED_TIMEOUT, STATUS_NOT_DELIVERED, STATUS_SERVER_IN_PROCESS, STATUS_SUCCESSFUL, STATUS_SUCCESSFUL_WITH_WARNINGS

Method Summary

void	cancel() Cancels already submitted delivery request.
void	close() Closes this request and frees all the resources.
java.io.OutputStream	getDocumentOutputStream() Deprecated. Please use setDocument() to set the document.
java.lang.String[]	getMandatoryProperties() Returns the list of mandatory properties.
java.lang.String[]	getOptionalProperties() Returns the list of optional properties.
int	getRequestId() Returns request ID <p/>
java.lang.String	getServer() Returns the server name set by setServer().
int	getStatus() Returns the request status.
java.lang.String	getStatusMessage() Returns the request status message.
java.lang.String	getType() Returns the request type.
void	setDocument(java.io.InputStream pDocument) Sets document to the request.
void	setDocument(java.lang.String pFilename) Sets the document.
void	setDocument(java.lang.String pDocument, java.lang.String pEncoding) Sets the document.
void	setRequestId(int pRequestId) Sets request ID <p/>
void	setServer(java.lang.String pServerName) Sets the server name defined in the config file.
DeliveryResponse	submit() Submits the request (Synchronus).
void	submit(DeliveryResponseListener pListener) Submits the request (Asynchronus).

Field Detail

RCS_ID

static final java.lang.String RCS_ID

See Also:

Constant Field Values

Method Detail

getType

java.lang.String getType()

Returns the request type. <p/>

Returns:

request type

getStatus

int getStatus()

Returns the request status. <p/>

Returns:

request status ID

See Also:

DeliveryConstants

getStatusMessage

java.lang.String getStatusMessage()

Returns the request status message.

Returns:

request status message

getDocumentOutputStream

java.io.OutputStream getDocumentOutputStream()
                                             throws DeliveryException

Deprecated. Please use setDocument() to set the document.

Returns the output stream that you can write the document contents to send. Note that this method will open the connection to the destination so you need to set all the information for this request before calling this method. <p/> Once you write out all the document data to the output stream, you can call submit() method to finish the request.

Returns:

output stream that you can write the contents of the document.

Throws:

DeliveryException

setDocument

void setDocument(java.io.InputStream pDocument)
                 throws DeliveryException

Sets document to the request. <p/>

Parameters:

pDocument - document input stream

Throws:

DeliveryException

setDocument

void setDocument(java.lang.String pFilename)
                 throws DeliveryException

Sets the document. <p/>

Parameters:

pFilename - document file name

Throws:

DeliveryException

setDocument

void setDocument(java.lang.String pDocument,
                 java.lang.String pEncoding)
                 throws DeliveryException

Sets the document. <p/> You can pass the document content with a String object. For the encoding parameter, you should pass one of the character encodings supported in Java. Please see the list of supported encodings in the Java documentation for more detail. If you pass null, the default value ("UTF-8") will be used. <p/>

Parameters:

pDocument - document data in a String

pEncoding - Character encoding for the document.

Throws:

DeliveryException

setRequestId

void setRequestId(int pRequestId)

Sets request ID <p/>

Parameters:

pRequestId - request ID

getRequestId

int getRequestId()

Returns request ID <p/>

Returns:

request ID

submit

DeliveryResponse submit()
                        throws DeliveryException

Submits the request (Synchronus). <p/>

Throws:

DeliveryException

submit

void submit(DeliveryResponseListener pListener)
            throws DeliveryException

Submits the request (Asynchronus). <p/>

Parameters:

pListener -

Throws:

DeliveryException

setServer

void setServer(java.lang.String pServerName)

Sets the server name defined in the config file. <p/>

Parameters:

pServerName - server name

getServer

java.lang.String getServer()

Returns the server name set by setServer(). <p/>

Returns:

server name

close

void close()

Closes this request and frees all the resources. <p/>

getMandatoryProperties

java.lang.String[] getMandatoryProperties()

Returns the list of mandatory properties. <p/>

Returns:

getOptionalProperties

java.lang.String[] getOptionalProperties()

Returns the list of optional properties. <p/>

Returns:

cancel

void cancel()

Cancels already submitted delivery request. <p/>

Skip navigation links