Package com.webmethods.jms.impl

Class WmFileMessageImpl

java.lang.Object

com.webmethods.jms.impl.WmMessageImpl

com.webmethods.jms.impl.WmFileMessageImpl

All Implemented Interfaces:

WmFileMessage, WmMessage, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, javax.jms.Message

public class WmFileMessageImpl
extends WmMessageImpl
implements WmFileMessage

Deprecated.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.webmethods.jms.impl.WmMessageImpl

_accessLabel, _acknowledged, _compression, _compressionLevel, _compressionManager, _container, _deliveryMode, _destination, _expiration, _messageId, _msgReadOnly, _priority, _readOnlyBody, _readOnlyProperties, _receiveCount, _redelivered, _replyTo, _sequenceNumber, _subscriptionIDs, _timestamp

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Fields inherited from interface com.webmethods.jms.WmMessage

WM_JMS_CLUSTER_NODES, WM_JMS_CLUSTER_NODES_DELIMITER

Constructor Summary

Constructors

Modifier	Constructor	Description
	WmFileMessageImpl()	Deprecated.
protected	WmFileMessageImpl(TransportMessage container)	Deprecated.

Method Summary

Modifier and Type	Method	Description
long	getBytesTransferred()	Deprecated. Gets the total number of bytes transferred.
java.lang.String	getFilename()	Deprecated. Get the name of the file associated with the message.
protected FileSender	getFileSender(javax.jms.Session session)	Deprecated.
int	getPacketSize()	Deprecated. Get the maximum number of bytes to read from the file at one time and send.
WmMessageProducer	getProducer()	Deprecated. Gets the producer with which the WmFileMessage is to be sent.
long	getRequestTimeout()	Deprecated. Get the transfer request timeout value.
long	getTransferTimeout()	Deprecated. Get the transfer timeout value.
void	saveFile(java.lang.String filename)	Deprecated. Once the message has been received this method is used to save the contents to the specified file.
void	setBytesTransferred(long bytesTransferred)	Deprecated. Sets the total number of bytes transferred.
void	setFilename(java.lang.String filename)	Deprecated. Set the name of the file associated with the message.
void	setPacketSize(int packetSize)	Deprecated. Set the maximum number of bytes to read from the file at one time and send.
void	setProducer(WmMessageProducer producer)	Deprecated. Sets the producer with which the WmFileMessage is to be sent.
void	setRequestTimeout(long timeout)	Deprecated. Set the transfer request timeout value.
void	setTransferTimeout(long timeout)	Deprecated. Set the transfer timeout value.

Methods inherited from class com.webmethods.jms.impl.WmMessageImpl

acknowledge, checkMessageBodyReadStatus, checkMessageBodyWriteStatus, checkMessagePropertiesReadStatus, checkMessagePropertiesWriteStatus, checkMessageReadStatus, checkMessageWriteStatus, checkObject, checkString, clearBody, clearProperties, createMessage, equals, explicitAcknowledge, getAccessLabel, getBooleanProperty, getByteProperty, getCompression, getCompressionLevel, getCompressionRatio, getConsumer, getDestinationId, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSMessageIDHint, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPreAcknowledgement, getPropertyNames, getReceiveCount, getSequenceNumber, getShortProperty, getSize, getStringProperty, getSubscriptionIDs, getTopicName, getTransactionID, getTransportData, getTransportDataLength, getTransportTypeName, getUUID, hashCode, hashObject, internalToString, isAcknowledged, isPreAcked, negativeAcknowledge, prepareMsgForTransport, propertyExists, readExternal, setAccessLabel, setAcknowledged, setBooleanProperty, setByteProperty, setCompression, setCompressionLevel, setConsumer, setDeliveryCount, setDeliveryMode, setDestination, setDestinationId, setDoubleProperty, setExpiration, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSMessageIDHint, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setMessageID, setObjectProperty, setPreAcknowledgement, setPriority, setReadOnly, setReadOnlyBody, setReadOnlyProperties, setReceiveCount, setSequenceNumber, setShortProperty, setStringProperty, setSubscriptionIDs, setTimestamp, setTopicName, setTransactionID, setTransportTypeName, setUUID, toString, writeExternal, xdump

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.jms.Message

acknowledge, clearBody, clearProperties, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

Methods inherited from interface com.webmethods.jms.WmMessage

explicitAcknowledge, getCompression, getCompressionLevel, getCompressionRatio, getSize, negativeAcknowledge, setAccessLabel, setCompression, setCompressionLevel

Constructor Detail

WmFileMessageImpl

public WmFileMessageImpl()
                  throws javax.jms.JMSException

Deprecated.

Throws:

javax.jms.JMSException

WmFileMessageImpl

protected WmFileMessageImpl(TransportMessage container)

Deprecated.

Method Detail

setFilename

public void setFilename(java.lang.String filename)
                 throws java.io.FileNotFoundException,
                        javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Set the name of the file associated with the message.

This method is used to specify which file is to be streamed when the message is sent.

Specified by:

setFilename in interface WmFileMessage

Parameters:

filename - The name of the file associated with the message.

Throws:

java.io.FileNotFoundException - If the file is invalid.

javax.jms.JMSException - If unable to set the name of the file.

getFilename

public java.lang.String getFilename()
                             throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Get the name of the file associated with the message.

If this message has been received by a message consumer then this method will return only the file's name without the path. Otherwise, this method will return the fully qualified file's name including the path.

Specified by:

getFilename in interface WmFileMessage

Returns:

The name of the file associated with the message.

Throws:

javax.jms.JMSException - If unable to get the name of the file.

saveFile

public void saveFile(java.lang.String filename)
              throws java.io.FileNotFoundException,
                     javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Once the message has been received this method is used to save the contents to the specified file. This method will block until the transfer has completed.

Specified by:

saveFile in interface WmFileMessage

Parameters:

filename - The location to save the file.

Throws:

java.io.FileNotFoundException - If the file is invalid.

javax.jms.JMSException - If unable to save the file.

setPacketSize

public void setPacketSize(int packetSize)
                   throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Set the maximum number of bytes to read from the file at one time and send.

Specified by:

setPacketSize in interface WmFileMessage

Parameters:

packetSize - The maximum number of bytes to read and send.

Throws:

javax.jms.JMSException - If unable to set the packet size.

getPacketSize

public int getPacketSize()
                  throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Get the maximum number of bytes to read from the file at one time and send.

Specified by:

getPacketSize in interface WmFileMessage

Returns:

The maximum number of bytes to read and send.

Throws:

javax.jms.JMSException - If unable to get the packet size.

setTransferTimeout

public void setTransferTimeout(long timeout)
                        throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Set the transfer timeout value.

The producer uses this timeout value to indicate how long to wait for a packet acknowledgement from the consumers.

The consumer uses this timeout value to indicate how long to wait for the next packet from the producer.

The default value is 15000 milliseconds. A timeout of zero never expires.

Specified by:

setTransferTimeout in interface WmFileMessage

Parameters:

timeout - The transfer timeout value in milliseconds.

Throws:

javax.jms.JMSException - If unable to set the timeout.

getTransferTimeout

public long getTransferTimeout()
                        throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Get the transfer timeout value.

Specified by:

getTransferTimeout in interface WmFileMessage

Returns:

The transfer timeout value in milliseconds.

Throws:

javax.jms.JMSException - If unable to get the timeout.

setRequestTimeout

public void setRequestTimeout(long timeout)
                       throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Set the transfer request timeout value. The producer uses this timeout value to indicate how long to wait for transfer requests from consumers.

The default value is 15000 milliseconds. A timeout of zero never expires.

Specified by:

setRequestTimeout in interface WmFileMessage

Parameters:

timeout - The request timeout value in milliseconds.

Throws:

javax.jms.JMSException - If unable to set the timeout

getRequestTimeout

public long getRequestTimeout()
                       throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Get the transfer request timeout value.

Specified by:

getRequestTimeout in interface WmFileMessage

Returns:

The transfer request timeout value in milliseconds.

Throws:

javax.jms.JMSException - If unable to get the timeout.

setBytesTransferred

public void setBytesTransferred(long bytesTransferred)
                         throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Sets the total number of bytes transferred.

This value is set by the JMS provider once the transfer has completed.

Specified by:

setBytesTransferred in interface WmFileMessage

Throws:

javax.jms.JMSException

getBytesTransferred

public long getBytesTransferred()
                         throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Gets the total number of bytes transferred.

Specified by:

getBytesTransferred in interface WmFileMessage

Returns:

The total number of bytes transferred.

Throws:

javax.jms.JMSException - If unable to get the number of bytes transferred.

getFileSender

protected FileSender getFileSender(javax.jms.Session session)
                            throws javax.jms.JMSException

Deprecated.

Throws:

javax.jms.JMSException

setProducer

public void setProducer(WmMessageProducer producer)
                 throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Sets the producer with which the WmFileMessage is to be sent.

Specified by:

setProducer in interface WmFileMessage

Throws:

javax.jms.JMSException

getProducer

public WmMessageProducer getProducer()
                              throws javax.jms.JMSException

Deprecated.

Description copied from interface: WmFileMessage

Gets the producer with which the WmFileMessage is to be sent.

Specified by:

getProducer in interface WmFileMessage

Throws:

javax.jms.JMSException