EchoBaseSession (EchoBase

java.lang.Object
- fr.ifremer.echobase.ui.EchoBaseSession

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable
```
public class EchoBaseSession
extends Object
implements Closeable, Serializable
```
The session object of EchoBase to put in servlet session.

Since:

0.1

Author:

tchemit

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SESSION_TOKEN_ERRORS`
`static String`	`SESSION_TOKEN_MESSAGES`
`static String`	`SESSION_TOKEN_WARNINGS`
`protected Map<String,Object>`	`store` To store all properties in this session.

Constructor Summary

Constructors
Modifier Constructor and Description

protected EchoBaseSession()
Protect session constructor.

Constructors
Modifier	Constructor and Description
`protected`	`EchoBaseSession()` Protect session constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMessage(String messageScope, String message)`
`void`	`clearDynamicData()`
`void`	`close()` Release any resources contained in the user session.
`<T extends Serializable> T`	`consumeDynamicData(String token)`
`<T extends Serializable> Set<T>`	`consumeDynamicSetData(String token)`
`protected boolean`	`contains(String key)` Tests if for a given key, there is an associated object in this sessio!!!n.
`protected <T> T`	`get(String key, Class<T> type)` Gets from this session an object given his key and his type.
`<C extends AbstractEchobaseActionConfiguration> C`	`getActionConfiguration(Class<C> configurationType)`
`protected Map<String,Object>`	`getDynamicData()`
`<T extends Serializable> T`	`getDynamicData(String token)`
`<T extends Serializable> Set<T>`	`getDynamicSetData(String token)`
`static EchoBaseSession`	`getEchoBaseSession(com.opensymphony.xwork2.ActionContext actionContext)` Obtain the user T3 session.
`static EchoBaseSession`	`getEchoBaseSession(javax.servlet.http.HttpSession session)`
`Collection<String>`	`getFlashErrors()`
`Collection<String>`	`getFlashMessages()`
`Collection<String>`	`getFlashWarnings()`
`EchoBaseUser`	`getUser()` Gets the informations of user as soon as the user is loggued.
`EchoBaseUserTopiaApplicationContext`	`getUserDbApplicationContext()`
`JdbcConfiguration`	`getWorkingDbConfiguration()`
`void`	`initUserDb(JdbcConfiguration jdbcConfiguration, boolean createSchema)` Initialize the t3 database configuration from the given connection configuration.
`boolean`	`isAdmin()`
`boolean`	`isWithFlashErrors()`
`boolean`	`isWithFlashMessages()`
`boolean`	`isWithFlashWarnings()`
`boolean`	`isWorkingDbSelected()`
`void`	`putDynamicData(String token, Serializable data)`
`<T extends Serializable> void`	`putDynamicSetData(String token, Set<T> data)`
`void`	`releaseUserDb()`
`protected Object`	`remove(String key)` Remove form this session, the object from his given key and returns it.
`<C extends AbstractEchobaseActionConfiguration> void`	`removeActionConfiguration(Class<C> configurationType)`
`void`	`removeDynamicData(String token)`
`static void`	`removeEchoBaseSession(com.opensymphony.xwork2.ActionContext actionContext)`
`protected void`	`set(String key, Object value)` Sets in this session the igven object using the given key.
`<C extends AbstractEchobaseActionConfiguration> void`	`setActionConfiguration(C configurationType)`
`void`	`setUser(EchoBaseUser user)` Sets in this session the loggued user.

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

- Field Detail
  - SESSION_TOKEN_MESSAGES
```
public static final String SESSION_TOKEN_MESSAGES
```
    See Also:
    Constant Field Values
  - SESSION_TOKEN_ERRORS
```
public static final String SESSION_TOKEN_ERRORS
```
    See Also:
    Constant Field Values
  - SESSION_TOKEN_WARNINGS
```
public static final String SESSION_TOKEN_WARNINGS
```
    See Also:
    Constant Field Values
  - store
```
protected Map<String,Object> store
```
    To store all properties in this session.
- Constructor Detail
  - EchoBaseSession
```
protected EchoBaseSession()
```
    Protect session constructor.
- Method Detail
  - getEchoBaseSession
```
public static EchoBaseSession getEchoBaseSession(com.opensymphony.xwork2.ActionContext actionContext)
```
    Obtain the user T3 session.
    If not found in application session, then will instanciate it and push it in it.
    At the creation time the session, it will also set his T3 factory.
    
    Parameters:
    actionContext - where to find user session
    
    Returns:
    the user T3 session (never null)
  - getEchoBaseSession
```
public static EchoBaseSession getEchoBaseSession(javax.servlet.http.HttpSession session)
```
  - removeEchoBaseSession
```
public static void removeEchoBaseSession(com.opensymphony.xwork2.ActionContext actionContext)
```
  - getUser
```
public EchoBaseUser getUser()
```
    Gets the informations of user as soon as the user is loggued.
    
    Returns:
    the informations of loggued user or null if not in session
  - isAdmin
```
public boolean isAdmin()
```
  - setUser
```
public void setUser(EchoBaseUser user)
```
    Sets in this session the loggued user.
    
    Parameters:
    user - the user loggued to use in this session
  - getWorkingDbConfiguration
```
public JdbcConfiguration getWorkingDbConfiguration()
```
  - getUserDbApplicationContext
```
public EchoBaseUserTopiaApplicationContext getUserDbApplicationContext()
```
  - isWorkingDbSelected
```
public boolean isWorkingDbSelected()
```
  - initUserDb
```
public void initUserDb(JdbcConfiguration jdbcConfiguration,
              boolean createSchema)
                throws org.nuiton.topia.persistence.TopiaNotFoundException
```
    Initialize the t3 database configuration from the given connection configuration.
    The given configuration only give the url, login and pasword to use. Complete configuration (for ToPIA) will be loaded interanlly and match only a postgresql db.
    
    Parameters:
    jdbcConfiguration - the connection configuration to use
    
    Throws:
    
    org.nuiton.topia.persistence.TopiaNotFoundException - if could not create root context
  - getActionConfiguration
```
public <C extends AbstractEchobaseActionConfiguration> C getActionConfiguration(Class<C> configurationType)
```
  - setActionConfiguration
```
public <C extends AbstractEchobaseActionConfiguration> void setActionConfiguration(C configurationType)
```
  - removeActionConfiguration
```
public <C extends AbstractEchobaseActionConfiguration> void removeActionConfiguration(Class<C> configurationType)
```
  - releaseUserDb
```
public void releaseUserDb()
```
  - getDynamicData
```
public <T extends Serializable> T getDynamicData(String token)
```
  - getDynamicSetData
```
public <T extends Serializable> Set<T> getDynamicSetData(String token)
```
  - consumeDynamicData
```
public <T extends Serializable> T consumeDynamicData(String token)
```
  - consumeDynamicSetData
```
public <T extends Serializable> Set<T> consumeDynamicSetData(String token)
```
  - putDynamicSetData
```
public <T extends Serializable> void putDynamicSetData(String token,
                                              Set<T> data)
```
  - putDynamicData
```
public void putDynamicData(String token,
                  Serializable data)
```
  - removeDynamicData
```
public void removeDynamicData(String token)
```
  - clearDynamicData
```
public void clearDynamicData()
```
  - addMessage
```
public void addMessage(String messageScope,
              String message)
```
  - getDynamicData
```
protected Map<String,Object> getDynamicData()
```
  - remove
```
protected Object remove(String key)
```
    Remove form this session, the object from his given key and returns it.
    
    Parameters:
    key - the key of object to remove from this session
    
    Returns:
    the removed object from session, or null if not found
  - contains
```
protected boolean contains(String key)
```
    Tests if for a given key, there is an associated object in this sessio!!!n.
    
    Parameters:
    key - the key to test in this session
    
    Returns:
    true if an object was found in this session, false otherwise
  - get
```
protected <T> T get(String key,
        Class<T> type)
```
    Gets from this session an object given his key and his type.
    
    Type Parameters:
    T - the type of object to obtain from this session
    Parameters:
    key - the key of object to obtain from this session
    type - the type of object to obtain from this session
    
    Returns:
    the object found in this session, or null if not found
  - set
```
protected void set(String key,
       Object value)
```
    Sets in this session the igven object using the given key.
    
    Parameters:
    key - the key where to store the object in this session
    value - the object to store in this session
  - close
```
public void close()
```
    Release any resources contained in the user session.
    Will also close any service (like the databaseService which contains connexions to db).
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Since:
    
    1.1
  - isWithFlashMessages
```
public boolean isWithFlashMessages()
```
  - isWithFlashErrors
```
public boolean isWithFlashErrors()
```
  - isWithFlashWarnings
```
public boolean isWithFlashWarnings()
```
  - getFlashMessages
```
public Collection<String> getFlashMessages()
```
  - getFlashErrors
```
public Collection<String> getFlashErrors()
```
  - getFlashWarnings
```
public Collection<String> getFlashWarnings()
```

Class EchoBaseSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SESSION_TOKEN_MESSAGES

SESSION_TOKEN_ERRORS

SESSION_TOKEN_WARNINGS

store

Constructor Detail

EchoBaseSession

Method Detail

getEchoBaseSession

getEchoBaseSession

removeEchoBaseSession

getUser

isAdmin

setUser

getWorkingDbConfiguration

getUserDbApplicationContext

isWorkingDbSelected

initUserDb

getActionConfiguration

setActionConfiguration

removeActionConfiguration

releaseUserDb

getDynamicData

getDynamicSetData

consumeDynamicData

consumeDynamicSetData

putDynamicSetData

putDynamicData

removeDynamicData

clearDynamicData

addMessage

getDynamicData

remove

contains

get

set

close

isWithFlashMessages

isWithFlashErrors

isWithFlashWarnings

getFlashMessages

getFlashErrors

getFlashWarnings