|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jboss.seam.core.Manager
@Scope(value=EVENT) @Name(value="org.jboss.seam.core.manager") @Install(precedence=0) @BypassInterceptors public class Manager
The Seam conversation manager.
Field Summary | |
---|---|
static String |
REDIRECT_FROM_MANAGER
|
Constructor Summary | |
---|---|
Manager()
|
Method Summary | |
---|---|
void |
beforeRedirect()
Temporarily promote a temporary conversation to a long running conversation for the duration of a browser redirect. |
void |
beginConversation()
Promote a temporary conversation and make it long-running |
void |
beginNestedConversation()
Begin a new nested conversation. |
void |
conversationTimeout(Map<String,Object> session)
Clean up timed-out conversations |
String |
encodeConversationId(String url)
Deprecated. use encodeConversationId(String url, String viewId) |
String |
encodeConversationId(String url,
String viewId)
Add the conversation id to a URL, if necessary |
String |
encodeConversationId(String url,
String viewId,
String conversationId)
Add the conversation id to a URL, if necessary |
protected String |
encodeConversationIdParameter(String url,
String paramName,
String paramValue)
|
String |
encodeParameters(String url,
Map<String,Object> parameters)
Add the parameters to a URL |
void |
endConversation(boolean beforeRedirect)
Make a long-running conversation temporary. |
void |
endRequest(Map<String,Object> session)
Touch the conversation stack, destroy ended conversations, and timeout inactive conversations. |
void |
endRootConversation(boolean beforeRedirect)
Make the root conversation in the current conversation stack temporary. |
protected void |
flushConversationMetadata()
|
protected String |
generateInitialConversationId()
|
int |
getConcurrentRequestTimeout()
|
String |
getConversationIdParameter()
|
int |
getConversationTimeout()
|
Integer |
getCurrentConversationConcurrentRequestTimeout()
|
String |
getCurrentConversationDescription()
|
ConversationEntry |
getCurrentConversationEntry()
|
String |
getCurrentConversationId()
|
List<String> |
getCurrentConversationIdStack()
|
Integer |
getCurrentConversationTimeout()
|
String |
getCurrentConversationViewId()
|
FlushModeType |
getDefaultFlushMode()
|
String |
getParentConversationId()
|
String |
getParentConversationIdParameter()
|
String |
getParentConversationViewId()
|
String |
getRootConversationId()
|
String |
getUriEncoding()
|
void |
handleConversationPropagation(Map parameters)
Look for a conversation propagation style in the request parameters and begin, nest or join the conversation, as necessary. |
void |
initializeTemporaryConversation()
Initialize a new temporary conversation context, and assign it a conversation id. |
static Manager |
instance()
|
protected static boolean |
isDifferentConversationId(ConversationIdParameter sp,
ConversationIdParameter tp)
|
boolean |
isLongRunningConversation()
|
boolean |
isLongRunningOrNestedConversation()
|
boolean |
isNestedConversation()
|
boolean |
isReallyLongRunningConversation()
|
void |
leaveConversation()
Leave the scope of the current conversation, leaving it completely intact. |
void |
redirect(String viewId)
|
void |
redirect(String viewId,
String id)
|
boolean |
restoreConversation()
Initialize the request conversation context, given the conversation id and optionally a parent conversation id. |
void |
setConcurrentRequestTimeout(int requestWait)
|
void |
setConversationIdParameter(String conversationIdParameter)
|
void |
setConversationTimeout(int conversationTimeout)
|
void |
setCurrentConversationId(String id)
Only public for the unit tests! |
void |
setCurrentConversationIdStack(List<String> stack)
|
void |
setDefaultFlushMode(FlushModeType defaultFlushMode)
|
void |
setLongRunningConversation(boolean isLongRunningConversation)
|
void |
setParentConversationIdParameter(String nestedConversationIdParameter)
|
void |
setUriEncoding(String encoding)
|
protected void |
storeConversationToViewRootIfNecessary()
|
boolean |
switchConversation(String id)
Switch to another long-running conversation. |
String |
toString()
|
void |
unlockConversation()
|
void |
updateCurrentConversationId(String id)
Change the id of the current conversation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String REDIRECT_FROM_MANAGER
Constructor Detail |
---|
public Manager()
Method Detail |
---|
public String getCurrentConversationId()
public void setCurrentConversationId(String id)
id
- public void updateCurrentConversationId(String id)
id
- the new conversation idpublic List<String> getCurrentConversationIdStack()
public void setCurrentConversationIdStack(List<String> stack)
public String getCurrentConversationDescription()
public Integer getCurrentConversationTimeout()
public Integer getCurrentConversationConcurrentRequestTimeout()
public String getCurrentConversationViewId()
public String getParentConversationViewId()
public String getParentConversationId()
public String getRootConversationId()
public boolean isLongRunningConversation()
public boolean isLongRunningOrNestedConversation()
public boolean isReallyLongRunningConversation()
public boolean isNestedConversation()
public void setLongRunningConversation(boolean isLongRunningConversation)
public static Manager instance()
public void conversationTimeout(Map<String,Object> session)
public void endRequest(Map<String,Object> session)
public void unlockConversation()
public void handleConversationPropagation(Map parameters)
parameters
- the request parameterspublic boolean restoreConversation()
public void initializeTemporaryConversation()
protected String generateInitialConversationId()
public void beginConversation()
public void beginNestedConversation()
public void endConversation(boolean beforeRedirect)
public void endRootConversation(boolean beforeRedirect)
protected void storeConversationToViewRootIfNecessary()
public ConversationEntry getCurrentConversationEntry()
public void leaveConversation()
public boolean switchConversation(String id)
id
- the id of the conversation to switch to
public int getConversationTimeout()
public void setConversationTimeout(int conversationTimeout)
public void beforeRedirect()
protected static boolean isDifferentConversationId(ConversationIdParameter sp, ConversationIdParameter tp)
public String encodeConversationId(String url)
public String encodeConversationId(String url, String viewId)
public String encodeConversationId(String url, String viewId, String conversationId)
protected String encodeConversationIdParameter(String url, String paramName, String paramValue)
public String encodeParameters(String url, Map<String,Object> parameters)
public String getConversationIdParameter()
public void setConversationIdParameter(String conversationIdParameter)
public String getParentConversationIdParameter()
public void setParentConversationIdParameter(String nestedConversationIdParameter)
public int getConcurrentRequestTimeout()
public void setConcurrentRequestTimeout(int requestWait)
public FlushModeType getDefaultFlushMode()
public void setDefaultFlushMode(FlushModeType defaultFlushMode)
public String toString()
toString
in class Object
public void redirect(String viewId, String id)
public void redirect(String viewId)
protected void flushConversationMetadata()
public String getUriEncoding()
public void setUriEncoding(String encoding)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |