Skip navigation links

oracle.xdo.delivery
Class AbstractDeliveryRequest

java.lang.Object
oracle.xdo.delivery.DeliveryComponent
oracle.xdo.delivery.AbstractDeliveryRequest

All Implemented Interfaces:

DeliveryRequest, DeliveryStatusDefinitions

public abstract class AbstractDeliveryRequest

extends DeliveryComponent

implements DeliveryRequest

Abstract implementation of the DeliveryRequest. It implements all methods that are common to all types of delivery requests.

Author:

Kei Saito (kei.saito@oracle.com)

Field Summary

Fields inherited from class oracle.xdo.delivery.DeliveryComponent

RCS_ID

Fields inherited from interface oracle.xdo.delivery.DeliveryRequest

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

Constructor Summary

AbstractDeliveryRequest()
Default constructor

Method Summary

void	cancel() Cancels already submitted delivery request if handler supports cancellation.
void	close() Closes this request and frees all the resources.
java.io.File	getDocumentFile() Deprecated. It always returns null.
java.io.InputStream	getDocumentInputStream() Deprecated. It always returns null.
java.io.OutputStream	getDocumentOutputStream() Deprecated. It returns null.
DeliveryRequestHandler	getRequestHandler() Returns the delivery request handler.
int	getRequestId() Returns request ID <p/>
DeliveryResponse	getResponse()
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 document to the request.
void	setRequestId(int pRequestId) Sets request ID <p/>
void	setServer(java.lang.String pServerName) Sets the server name defined in the config file.
void	setStatus(int pStatus) Sets the request status
void	setStatusMessage(java.lang.String pStatusMessage) Sets the request status message.
DeliveryResponse	submit() Submits the request (Synchronus).
void	submit(DeliveryResponseListener pListener) <p/>
void	updateStatus()
void	validateProperties() Validates properties.

Methods inherited from class oracle.xdo.delivery.DeliveryComponent

addProperties, addProperties, addProperty, getBooleanProperty, getBooleanProperty, getIntegerProperty, getIntegerProperty, getProperties, getProperty, getStringProperty, removeProperty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.xdo.delivery.DeliveryRequest

getMandatoryProperties, getOptionalProperties

Constructor Detail

AbstractDeliveryRequest

public AbstractDeliveryRequest()

Default constructor

Method Detail

getStatus

public int getStatus()

Returns the request status. ,<p/>

Specified by:

getStatus in interface DeliveryRequest

Returns:

See Also:

DeliveryConstants, DeliveryRequest.getStatus()

setStatus

public void setStatus(int pStatus)

Sets the request status

Parameters:

pStatus - request status ID

See Also:

DeliveryConstants

getStatusMessage

public java.lang.String getStatusMessage()

Returns the request status message.

Specified by:

getStatusMessage in interface DeliveryRequest

Returns:

request status message

See Also:

DeliveryRequest.getStatusMessage()

setStatusMessage

public void setStatusMessage(java.lang.String pStatusMessage)

Sets the request status message.

Parameters:

pStatusMessage - request status message

getType

public java.lang.String getType()

Returns the request type. <p/>

Specified by:

getType in interface DeliveryRequest

Returns:

request type

See Also:

DeliveryRequest.getType()

getRequestId

public int getRequestId()

Returns request ID <p/>

Specified by:

getRequestId in interface DeliveryRequest

Returns:

request ID

See Also:

DeliveryRequest.getRequestId()

setRequestId

public void setRequestId(int pRequestId)

Sets request ID <p/>

Specified by:

setRequestId in interface DeliveryRequest

Parameters:

pRequestId - request ID

See Also:

DeliveryRequest.setRequestId(int)

getResponse

public DeliveryResponse getResponse()

setDocument

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

Sets document to the request. <p/>

Specified by:

setDocument in interface DeliveryRequest

Parameters:

pDocument - document data

pEncoding - Character encoding for the document.

Throws:

DeliveryException

See Also:

DeliveryRequest.setDocument(java.io.InputStream)

setDocument

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

Sets document to the request. <p/>

Specified by:

setDocument in interface DeliveryRequest

Parameters:

pDocument - document input stream

Throws:

DeliveryException

See Also:

DeliveryRequest.setDocument(java.io.InputStream)

getDocumentInputStream

public java.io.InputStream getDocumentInputStream()

Deprecated. It always returns null.

Returns the document input stream.

Returns:

document input stream

setDocument

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

Sets the document. <p/>

Specified by:

setDocument in interface DeliveryRequest

Parameters:

pFilename - document file name

Throws:

DeliveryException

See Also:

DeliveryRequest.setDocument(java.lang.String)

getDocumentFile

public java.io.File getDocumentFile()

Deprecated. It always returns null.

Returns the document file. <p/>

Returns:

document file

getRequestHandler

public DeliveryRequestHandler getRequestHandler()

Returns the delivery request handler. <p/>

Returns:

delivery request handler

getDocumentOutputStream

public java.io.OutputStream getDocumentOutputStream()
                                             throws DeliveryException

Deprecated. It returns null.

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. <p/>

Specified by:

getDocumentOutputStream in interface DeliveryRequest

Returns:

output stream

Throws:

DeliveryException

See Also:

DeliveryRequest.getDocumentOutputStream()

submit

public void submit(DeliveryResponseListener pListener)
            throws DeliveryException

<p/>

Specified by:

submit in interface DeliveryRequest

Parameters:

pListener -

Throws:

DeliveryException

See Also:

DeliveryRequest.submit(oracle.xdo.delivery.DeliveryResponseListener)

submit

public DeliveryResponse submit()
                        throws DeliveryException

Description copied from interface: DeliveryRequest

Submits the request (Synchronus). <p/>

Specified by:

submit in interface DeliveryRequest

Throws:

DeliveryException

validateProperties

public void validateProperties()
                        throws MissingRequiredPropertyException,
                               InvalidPropertyValueException,
                               UndefinedPropertyException

Validates properties. Internal use only . <p/>

Overrides:

validateProperties in class DeliveryComponent

Throws:

MissingRequiredPropertyException

InvalidPropertyValueException

UndefinedPropertyException

See Also:

oracle.xdo.delivery.PropertyHandler#validateProperties()

setServer

public void setServer(java.lang.String pServerName)

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

Specified by:

setServer in interface DeliveryRequest

Parameters:

pServerName - server name

getServer

public java.lang.String getServer()

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

Specified by:

getServer in interface DeliveryRequest

Returns:

server name

cancel

public void cancel()

Cancels already submitted delivery request if handler supports cancellation. <p/>

Specified by:

cancel in interface DeliveryRequest

close

public void close()

Closes this request and frees all the resources. Removes temporary files if exists. <p/>

Specified by:

close in interface DeliveryRequest

updateStatus

public void updateStatus()

Skip navigation links