org.adroitlogic.x.feature.filestore.impl

Class MessageFileFormat

java.lang.Object

org.adroitlogic.x.base.format.ResourceAwareMessageFormat<XMessageFileEntity>

org.adroitlogic.x.feature.filestore.impl.MessageFileFormat

All Implemented Interfaces:

org.adroitlogic.x.api.XMessageFormat<XMessageFileEntity>

public class MessageFileFormat
extends org.adroitlogic.x.base.format.ResourceAwareMessageFormat<XMessageFileEntity>

Payload format which uses XMessageFileEntity as the underlying resource.

Since:

17.01

Author:

Ruwan Linton

Constructor Summary

Constructors

Constructor and Description
MessageFileFormat(XMessageFileEntity content)
MessageFileFormat(org.adroitlogic.x.api.XMessage message, FileStoreFeature fileStore) Constructor which expects a XMessage MessageFileFormat by getting a file from fileStore

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Overriding equals to to ensure that any MessageFileFormat instances that are created for the same underlying file should be considered as the same object
int	hashCode() Overriding Hashcode to keep consistency
XMessageFileEntity	readAsNative()
InputStream	readAsStream()
String	readAsString(int maxLengthKbs)
long	size()
void	writeTo(OutputStream outputStream)

Methods inherited from class org.adroitlogic.x.base.format.ResourceAwareMessageFormat

copyOf, isAttachedToAMessage, markAsAttachedToaMessage, releaseResources

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageFileFormat

public MessageFileFormat(XMessageFileEntity content)

MessageFileFormat

public MessageFileFormat(org.adroitlogic.x.api.XMessage message,
                         FileStoreFeature fileStore)
                  throws org.adroitlogic.x.api.IntegrationRuntimeException

Constructor which expects a XMessage MessageFileFormat by getting a file from fileStore

Parameters:

message - Message for attaching the release hook

fileStore - the file-store feature to be used

Throws:

org.adroitlogic.x.api.IntegrationRuntimeException - will be thrown if a file cannot be provided by the file store at the moment

Method Detail

readAsStream

public InputStream readAsStream()

readAsString

public String readAsString(int maxLengthKbs)

readAsNative

public XMessageFileEntity readAsNative()

writeTo

public void writeTo(OutputStream outputStream)
             throws IOException

Throws:

IOException

size

public long size()

equals

public boolean equals(Object obj)

Overriding equals to to ensure that any MessageFileFormat instances that are created for the same underlying file should be considered as the same object

Overrides:

equals in class Object

Parameters:

obj - object to equals

Returns:

equalls result

hashCode

public int hashCode()

Overriding Hashcode to keep consistency

Overrides:

hashCode in class Object

Returns:

hash value