Visit Platform at http://www.platform.com

Platform Symphony 4.1 Java API Reference

com.platform.symphony.soam
Class DefaultByteArrayMessage

java.lang.Object
  extended by com.platform.symphony.soam.Message
      extended by com.platform.symphony.soam.DefaultByteArrayMessage

public class DefaultByteArrayMessage
extends Message

This represents a default implementation for developers requiring a convenient way to pass binary data between a client and a service without creating their own implementation. This object is not thread safe, therefore the developer is responsible for any synchronization required. This message can be used in applications that have a "cross-platform" implementation. (i.e. client and service may be implemented in different supported languages)

See Also:
Message

Constructor Summary
DefaultByteArrayMessage()
          Default Constructor
DefaultByteArrayMessage(byte[] byteArray)
          Additioanal constructor for the DefaultByteArrayMessage object.
 
Method Summary
 byte[] getByteArray()
          This method allows the developer to retrieve the internal byte array within the message.
 void onDeserialize(InputStream stream)
          This method will be called during de-serialization of the message.
 void onSerialize(OutputStream stream)
          This method will be called during serialization of the message.
 void setByteArray(byte[] byteArray)
          This method allows the developer to set the internal byte array within the message.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultByteArrayMessage

public DefaultByteArrayMessage()
Default Constructor


DefaultByteArrayMessage

public DefaultByteArrayMessage(byte[] byteArray)
Additioanal constructor for the DefaultByteArrayMessage object.

Parameters:
byteArray - The byte array to be associated with this message.
Method Detail

onSerialize

public void onSerialize(OutputStream stream)
                 throws SoamException
This method will be called during serialization of the message.

Specified by:
onSerialize in class Message
Parameters:
stream - The stream to which the object is being serialized.
Throws:
SoamException

onDeserialize

public void onDeserialize(InputStream stream)
                   throws SoamException
This method will be called during de-serialization of the message.

Specified by:
onDeserialize in class Message
Parameters:
stream - The stream from which the object is being de-serialized.
Throws:
SoamException

setByteArray

public void setByteArray(byte[] byteArray)
This method allows the developer to set the internal byte array within the message.

Parameters:
byteArray - The binary message to be associated with the DefaultByteArrayMessage.

getByteArray

public byte[] getByteArray()
This method allows the developer to retrieve the internal byte array within the message.

Returns:
The byte array.

Version 4.1
Date Modified: -DREL_DATE=Nov 03 2008
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2008 Platform Computing Corporation. All rights reserved.