org.jboss.seam.faces.context.conversation

Annotation Type Begin

@InterceptorBinding
@Target(value={METHOD,TYPE})
@Retention(value=RUNTIME)
public @interface Begin

Begins a persistent Conversation.

Note: Unless the exception is of a permitted type, if this method throws an exception, the conversation will not begin.

Author:

Lincoln Baxter, III

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	id Sets the new Conversation ID.
Class<? extends Exception>[]	permit Sets the exception types for which, when encountered during a method invocation, the Conversation will still begin.
long	timeout Sets the Conversation timeout period, in milliseconds (E.g.: 5000 = 5 seconds.)

Element Detail

id

public abstract String id

Sets the new Conversation ID. Seam will Generate a conversation ID if left blank.

If a conversation with the ID already exists... TODO what should we do?

TODO test default conversation ID functionality

Default:

""

timeout

public abstract long timeout

Sets the Conversation timeout period, in milliseconds (E.g.: 5000 = 5 seconds.)

Default:

-1L

permit

public abstract Class<? extends Exception>[] permit

Sets the exception types for which, when encountered during a method invocation, the Conversation will still begin. (In other words: Permitted exceptions do not abort @Begin)

By default: { empty array } - all encountered exceptions will prevent the Conversation from beginning.

Default:

{}