com.cenqua.fisheye.user.plugin
Interface AuthToken

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ExampleFishEyeAuthenticator.ExampleAuthToken

public interface AuthToken
extends java.io.Serializable

A token representing a successful login.

Instances of this class are stored in a Servlet session, and are long-lived. An instance may live longer than the FishEyeAuthenticator that created it. It should not (for example) contain connections to a database, etc.

Method Summary

java.lang.String	getDisplayName() The full name to use when displaying data by this user.
java.lang.String	getEmail() The email address of the user (if the underlying authenticator can automatically determine it).
java.lang.String	getUsername() The username used when authenticating the user

Method Detail

getUsername

java.lang.String getUsername()

The username used when authenticating the user

getEmail

java.lang.String getEmail()

The email address of the user (if the underlying authenticator can automatically determine it).

Returns:

user's email address, or null if not known.

getDisplayName

java.lang.String getDisplayName()

The full name to use when displaying data by this user.

Returns:

the name to use for display purposes, or null.