com.bea.wli.config.mbeans

Class Session

java.lang.Object

com.bea.wli.config.mbeans.Session

All Implemented Interfaces:

SessionMBean

public class Session
extends java.lang.Object
implements SessionMBean

implementation of the SessionMBean API NOTE: This class must not be instantiated or accessed directly other than by the config framework itself.

Field Summary

Fields inherited from interface com.bea.wli.config.mbeans.SessionMBean

NAME, TYPE

Constructor Summary

Constructors

Constructor and Description
Session(ConfigServiceImpl configService, SessionManager sessionManager)

Method Summary

Modifier and Type	Method and Description
void	commitSession(java.lang.String session) Commits a session
void	commitSession(java.lang.String session, SessionConflicts expectedConflicts) Commits a session only if the concurrent modification conflicts are not different from the expected conflicts.
void	createSession(java.lang.String session) Creates a new session with an arbitrary user given name
void	createSessionWithUndo(java.lang.String session, java.lang.String taskId) Creates a new session with the given name, and performs undo of the given taskId in that session
void	createTransientSession(java.lang.String session) Creates a new transient session with an arbitrary user given name.
void	discardSession(java.lang.String session) Deletes the session without activating the changes.
java.lang.String	getDescription(java.lang.String session) Returns the description for the session
java.util.List<SessionInfo>	getSessionInfos() Returns information about all the existing sessions
java.util.Set<java.lang.String>	getSessions() Returns the names of all the sessions
boolean	isSessionReadyForCommit(java.lang.String session) Returns true if there are no critical conflicts in the session so the session can be activated.
boolean	sessionExists(java.lang.String session) Returns true if a session with the given session exists
void	setDescription(java.lang.String session, java.lang.String description) Set a description for a session.

Methods inherited from class java.lang.Object

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

Constructor Detail

Session

public Session(ConfigServiceImpl configService,
               SessionManager sessionManager)
        throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

createSession

public void createSession(java.lang.String session)
                   throws java.lang.Exception

Description copied from interface: SessionMBean

Creates a new session with an arbitrary user given name

Specified by:

createSession in interface SessionMBean

Parameters:

session - name of the session to create

Throws:

java.lang.Exception

createTransientSession

public void createTransientSession(java.lang.String session)
                            throws java.lang.Exception

Description copied from interface: SessionMBean

Creates a new transient session with an arbitrary user given name. A transient session is considered to be temporary and will nto be persisted across restarts.

Specified by:

createTransientSession in interface SessionMBean

Parameters:

session - name of the session to create

Throws:

java.lang.Exception

createSessionWithUndo

public void createSessionWithUndo(java.lang.String session,
                                  java.lang.String taskId)
                           throws java.lang.Exception

Description copied from interface: SessionMBean

Creates a new session with the given name, and performs undo of the given taskId in that session

Specified by:

createSessionWithUndo in interface SessionMBean

Parameters:

session - name of the session to crate

taskId - the id of the task to be undone

Throws:

java.lang.Exception

sessionExists

public boolean sessionExists(java.lang.String session)

Description copied from interface: SessionMBean

Returns true if a session with the given session exists

Specified by:

sessionExists in interface SessionMBean

discardSession

public void discardSession(java.lang.String session)
                    throws java.lang.Exception

Description copied from interface: SessionMBean

Deletes the session without activating the changes.

Specified by:

discardSession in interface SessionMBean

Throws:

java.lang.Exception

setDescription

public void setDescription(java.lang.String session,
                           java.lang.String description)
                    throws java.lang.Exception

Description copied from interface: SessionMBean

Set a description for a session.

Specified by:

setDescription in interface SessionMBean

Throws:

java.lang.Exception

getDescription

public java.lang.String getDescription(java.lang.String session)

Description copied from interface: SessionMBean

Returns the description for the session

Specified by:

getDescription in interface SessionMBean

Returns:

getSessions

public java.util.Set<java.lang.String> getSessions()

Description copied from interface: SessionMBean

Returns the names of all the sessions

Specified by:

getSessions in interface SessionMBean

commitSession

public void commitSession(java.lang.String session)
                   throws java.lang.Exception

Description copied from interface: SessionMBean

Commits a session

Specified by:

commitSession in interface SessionMBean

Throws:

java.lang.Exception

commitSession

public void commitSession(java.lang.String session,
                          SessionConflicts expectedConflicts)
                   throws java.lang.Exception

Description copied from interface: SessionMBean

Commits a session only if the concurrent modification conflicts are not different from the expected conflicts.

Specified by:

commitSession in interface SessionMBean

expectedConflicts - activate session only if there are no new conflicts with respect to base conflicts. This method simply obtains the diff between the current set of conflicts and the expected conflicts (via SessionConflicts.diff(com.bea.wli.config.session.SessionConflicts, com.bea.wli.config.session.SessionConflicts)) and throws exception if there are additional conflicts on top of what the user is expecting

Throws:

java.lang.Exception

isSessionReadyForCommit

public boolean isSessionReadyForCommit(java.lang.String session)
                                throws java.lang.Exception

Description copied from interface: SessionMBean

Returns true if there are no critical conflicts in the session so the session can be activated. If there are critical conflicts, the session cannot be activated, and this method will return false.

Specified by:

isSessionReadyForCommit in interface SessionMBean

Returns:

Throws:

java.lang.Exception

See Also:

com.bea.wli.config.session.SessionConflicts#hasCriticalConflicts()}

getSessionInfos

public java.util.List<SessionInfo> getSessionInfos()

Description copied from interface: SessionMBean

Returns information about all the existing sessions

Specified by:

getSessionInfos in interface SessionMBean

Returns: