com.ibm.commerce.context.previewimpl

Class PreviewContextImpl

java.lang.Object

com.ibm.commerce.context.baseimpl.AbstractContextImpl

com.ibm.commerce.context.previewimpl.PreviewContextImpl

All Implemented Interfaces:

Context, ContextSPI, PreviewConstants, PreviewContext, java.io.Serializable

public class PreviewContextImpl
extends AbstractContextImpl
implements PreviewContext, PreviewConstants

Default Preview context implementation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from class com.ibm.commerce.context.baseimpl.AbstractContextImpl

SER_VALUE_SEP

Fields inherited from interface com.ibm.commerce.context.preview.PreviewContext

ACTIVITY_DATA_PARAM_SERIALIZED_PREVIEW_CONTEXT, CONTEXT_NAME

Fields inherited from interface com.ibm.commerce.context.preview.PreviewConstants

INVENTORY_EVAL_FALSE, INVENTORY_EVAL_REAL, INVENTORY_EVAL_TRUE, PREVIEW_CTXT_DATA, PREVIEW_HOST, PREVIEW_INVENTORY, PREVIEW_MEMBER_GROUP_IDS_INCLUDED, PREVIEW_PATH, PREVIEW_PROP_POSITION, PREVIEW_REST_URI, PREVIEW_START_TIME, PREVIEW_STATIC, PREVIEW_TOKEN, REST_ATTRIBUTE_IN_PREVIEW

Constructor Summary

Constructors

Constructor and Description
PreviewContextImpl() Creates the preview context.

Method Summary

Modifier and Type	Method and Description
void	clearContext() This method is called when the ContextSPI object is returned to their respective object pool.
void	copyContext(Context ctx) Copy the content of the specified context to this context.
java.lang.Object[]	getContextAttributes() Returns an array of context attributes to be serialized and persisted.
java.lang.String	getContextName() Returns the name of the context which is the PreviewContext interface name.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns the preview properties.
java.lang.String	getProperty(java.lang.String key) Returns the property value based on the specified property name.
java.util.Iterator	getPropertyNames() Returns an iterator of property names (set using setProperty) currently contained in the preview context.
java.sql.Timestamp	getTimestamp() Returns the appropriate timestamp to the caller to use when performing an operation.
void	initializeContext(com.ibm.commerce.component.contextservice.ActivityData initData) Initializes the context with the initialization data.
void	initializeContext(com.ibm.commerce.component.contextservice.ActivityData initData, Context ctx) Initializes the context based on the context passed in as the argument and updates it using the initData.
void	preInvokeContext(com.ibm.commerce.component.contextservice.ActivityData sessionData) Operation to perform at the beginning of each request.
void	setContextAttributes(java.lang.String[] ctxAttrs) Initializes the context from the specified list of attributes.
void	setProperty(java.lang.String key, java.lang.String value) Sets a property to associate with preview.
void	setTimestamp(java.sql.Timestamp timeStamp) Sets the time to be used by the session.
void	setTimestamp(java.sql.Timestamp timeStamp, boolean isStat) Sets the time to be used by the session.
java.lang.String	toString() Returns the string representation of the object.
boolean	validate() Validates the current context.

Methods inherited from class com.ibm.commerce.context.baseimpl.AbstractContextImpl

clear, getActivityToken, getContextSerializedString, initialize, initialize, isDirty, postInvoke, postInvokeContext, preInvoke, recalibrate, recalibrateContext, reset, resetContext, setContextSerializedString, setDirty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.commerce.context.base.Context

getActivityToken

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

PreviewContextImpl

public PreviewContextImpl()

Creates the preview context.

Method Detail

getContextName

public java.lang.String getContextName()

Returns the name of the context which is the PreviewContext interface name.

Specified by:

getContextName in interface Context

Returns:

The name of the context.

See Also:

Context.getContextName()

toString

public java.lang.String toString()

Returns the string representation of the object.

Overrides:

toString in class AbstractContextImpl

Returns:

The string representation of the object.

validate

public boolean validate()
                 throws BusinessContextException

Validates the current context.

Specified by:

validate in interface Context

Returns:

Always true.

Throws:

BusinessContextException - if any one of the attributes is not valid

See Also:

Context.validate()

getTimestamp

public java.sql.Timestamp getTimestamp()

Returns the appropriate timestamp to the caller to use when performing an operation. If the timestamp has not been adjusted by one of the setTimestamp() methods then the actual timestamp returns. If the timestamp has been adjusted, then the adjusted version of the timestamp returns.

Specified by:

getTimestamp in interface PreviewContext

Returns:

The appropriate timestamp to use for the operation.

setTimestamp

public void setTimestamp(java.sql.Timestamp timeStamp)

Sets the time to be used by the session. When the timestamp is set, time will still move forward but based on the specified timestamp and not the current timestamp.

Specified by:

setTimestamp in interface PreviewContext

Parameters:

timeStamp - The new time of the session.

setTimestamp

public void setTimestamp(java.sql.Timestamp timeStamp,
                         boolean isStat)

Sets the time to be used by the session. When the timestamp is set and time is not static, time will still elapse but based on the specified timestamp and not the current timestamp. If time is static then this time will always return.

Specified by:

setTimestamp in interface PreviewContext

Parameters:

timeStamp - The new time of the session.

isStat - Whether the time should be static. If the time is static, then this time will always return.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Sets a property to associate with preview. These properties will be used by particular components and they can react accordingly whether the property is specified and what value the property contains.

Specified by:

setProperty in interface PreviewContext

Parameters:

key - The property name.

value - The property value.

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns the preview properties.

Returns:

The preview properties.

getProperty

public java.lang.String getProperty(java.lang.String key)

Returns the property value based on the specified property name.

Specified by:

getProperty in interface PreviewContext

Parameters:

key - The property name.

Returns:

The value associated with the specified key. If the key does not exist then null is returned.

getPropertyNames

public java.util.Iterator getPropertyNames()

Returns an iterator of property names (set using setProperty) currently contained in the preview context.

Specified by:

getPropertyNames in interface PreviewContext

Returns:

The available property names.

preInvokeContext

public void preInvokeContext(com.ibm.commerce.component.contextservice.ActivityData sessionData)
                      throws BusinessContextException

Operation to perform at the beginning of each request.

Specified by:

preInvokeContext in class AbstractContextImpl

Parameters:

sessionData - The session data of the request.

Throws:

java.lang.Exception - should never happen since no operation is performed.

BusinessContextException - on any error encountered

See Also:

ContextSPI.preInvoke(com.ibm.commerce.component.contextservice.ActivityData)

initializeContext

public void initializeContext(com.ibm.commerce.component.contextservice.ActivityData initData)
                       throws BusinessContextException

Initializes the context with the initialization data. It should first set the activity token instance variable with the activity token that is passed in.

Overrides:

initializeContext in class AbstractContextImpl

Parameters:

initData - The set of attributes that are passed in from the request.

Throws:

BusinessContextException - on any error

See Also:

AbstractContextImpl.initializeContext(ActivityData)

getContextAttributes

public java.lang.Object[] getContextAttributes()
                                        throws BusinessContextException

Returns an array of context attributes to be serialized and persisted.

Specified by:

getContextAttributes in class AbstractContextImpl

Returns:

Returns an array of context attributes to be serialized.

Throws:

BusinessContextException

See Also:

AbstractContextImpl.getContextSerializedString()

setContextAttributes

public void setContextAttributes(java.lang.String[] ctxAttrs)
                          throws BusinessContextException

Initializes the context from the specified list of attributes.

Specified by:

setContextAttributes in class AbstractContextImpl

Parameters:

ctxAttrs - An array of attributes of the context

Throws:

BusinessContextException

initializeContext

public void initializeContext(com.ibm.commerce.component.contextservice.ActivityData initData,
                              Context ctx)
                       throws BusinessContextException

Initializes the context based on the context passed in as the argument and updates it using the initData.

Overrides:

initializeContext in class AbstractContextImpl

Parameters:

initData - The set of attributes that are passed by the request

ctx - The particular context of the token being copied

Throws:

BusinessContextException - on any error

clearContext

public void clearContext()

This method is called when the ContextSPI object is returned to their respective object pool. The purpose of this object is to reset the instance variables to its uninitialized values.

Specified by:

clearContext in class AbstractContextImpl

See Also:

AbstractContextImpl.clear()

copyContext

public void copyContext(Context ctx)

Copy the content of the specified context to this context.

Specified by:

copyContext in interface Context

Parameters:

ctx - The context to be copied from.