org.jboss.seam.core
Class ConversationEntry

java.lang.Object
  org.jboss.seam.core.ConversationEntry

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConversationEntry>

public final class ConversationEntry
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<ConversationEntry>

Metadata about an active conversation. Also used by the conversation list and breadcrumbs.

Author:

Gavin King

See Also:

Serialized Form

Constructor Summary

ConversationEntry(java.lang.String id, java.util.List<java.lang.String> stack, ConversationEntries entries)

Method Summary

int	compareTo(ConversationEntry entry)
void	destroy()
void	end()
java.lang.String	findPositionInConversationStack(Component component) Determines which conversation in the stack is holding the instance of this component.
java.lang.Integer	getConcurrentRequestTimeout()
java.util.List<java.lang.String>	getConversationIdStack()
java.lang.String	getDescription()
java.lang.String	getId()
java.util.Date	getLastDatetime()
long	getLastRequestTime()
java.util.Date	getStartDatetime()
int	getTimeout()
java.lang.String	getViewId()
boolean	isCurrent()
boolean	isDisplayable()
boolean	isEnded()
boolean	isLockedByCurrentThread()
boolean	isNested()
boolean	isRemoveAfterRedirect()
boolean	lock()
boolean	lockNoWait()
boolean	redirect()
void	select()
void	setRemoveAfterRedirect(boolean removeAfterRedirect)
java.lang.String	toString()
void	unlock()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConversationEntry

public ConversationEntry(java.lang.String id,
                         java.util.List<java.lang.String> stack,
                         ConversationEntries entries)

Method Detail

getDescription

public java.lang.String getDescription()

getLastRequestTime

public long getLastRequestTime()

getId

public java.lang.String getId()

getStartDatetime

public java.util.Date getStartDatetime()

destroy

public void destroy()

select

public void select()

redirect

public boolean redirect()

getViewId

public java.lang.String getViewId()

getLastDatetime

public java.util.Date getLastDatetime()

getConversationIdStack

public java.util.List<java.lang.String> getConversationIdStack()

isDisplayable

public boolean isDisplayable()

isCurrent

public boolean isCurrent()

compareTo

public int compareTo(ConversationEntry entry)

Specified by:

compareTo in interface java.lang.Comparable<ConversationEntry>

getTimeout

public int getTimeout()

getConcurrentRequestTimeout

public java.lang.Integer getConcurrentRequestTimeout()

isRemoveAfterRedirect

public boolean isRemoveAfterRedirect()

setRemoveAfterRedirect

public void setRemoveAfterRedirect(boolean removeAfterRedirect)

lockNoWait

public boolean lockNoWait()

lock

public boolean lock()

unlock

public void unlock()

isLockedByCurrentThread

public boolean isLockedByCurrentThread()

end

public void end()

isEnded

public boolean isEnded()

isNested

public boolean isNested()

findPositionInConversationStack

public java.lang.String findPositionInConversationStack(Component component)

Determines which conversation in the stack is holding the instance of this component. A nested conversation can see context variables in all ancestor conversations. In this case, we are interesting in knowing where that instance was found. We are assuming that if the reference is not in an ancestor conversation, then it must be in the current conversation. The goal here is not to locate the instance, but rather to determine which conversation is contributing the instance that we already know exists. The low-level interaction with the session context should be refactored out. The problem is that it is defined in private areas of ServerConversationContext and cannot be reused. Actually, what we really need is a general purpose utility for analyzing the contents of each conversation in the stack (at least the keys).

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object