com.atlassian.bitbucket.user

Interface ApplicationUser

All Superinterfaces:

Person, Principal

All Known Subinterfaces:

DetailedUser, ServiceUser

public interface ApplicationUser
extends Person, Principal

Represents a registered application user.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SLUG_LENGTH The maximum length of a user slug
static String	SLUG_REGEXP The regex for user slugs

Method Summary

Modifier and Type	Method and Description
<T> T	accept(ApplicationUserVisitor<T> visitor)
String	getDisplayName()
int	getId()
String	getSlug() Retrieves the "slug" for this user, which is a URL-friendly variant of its name.
UserType	getType()
boolean	isActive()

Methods inherited from interface com.atlassian.bitbucket.user.Person

getEmailAddress, getName

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Field Detail

MAX_SLUG_LENGTH

static final int MAX_SLUG_LENGTH

The maximum length of a user slug

See Also:

Constant Field Values

SLUG_REGEXP

static final String SLUG_REGEXP

The regex for user slugs

See Also:

Constant Field Values

Method Detail

accept

<T> T accept(@Nonnull
             ApplicationUserVisitor<T> visitor)

getDisplayName

@Nonnull
 @RequiredString(size=255)
String getDisplayName()

Returns:

the user's display name

getId

int getId()

Returns:

the user id

getType

@Nonnull
UserType getType()

Returns:

the type of user

isActive

boolean isActive()

Returns:

true if the user is enabled, false for deleted and disabled users.

getSlug

@Nonnull
 @RequiredString(size=127,
                regexp="[^\\\\/]+")
String getSlug()

Retrieves the "slug" for this user, which is a URL-friendly variant of its name. Each user's slug is guaranteed to be unique within the system.

Although URL-friendly, appropriate encoding should still be performed on this slug whenever it is used in a URL.

Returns:

the user's slug