Package com.atlassian.bamboo.user

Interface BambooUser

All Superinterfaces:

com.atlassian.user.Entity, Principal, Serializable, com.atlassian.user.User, org.acegisecurity.userdetails.UserDetails

All Known Implementing Classes:

DefaultBambooUser

public interface BambooUser
extends com.atlassian.user.User, org.acegisecurity.userdetails.UserDetails

An extension to Atlassian user's User interface to define extra properties for the user

Field Summary

Fields

Modifier and Type	Field	Description
static String	BOTH_PREF
static String	DEFAULT_NOTIFICATION_PREFERENCE
static String	DEFAULT_TRANSPORT_PREFERENCE
static String	EMAIL_PREF
static String	IM_PREF
static String	MULTIPART_EMAIL
static String	NONE_PREF
static String	TEXT_EMAIL

Method Summary

Modifier and Type	Method	Description
@Nullable AccessToken	getAccessToken()	If user has been authenticated by access token returns meta-data of token.
String	getJabberAddress()	Returns the user's jabber address for IMs
String	getNotificationPreference()	Returns the user's preferences for how they receive notifications
String	getNotificationTransportPreference()	Returns the user's preference for the format of emails
com.atlassian.user.User	getUser()	Returns the user, which contains the user's details

Methods inherited from interface com.atlassian.user.Entity

getName

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Methods inherited from interface com.atlassian.user.User

getEmail, getFullName, isEnabled

Methods inherited from interface org.acegisecurity.userdetails.UserDetails

getAuthorities, getPassword, getUsername, isAccountNonExpired, isAccountNonLocked, isCredentialsNonExpired, isEnabled

Field Detail

EMAIL_PREF

static final String EMAIL_PREF

See Also:

Constant Field Values

IM_PREF

static final String IM_PREF

See Also:

Constant Field Values

NONE_PREF

static final String NONE_PREF

See Also:

Constant Field Values

BOTH_PREF

static final String BOTH_PREF

See Also:

Constant Field Values

TEXT_EMAIL

static final String TEXT_EMAIL

See Also:

Constant Field Values

MULTIPART_EMAIL

static final String MULTIPART_EMAIL

See Also:

Constant Field Values

DEFAULT_NOTIFICATION_PREFERENCE

static final String DEFAULT_NOTIFICATION_PREFERENCE

See Also:

Constant Field Values

DEFAULT_TRANSPORT_PREFERENCE

static final String DEFAULT_TRANSPORT_PREFERENCE

See Also:

Constant Field Values

Method Detail

getJabberAddress

String getJabberAddress()

Returns the user's jabber address for IMs

Returns:

jabber address.

getUser

com.atlassian.user.User getUser()

Returns the user, which contains the user's details

Returns:

user.

getNotificationPreference

String getNotificationPreference()

Returns the user's preferences for how they receive notifications

Returns:

notification preference.

getNotificationTransportPreference

String getNotificationTransportPreference()

Returns the user's preference for the format of emails

Returns:

notification transport preference.

getAccessToken

@Nullable
@Nullable AccessToken getAccessToken()

If user has been authenticated by access token returns meta-data of token. Otherwise null.

Returns:

access token