Package com.top_logic.base.token

TODO TGI this information is out of Date. Tokens are used to allow locks in a cluster environment.

For single machine usage there is the {@link com.top_logic.base.token.manage.TransientTokenManager}. In a cluster you should use the {@link com.top_logic.base.token.manage.PersistentTokenManager}. This can be configured in the top-logic.xml.

A set of {@link com.top_logic.base.token.manage.Token}s is held togehter by a {@link com.top_logic.base.token.manage.TokenContext}. The actual semantic depends on your application. You can assume that every token represents a business object and the TokenContext as a whole defines dome business logic you want to apply. A TokenContext will time out if not renewed. So before doing any transaction check that your TokenContext ist still valid.

Token can be aquired in three modes {@link com.top_logic.base.token.manage.Token#SHARED}, {@link com.top_logic.base.token.manage.Token#LOCAL} and {@link com.top_logic.base.token.manage.Token#EXCLUSIVE} (in ascending precedence). Any token loked with a higher mode will deny access by other Tokens with same or lower mode. Ist is planned to add some mechanism do lock along some sort of configurable dependency graph, ask TGI about the details.

The {@link com.top_logic.tool.form.EditComponent} is a convenient class that glues together GUI logic and Transaction handling.