com.atlassian.jira.user

Class MockApplicationUser

java.lang.Object

com.atlassian.jira.user.MockApplicationUser

All Implemented Interfaces:

WithId, WithKey, ApplicationUser, Principal

public class MockApplicationUser
extends Object
implements ApplicationUser

A convenient mock for ApplicationUser.

Since:

v6.0

Field Summary

Fields

Modifier and Type	Field and Description
static long	FAKE_USER_DIRECTORY_ID
static AtomicLong	SEQUENCE

Fields inherited from interface com.atlassian.jira.entity.WithId

ID_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
MockApplicationUser(String username) Uses the lowercase form of the supplied username as the key.
MockApplicationUser(String username, long directoryId)
MockApplicationUser(String userKey, String username) Uses the given key as-is.
MockApplicationUser(String username, String displayName, String email) Uses the lowercase form of the supplied username as the key.
MockApplicationUser(String userKey, String username, String displayName, String email) Uses the given key as-is.
MockApplicationUser(String userKey, com.atlassian.crowd.embedded.api.User user)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Implementations must ensure equality based on getKey().
long	getDirectoryId()
com.atlassian.crowd.embedded.api.User	getDirectoryUser()
String	getDisplayName() Returns the display name of the user.
String	getEmailAddress()
Long	getId()
String	getKey() Returns the key which distinguishes the ApplicationUser as unique.
String	getName() Synonym for ApplicationUser.getUsername() and implementation of Principal.getName().
String	getUsername()
int	hashCode() Implementations must produce a hashcode based on getKey().
boolean	isActive() A MockUser is always active by default.
MockApplicationUser	setActive(boolean active)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Field Detail

SEQUENCE

public static final AtomicLong SEQUENCE

FAKE_USER_DIRECTORY_ID

public static final long FAKE_USER_DIRECTORY_ID

See Also:

Constant Field Values

Constructor Detail

MockApplicationUser

public MockApplicationUser(String username)

Uses the lowercase form of the supplied username as the key.

Parameters:

username - as for MockUser.MockUser(String)

MockApplicationUser

public MockApplicationUser(String username,
                           long directoryId)

MockApplicationUser

public MockApplicationUser(String username,
                           String displayName,
                           String email)

Uses the lowercase form of the supplied username as the key.

Parameters:

username - as for MockUser.MockUser(String, String, String)

displayName - as for MockUser.MockUser(String, String, String)

email - as for MockUser.MockUser(String, String, String)

MockApplicationUser

public MockApplicationUser(String userKey,
                           String username)

Uses the given key as-is.

Parameters:

userKey - desired user's Key, the value to be returned for ApplicationUser.getKey()

username - as for MockUser.MockUser(String)

MockApplicationUser

public MockApplicationUser(String userKey,
                           String username,
                           String displayName,
                           String email)

Uses the given key as-is.

Parameters:

userKey - desired user's Key, the value to be returned for ApplicationUser.getKey()

username - as for MockUser.MockUser(String, String, String)

displayName - as for MockUser.MockUser(String, String, String)

email - as for MockUser.MockUser(String, String, String)

MockApplicationUser

public MockApplicationUser(String userKey,
                           com.atlassian.crowd.embedded.api.User user)

Method Detail

isActive

public boolean isActive()

A MockUser is always active by default.

Specified by:

isActive in interface ApplicationUser

Returns:

true if this user is active.

setActive

public MockApplicationUser setActive(boolean active)

getKey

public String getKey()

Description copied from interface: ApplicationUser

Returns the key which distinguishes the ApplicationUser as unique. The same key is shared by all Users with the same username (ignoring case) across all user directories.

Specified by:

getKey in interface WithKey

Specified by:

getKey in interface ApplicationUser

Returns:

the key which distinguishes the ApplicationUser as unique

getEmailAddress

public String getEmailAddress()

Specified by:

getEmailAddress in interface ApplicationUser

Returns:

email address of the user.

getDisplayName

public String getDisplayName()

Description copied from interface: ApplicationUser

Returns the display name of the user. This is sometimes referred to as "full name".

Specified by:

getDisplayName in interface ApplicationUser

Returns:

display name of the user, must never be null.

getDirectoryUser

public com.atlassian.crowd.embedded.api.User getDirectoryUser()

Specified by:

getDirectoryUser in interface ApplicationUser

Returns:

the user as seen by the particular user directory that this User is defined in.

getUsername

public String getUsername()

Specified by:

getUsername in interface ApplicationUser

Returns:

the username (login) of the user; must never be null.

See Also:

ApplicationUser.getName()

getName

public String getName()

Description copied from interface: ApplicationUser

Synonym for ApplicationUser.getUsername() and implementation of Principal.getName().

Specified by:

getName in interface ApplicationUser

Specified by:

getName in interface Principal

Returns:

the username (login) of the user; must never be null.

See Also:

ApplicationUser.getUsername()

getDirectoryId

public long getDirectoryId()

Specified by:

getDirectoryId in interface ApplicationUser

Returns:

the ID of the user directory that this user comes from.

equals

public boolean equals(Object obj)

Description copied from interface: ApplicationUser

Implementations must ensure equality based on getKey().

Specified by:

equals in interface ApplicationUser

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Parameters:

obj - object to compare to.

Returns:

true if and only if the key matches.

hashCode

public int hashCode()

Description copied from interface: ApplicationUser

Implementations must produce a hashcode based on getKey().

Specified by:

hashCode in interface ApplicationUser

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

Returns:

hashcode.

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object

getId

public Long getId()

Specified by:

getId in interface WithId

Returns:

the unique id of the entity.