SessionContext (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.jalo.SessionContext

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

StandardSearchContext
```
public class SessionContext
extends Object
implements Serializable
```
The Context-Object of a JaloSession.
This object is responsible for the current user, language, currency and custom session properties.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CURRENCY`
`static String`	`CURRENTDATE`
`static String`	`CURRENTDATE_VALID_TO`
`static String`	`LANGUAGE`
`static String`	`LOCALE`
`static String`	`PRICEFACTORY`
`static String`	`TIMEOFFSET` The name of the attribute which stores the time offset in milliseconds.
`static String`	`TIMEZONE`
`static String`	`TRANSACTION_4_ALLATTRIBUTES`
`static String`	`TRANSACTION_IN_CREATE_DISABLED` Setting this attribute to 'TRUE' will DISABLE the execution of Item#newInstance( SessionContext, JaloSession, ComposedType, Map ) inside a transaction.
`static String`	`USER`
`static Long`	`ZERO_TIME_OFFSET`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`SessionContext()`
	`SessionContext(SessionContext context)`
`protected`	`SessionContext(SessionContext context, boolean asLocal)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAllAttributes(Map<String,? extends Object> attributes)`
`boolean`	`equals(Object object)`
`protected void`	`fixStaleItemsInContext()`
`protected <T> T`	`fixStaleItemsInValue(String name, T currentValue)`
`Date`	`getAdjustedCurrentDate()` Returns the current time ( see `getAdjustedCurrentTime()` ) with hours, minutes, seconds and milliseconds normalized to zero.
`protected long`	`getAdjustedCurrentDateMillis()`
`Date`	`getAdjustedCurrentTime()` Returns the adjusted current time relative to time set by calling `setCurrentTime(Date)` early.
`protected long`	`getAdjustedCurrentTimeMillis()`
`Collection<String>`	`getAllAttributeNames()`
`<T> T`	`getAttribute(String name)` Returns the attribute mapped to key 'name'
`Enumeration`	`getAttributeNames()` Deprecated.
`Map<String,Object>`	`getAttributes()` Returns a unmodifiable copy of the session attributes
`Currency`	`getCurrency()` Method getCurrency
`protected long`	`getCurrentTimeMillis()` Override for testing only !
`Language`	`getLanguage()` Returns the language currently associated with this session context.
`Locale`	`getLocale()` Returns the `Locale` which matches the current language settings best.
`PriceFactory`	`getPriceFactory()` Method getPriceFactory
`long`	`getTimeOffset()` Returns the time offset in milliseconds.
`TimeZone`	`getTimeZone()` Returns the `TimeZone` which is currently associated with this session context.
`User`	`getUser()` Method getUser
`int`	`hashCode()`
`protected void`	`initializeOnSessionStartup(User user, Language language, Currency currency, TimeZone timeZone, PriceFactory injectedPriceFactory)`
`Object`	`removeAttribute(String name)` Method removeAttribute
`Object`	`setAttribute(String name, Object value)` Method setAttribute
`void`	`setAttributes(Map<String,? extends Object> attributes)` Method setAttributes
`void`	`setCurrency(Currency currency)` Method setCurrency
`void`	`setCurrentTime(Date timeInstance)` Set the given timeInstance as the current time.
`void`	`setCurrentTimeSystem()` Set the current time back to system time
`void`	`setLanguage(Language language)` Method setLanguage
`void`	`setLocale(Locale loc)` Changes the `Locale` which should be associated with this session context.
`void`	`setPriceFactory(PriceFactory pricefactory)` Method setPriceFactory
`protected void`	`setSession(JaloSession session)`
`void`	`setSessionContextValues(SessionContext ctx)`
`void`	`setTimeZome(TimeZone timezone)` Deprecated. use `setTimeZone(TimeZone)` instead
`void`	`setTimeZone(TimeZone timezone)` Changes the time zone which is associated with this session context.
`void`	`setUser(User user)` Method setUser
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - USER
```
public static final String USER
```
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
public static final String LANGUAGE
```
    See Also:
    
    Constant Field Values
  - CURRENCY
```
public static final String CURRENCY
```
    See Also:
    
    Constant Field Values
  - PRICEFACTORY
```
public static final String PRICEFACTORY
```
    See Also:
    
    Constant Field Values
  - LOCALE
```
public static final String LOCALE
```
    See Also:
    
    Constant Field Values
  - TIMEZONE
```
public static final String TIMEZONE
```
    See Also:
    
    Constant Field Values
  - ZERO_TIME_OFFSET
```
public static final Long ZERO_TIME_OFFSET
```
  - TIMEOFFSET
```
public static final String TIMEOFFSET
```
    The name of the attribute which stores the time offset in milliseconds. This attribute allows adjusting time in a consistent way across the entire session.
    
    See Also:
    
    Constant Field Values
  - CURRENTDATE
```
public static final String CURRENTDATE
```
    See Also:
    
    Constant Field Values
  - CURRENTDATE_VALID_TO
```
public static final String CURRENTDATE_VALID_TO
```
    See Also:
    
    Constant Field Values
  - TRANSACTION_IN_CREATE_DISABLED
```
public static final String TRANSACTION_IN_CREATE_DISABLED
```
    Setting this attribute to 'TRUE' will DISABLE the execution of Item#newInstance( SessionContext, JaloSession, ComposedType, Map ) inside a transaction.
    Sample: ctx.setAttribute( SessionContext.TRANSACTION_IN_CREATE_DISABLED, Boolean.TRUE );
    
    See Also:
    
    Constant Field Values
  - TRANSACTION_4_ALLATTRIBUTES
```
public static final String TRANSACTION_4_ALLATTRIBUTES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SessionContext
```
public SessionContext()
```
  - SessionContext
```
public SessionContext(SessionContext context)
```
  - SessionContext
```
protected SessionContext(SessionContext context,
                         boolean asLocal)
```
- Method Detail
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - setSession
```
protected void setSession(JaloSession session)
```
  - initializeOnSessionStartup
```
protected void initializeOnSessionStartup(User user,
                                          Language language,
                                          Currency currency,
                                          TimeZone timeZone,
                                          PriceFactory injectedPriceFactory)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setSessionContextValues
```
public void setSessionContextValues(SessionContext ctx)
```
  - setLanguage
```
public void setLanguage(Language language)
```
    Method setLanguage
    
    Parameters:
    
    language -
  - getLanguage
```
public Language getLanguage()
```
    Returns the language currently associated with this session context. Please note that for some reasons the session context may hold no language at all ( e.g. when using the context to fetch all values of a localized attribute at once).
  - getLocale
```
public Locale getLocale()
```
    Returns the Locale which matches the current language settings best. This affects all data formatting logic within the hybris platform ( like Currency.formatPrice(double) ). The algorithm works as follows:
    - a locale has been set via setLocale(Locale) : return it directly
    - a language is present and its method Language.getLocale() returns a non-null locale: return this language dependent locale
    - otherwise simply return the vm default locale from Locale.getDefault().
    Since:
    
    3.0 M2
  - setLocale
```
public void setLocale(Locale loc)
```
    Changes the Locale which should be associated with this session context. This affects all data formatting logic within the hybris platform ( like Currency.formatPrice(double) ).
    
    Since:
    
    3.0 M2
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Returns the TimeZone which is currently associated with this session context. If no time zone has been set via setTimeZome(TimeZone) the default vm time zone is returned (see TimeZone.getDefault(). This affects all date formatting and parsing logic within the hybris platform.
    
    Since:
    
    3.0 M2
  - getTimeOffset
```
public long getTimeOffset()
```
    Returns the time offset in milliseconds. If there has been no call to setCurrentTime(Date), a value of zero is returned.
  - setTimeZome
```
@Deprecated
public void setTimeZome(TimeZone timezone)
```
    Deprecated. use setTimeZone(TimeZone) instead
    
    Changes the time zone which is associated with this session context.
    
    Since:
    
    3.0 M2
  - setTimeZone
```
public void setTimeZone(TimeZone timezone)
```
    Changes the time zone which is associated with this session context.
    
    Since:
    
    3.0 M2
  - setCurrency
```
public void setCurrency(Currency currency)
```
    Method setCurrency
    
    Parameters:
    
    currency -
  - getCurrency
```
public Currency getCurrency()
```
    Method getCurrency
  - setUser
```
public void setUser(User user)
```
    Method setUser
    
    Parameters:
    
    user -
  - getUser
```
public User getUser()
```
    Method getUser
  - setPriceFactory
```
public void setPriceFactory(PriceFactory pricefactory)
```
    Method setPriceFactory
    
    Parameters:
    
    pricefactory -
  - getPriceFactory
```
public PriceFactory getPriceFactory()
```
    Method getPriceFactory
  - setAttributes
```
public void setAttributes(Map<String,? extends Object> attributes)
```
    Method setAttributes
    
    Parameters:
    
    attributes -
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Returns a unmodifiable copy of the session attributes
    
    Returns:
    
    map
  - fixStaleItemsInContext
```
protected void fixStaleItemsInContext()
```
  - getAttribute
```
public <T> T getAttribute(String name)
```
    Returns the attribute mapped to key 'name'
  - fixStaleItemsInValue
```
protected <T> T fixStaleItemsInValue(String name,
                                     T currentValue)
```
  - setAttribute
```
public Object setAttribute(String name,
                           Object value)
```
    Method setAttribute
  - getAttributeNames
```
@Deprecated
public Enumeration getAttributeNames()
```
    Deprecated.
    
    Returns an Enumeration of String objects containing the names of all the objects bound to this session. Use getAllAttributeNames() instead.
  - getAllAttributeNames
```
public Collection<String> getAllAttributeNames()
```
  - addAllAttributes
```
public void addAllAttributes(Map<String,? extends Object> attributes)
```
  - removeAttribute
```
public Object removeAttribute(String name)
```
    Method removeAttribute
  - setCurrentTime
```
public void setCurrentTime(Date timeInstance)
```
    Set the given timeInstance as the current time. This method is used to adjust the current time to either a past or future instant.
  - getCurrentTimeMillis
```
protected long getCurrentTimeMillis()
```
    Override for testing only !
  - getAdjustedCurrentTime
```
public Date getAdjustedCurrentTime()
```
    Returns the adjusted current time relative to time set by calling setCurrentTime(Date) early. If setCurrentTime(Date) was never called before, then current system time is returned.
  - getAdjustedCurrentTimeMillis
```
protected long getAdjustedCurrentTimeMillis()
```
  - setCurrentTimeSystem
```
public void setCurrentTimeSystem()
```
    Set the current time back to system time
  - getAdjustedCurrentDate
```
public Date getAdjustedCurrentDate()
```
    Returns the current time ( see getAdjustedCurrentTime() ) with hours, minutes, seconds and milliseconds normalized to zero.
  - getAdjustedCurrentDateMillis
```
protected long getAdjustedCurrentDateMillis()
```

Class SessionContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER

LANGUAGE

CURRENCY

PRICEFACTORY

LOCALE

TIMEZONE

ZERO_TIME_OFFSET

TIMEOFFSET

CURRENTDATE

CURRENTDATE_VALID_TO

TRANSACTION_IN_CREATE_DISABLED

TRANSACTION_4_ALLATTRIBUTES

Constructor Detail

SessionContext

SessionContext

SessionContext

Method Detail

equals

hashCode

setSession

initializeOnSessionStartup

toString

setSessionContextValues

setLanguage

getLanguage

getLocale

setLocale

getTimeZone

getTimeOffset

setTimeZome

setTimeZone

setCurrency

getCurrency

setUser

getUser

setPriceFactory

getPriceFactory

setAttributes

getAttributes

fixStaleItemsInContext

getAttribute

fixStaleItemsInValue

setAttribute

getAttributeNames

getAllAttributeNames

addAllAttributes

removeAttribute

setCurrentTime

getCurrentTimeMillis

getAdjustedCurrentTime

getAdjustedCurrentTimeMillis

setCurrentTimeSystem

getAdjustedCurrentDate

getAdjustedCurrentDateMillis