Package org.apache.activemq.openwire

Class OpenWireFormat

java.lang.Object

org.apache.activemq.openwire.OpenWireFormat

All Implemented Interfaces:

WireFormat

public final class OpenWireFormat
extends Object
implements WireFormat

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_LEGACY_VERSION
static long	DEFAULT_MAX_FRAME_SIZE
static int	DEFAULT_STORE_VERSION
static int	DEFAULT_WIRE_VERSION

Constructor Summary

Constructors

Constructor	Description
OpenWireFormat()
OpenWireFormat(int i)

Method Summary

Modifier and Type	Method	Description
Short	addToMarshallCache(DataStructure o)
OpenWireFormat	copy()
boolean	equals(Object object)
DataStructure	getFromUnmarshallCache(short index)
Short	getMarshallCacheIndex(DataStructure o)
long	getMaxFrameSize()
WireFormatInfo	getPreferedWireFormatInfo()
int	getVersion()
int	hashCode()
boolean	isCacheEnabled()
boolean	isMaxFrameSizeEnabled()
boolean	isSizePrefixDisabled()
boolean	isStackTraceEnabled()
boolean	isTcpNoDelayEnabled()
boolean	isTightEncodingEnabled()
void	looseMarshalNestedObject(DataStructure o, DataOutput dataOut)
DataStructure	looseUnmarshalNestedObject(DataInput dis)
ByteSequence	marshal(Object command)	Packet based marshaling
void	marshal(Object o, DataOutput dataOut)	Stream based marshaling
protected int	min(int version1, int version2)
protected long	min(long version1, long version2)
void	renegotiateWireFormat(WireFormatInfo info)
void	runMarshallCacheEvictionSweep()
void	setCacheEnabled(boolean cacheEnabled)
void	setInUnmarshallCache(short index, DataStructure o)
void	setMaxFrameSize(long maxFrameSize)
void	setMaxFrameSizeEnabled(boolean maxFrameSizeEnabled)	Set whether the maxFrameSize check will be enabled.
void	setPreferedWireFormatInfo(WireFormatInfo info)
void	setSizePrefixDisabled(boolean prefixPacketSize)
void	setStackTraceEnabled(boolean b)
void	setTcpNoDelayEnabled(boolean tcpNoDelayEnabled)
void	setTightEncodingEnabled(boolean tightEncodingEnabled)
void	setVersion(int version)	Allows you to dynamically switch the version of the openwire protocol being used.
int	tightMarshal1(Object o, BooleanStream bs)	Used by NIO or AIO transports
void	tightMarshal2(Object o, DataOutput ds, BooleanStream bs)	Used by NIO or AIO transports; note that the size is not written as part of this method.
int	tightMarshalNestedObject1(DataStructure o, BooleanStream bs)
void	tightMarshalNestedObject2(DataStructure o, DataOutput ds, BooleanStream bs)
DataStructure	tightUnmarshalNestedObject(DataInput dis, BooleanStream bs)
String	toString()
Object	unmarshal(DataInput dis)	Packet based un-marshaling
Object	unmarshal(ByteSequence sequence)	Packet based un-marshaling

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STORE_VERSION

public static final int DEFAULT_STORE_VERSION

See Also:

Constant Field Values

DEFAULT_WIRE_VERSION

public static final int DEFAULT_WIRE_VERSION

See Also:

Constant Field Values

DEFAULT_LEGACY_VERSION

public static final int DEFAULT_LEGACY_VERSION

See Also:

Constant Field Values

DEFAULT_MAX_FRAME_SIZE

public static final long DEFAULT_MAX_FRAME_SIZE

See Also:

Constant Field Values

Constructor Detail

OpenWireFormat

public OpenWireFormat()

OpenWireFormat

public OpenWireFormat(int i)

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copy

public OpenWireFormat copy()

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getVersion

public int getVersion()

Specified by:

getVersion in interface WireFormat

Returns:

the version of the wire format

marshal

public ByteSequence marshal(Object command)
                     throws IOException

Description copied from interface: WireFormat

Packet based marshaling

Specified by:

marshal in interface WireFormat

Throws:

IOException

unmarshal

public Object unmarshal(ByteSequence sequence)
                 throws IOException

Description copied from interface: WireFormat

Packet based un-marshaling

Specified by:

unmarshal in interface WireFormat

Throws:

IOException

marshal

public void marshal(Object o,
                    DataOutput dataOut)
             throws IOException

Description copied from interface: WireFormat

Stream based marshaling

Specified by:

marshal in interface WireFormat

Throws:

IOException

unmarshal

public Object unmarshal(DataInput dis)
                 throws IOException

Description copied from interface: WireFormat

Packet based un-marshaling

Specified by:

unmarshal in interface WireFormat

Throws:

IOException

tightMarshal1

public int tightMarshal1(Object o,
                         BooleanStream bs)
                  throws IOException

Used by NIO or AIO transports

Throws:

IOException

tightMarshal2

public void tightMarshal2(Object o,
                          DataOutput ds,
                          BooleanStream bs)
                   throws IOException

Used by NIO or AIO transports; note that the size is not written as part of this method.

Throws:

IOException

setVersion

public void setVersion(int version)

Allows you to dynamically switch the version of the openwire protocol being used.

Specified by:

setVersion in interface WireFormat

Parameters:

version -

tightMarshalNestedObject1

public int tightMarshalNestedObject1(DataStructure o,
                                     BooleanStream bs)
                              throws IOException

Throws:

IOException

tightMarshalNestedObject2

public void tightMarshalNestedObject2(DataStructure o,
                                      DataOutput ds,
                                      BooleanStream bs)
                               throws IOException

Throws:

IOException

tightUnmarshalNestedObject

public DataStructure tightUnmarshalNestedObject(DataInput dis,
                                                BooleanStream bs)
                                         throws IOException

Throws:

IOException

looseUnmarshalNestedObject

public DataStructure looseUnmarshalNestedObject(DataInput dis)
                                         throws IOException

Throws:

IOException

looseMarshalNestedObject

public void looseMarshalNestedObject(DataStructure o,
                                     DataOutput dataOut)
                              throws IOException

Throws:

IOException

runMarshallCacheEvictionSweep

public void runMarshallCacheEvictionSweep()

getMarshallCacheIndex

public Short getMarshallCacheIndex(DataStructure o)

addToMarshallCache

public Short addToMarshallCache(DataStructure o)

setInUnmarshallCache

public void setInUnmarshallCache(short index,
                                 DataStructure o)

getFromUnmarshallCache

public DataStructure getFromUnmarshallCache(short index)

setStackTraceEnabled

public void setStackTraceEnabled(boolean b)

isStackTraceEnabled

public boolean isStackTraceEnabled()

isTcpNoDelayEnabled

public boolean isTcpNoDelayEnabled()

setTcpNoDelayEnabled

public void setTcpNoDelayEnabled(boolean tcpNoDelayEnabled)

isCacheEnabled

public boolean isCacheEnabled()

setCacheEnabled

public void setCacheEnabled(boolean cacheEnabled)

isTightEncodingEnabled

public boolean isTightEncodingEnabled()

setTightEncodingEnabled

public void setTightEncodingEnabled(boolean tightEncodingEnabled)

isSizePrefixDisabled

public boolean isSizePrefixDisabled()

setSizePrefixDisabled

public void setSizePrefixDisabled(boolean prefixPacketSize)

setPreferedWireFormatInfo

public void setPreferedWireFormatInfo(WireFormatInfo info)

getPreferedWireFormatInfo

public WireFormatInfo getPreferedWireFormatInfo()

getMaxFrameSize

public long getMaxFrameSize()

setMaxFrameSize

public void setMaxFrameSize(long maxFrameSize)

isMaxFrameSizeEnabled

public boolean isMaxFrameSizeEnabled()

setMaxFrameSizeEnabled

public void setMaxFrameSizeEnabled(boolean maxFrameSizeEnabled)

Set whether the maxFrameSize check will be enabled. Note this is only applied to this format and will NOT be negotiated

Parameters:

maxFrameSizeEnabled -

renegotiateWireFormat

public void renegotiateWireFormat(WireFormatInfo info)
                           throws IOException

Throws:

IOException

min

protected int min(int version1,
                  int version2)

min

protected long min(long version1,
                   long version2)