Package com.tangosol.coherence.servlet

Class OptimizedHolder

java.lang.Object

com.tangosol.util.Base

com.tangosol.coherence.servlet.AttributeHolder

com.tangosol.coherence.servlet.OptimizedHolder

All Implemented Interfaces:

ExternalizableLite, Externalizable, Serializable

Direct Known Subclasses:

SplittableHolder

public class OptimizedHolder
extends AttributeHolder
implements ExternalizableLite

An immutable object to hold attribute values and related information.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.tangosol.util.Base

Base.LoggingWriter

Field Summary

Fields inherited from class com.tangosol.util.Base

LOG_ALWAYS, LOG_CONFIG, LOG_DEBUG, LOG_ERR, LOG_INFO, LOG_MAX, LOG_MIN, LOG_QUIET, LOG_WARN, POWER_0, POWER_G, POWER_K, POWER_M, POWER_T, UNIT_D, UNIT_H, UNIT_M, UNIT_MS, UNIT_NS, UNIT_S, UNIT_US

Constructor Summary

Constructors

Constructor	Description
OptimizedHolder()	Default constructor is required for deserialization purposes.
OptimizedHolder(TraditionalHttpSessionModel model)	Default constructor is required for deserialization purposes.
OptimizedHolder(String sName, Object oValue, TraditionalHttpSessionModel model)	Construct an OptimizedHolder for a value.

Method Summary

Modifier and Type	Method	Description
protected Object	deserializeValue(Binary bin)	Take the Binary form of the attribute value and turn it into the object value.
protected Binary	ensureInternalBinary()	Obtain the non-null internally managed binary value.
Binary	getBinary()	Obtain the binary form of the value.
protected Binary	getInternalBinary()	Obtain the internally managed binary value.
Object	getValue()	Obtain the object form of the value.
protected void	prepareWrite()	Called to test serialization; if the holder cannot serialize its value, it should throw an IOException at this point.
protected Binary	readBinary(DataInput in)	Read the binary value.
void	readExternal(DataInput in)	Helper to read the object state from a stream.
protected Binary	serializeValue(Object o)	Take the passed object and turn it into a Binary value.
protected void	setInternalBinary(Binary binValue)	Store the internally managed binary value.
protected void	writeBinary(DataOutput out)	Write the binary value.
void	writeExternal(DataOutput out)	Helper to write the object state to a stream.

Methods inherited from class com.tangosol.coherence.servlet.AttributeHolder

flush, getInternalValue, getModel, getName, isActivationListener, isBindingListener, isEnableSuspectAttributes, isLocal, isSuspect, isSuspect, onBound, onUnbound, readExternal, setInternalValue, setLocal, setModel, setSuspect, writeExternal

Methods inherited from class com.tangosol.util.Base

azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mergeArray, mergeBooleanArray, mergeByteArray, mergeCharArray, mergeDoubleArray, mergeFloatArray, mergeIntArray, mergeLongArray, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, wait

Methods inherited from class java.lang.Object

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

Constructor Detail

OptimizedHolder

public OptimizedHolder()

Default constructor is required for deserialization purposes.

OptimizedHolder

public OptimizedHolder(TraditionalHttpSessionModel model)

Default constructor is required for deserialization purposes.

Parameters:

model - the traditional http session model

OptimizedHolder

public OptimizedHolder(String sName,
                       Object oValue,
                       TraditionalHttpSessionModel model)

Construct an OptimizedHolder for a value.

Parameters:

sName - the attribute name

oValue - the value of the attribute; not null

model - the traditional http session model

Method Detail

getValue

public Object getValue()

Obtain the object form of the value.

Overrides:

getValue in class AttributeHolder

Returns:

the object form of the value

getBinary

public Binary getBinary()

Obtain the binary form of the value. Failure to serialize the value, if serialization is necessary, will result in a runtime exception.

Returns:

the binary form of the value

readExternal

public void readExternal(DataInput in)
                  throws IOException

Helper to read the object state from a stream.

Specified by:

readExternal in interface ExternalizableLite

Overrides:

readExternal in class AttributeHolder

Parameters:

in - the stream to read data from in order to restore the object

Throws:

IOException - if an I/O exception occurs

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Helper to write the object state to a stream.

Specified by:

writeExternal in interface ExternalizableLite

Overrides:

writeExternal in class AttributeHolder

Parameters:

out - the stream to write the object to

Throws:

IOException - if an I/O exception occurs

getInternalBinary

protected Binary getInternalBinary()

Obtain the internally managed binary value.

Returns:

the cached binary form of the value, or null if it has not been lazily serialized

ensureInternalBinary

protected Binary ensureInternalBinary()

Obtain the non-null internally managed binary value. This method allows sub-classes to lazily load the cached binary.

This method is explicitly NOT a "MAKE BINARY OUT OF VALUE" method. It is only intended to allow lazy loading of the pre-existing binary value, for example from a distributed cache.

Returns:

the binary form of the value, but never null

setInternalBinary

protected void setInternalBinary(Binary binValue)

Store the internally managed binary value.

Parameters:

binValue - the binary form of the value

serializeValue

protected Binary serializeValue(Object o)

Take the passed object and turn it into a Binary value.

Parameters:

o - the object to serialize

Returns:

the binary value of the attribute

deserializeValue

protected Object deserializeValue(Binary bin)

Take the Binary form of the attribute value and turn it into the object value.

Parameters:

bin - the binary value to deserialize

Returns:

the object value of the attribute

prepareWrite

protected void prepareWrite()
                     throws IOException

Called to test serialization; if the holder cannot serialize its value, it should throw an IOException at this point. Note that this method should only be called as part of the "write" processing for the model, as the holder will expect an immediate follow-up call to actually write itself out.

Overrides:

prepareWrite in class AttributeHolder

Throws:

IOException - if the holder cannot serialize its value

readBinary

protected Binary readBinary(DataInput in)
                     throws IOException

Read the binary value. This is part of deserialization processing, and is separated out to enable subclassing.

Parameters:

in - the DataInput that this holder is being deserialized from

Returns:

the binary value

Throws:

IOException - on I/O error

writeBinary

protected void writeBinary(DataOutput out)
                    throws IOException

Write the binary value. This is part of serialization processing, and is separated out to enable subclassing.

Parameters:

out - the DataOutput that this holder is being serialized to

Throws:

IOException - on I/O error