Package com.atlassian.confluence.api.impl.service.content.factory

Class PersonFactory

java.lang.Object

com.atlassian.confluence.api.impl.service.content.factory.PersonFactory

All Implemented Interfaces:

ModelFactory<ConfluenceUser,User>

public class PersonFactory
extends Object
implements ModelFactory<ConfluenceUser,User>

Builder for Person objects.

Constructor Summary

Constructors

Constructor	Description
PersonFactory(UserAccessor userAccessor, com.atlassian.webresource.api.WebResourceUrlProvider webResourceUrlProvider, I18NBeanFactory i18nBeanFactory, LoginManager loginManager, DateFormatterFactory dateFormatterFactory)

Method Summary

Modifier and Type	Method	Description
Anonymous	anonymous()
User	buildFrom(ConfluenceUser hibernateObject, Expansions expansions)
@NonNull Person	forCurrentUser()
@NonNull Person	forCurrentUser(Expansions expansions)	Construct the person object for the current user.
Person	forUser(ConfluenceUser user)
Person	forUser(ConfluenceUser user, Expansions expansions)	Construct the person object for a particular user.
Person	forUser(ConfluenceUser user, Expansions expansions, boolean profilePictureIncludedByDefault)	Construct the person object for a particular user.
Person	forUserKey(String userKey, Expansions expansions)	Construct the person object for a particular userKey.
Person	forUserKeyWithoutProfile(String userKey)	Find a person by user key
Person	forUserKeyWithoutProfile(String userKey, Expansions expansions)	Find a person by user key
Person	forUsername(String username)	Construct the person object for a particular username.
Person	forUsernameWithoutProfile(String username)	Construct the person object for a particular username.
Person	forUserWithLoginInfo(ConfluenceUser user, Expansions expansions)
User	fromUser(@NonNull ConfluenceUser user)
User	fromUser(@NonNull ConfluenceUser user, Expansions expansions)	Constructs a User object for a particular user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.api.model.ModelFactory

buildFrom

Constructor Details

PersonFactory

public PersonFactory(UserAccessor userAccessor,
 com.atlassian.webresource.api.WebResourceUrlProvider webResourceUrlProvider,
 I18NBeanFactory i18nBeanFactory,
 LoginManager loginManager,
 DateFormatterFactory dateFormatterFactory)

Method Details

forUsername

public Person forUsername(String username)

Construct the person object for a particular username. Null usernames will return the anonymous person

Parameters:

username - the username of the person to represent

Returns:

the corresponding Person object

forUsernameWithoutProfile

public Person forUsernameWithoutProfile(String username)

Construct the person object for a particular username. Null usernames will return the anonymous person This will not load profile picture to keep better performance

Parameters:

username -

Returns:

forUserKeyWithoutProfile

public Person forUserKeyWithoutProfile(String userKey)

Find a person by user key

Parameters:

userKey - the user key string

Returns:

a Person object

Since:

9.3.0

forUserKeyWithoutProfile

public Person forUserKeyWithoutProfile(String userKey,
 Expansions expansions)

Find a person by user key

Parameters:

userKey - the user key string

Returns:

a Person object

Since:

9.3.0

forUserKey

public Person forUserKey(String userKey,
 Expansions expansions)

Construct the person object for a particular userKey. Null usernames will return the anonymous person

Parameters:

userKey - the user key of the person to represent

Returns:

the corresponding Person object

forUser

public Person forUser(ConfluenceUser user,
 Expansions expansions)

Construct the person object for a particular user. Null users will return the anonymous person

Parameters:

user - the user to represent as a Person

Returns:

the corresponding Person object

See Also:

• forCurrentUser()

forUser

public Person forUser(ConfluenceUser user,
 Expansions expansions,
 boolean profilePictureIncludedByDefault)

Construct the person object for a particular user. Null users will return the anonymous person.

Parameters:

user - the user to represent as a Person

profilePictureIncludedByDefault - whether the profile picture of a user should be included by default (if not, it is possible to provide an expansion to include it).

Returns:

the corresponding Person object

forUserWithLoginInfo

public Person forUserWithLoginInfo(ConfluenceUser user,
 Expansions expansions)

forUser

public Person forUser(ConfluenceUser user)

forCurrentUser

public @NonNull Person forCurrentUser(Expansions expansions)

Construct the person object for the current user. Null users will return the anonymous person

Returns:

the corresponding Person object for the thread-local authenticated user

See Also:

• forUser(com.atlassian.confluence.user.ConfluenceUser)

forCurrentUser

public @NonNull Person forCurrentUser()

fromUser

public User fromUser(@NonNull ConfluenceUser user,
 Expansions expansions)

Constructs a User object for a particular user. Null users are not permitted.

Parameters:

user -

Returns:

fromUser

public User fromUser(@NonNull ConfluenceUser user)

anonymous

public Anonymous anonymous()

buildFrom

public User buildFrom(ConfluenceUser hibernateObject,
 Expansions expansions)

Specified by:

buildFrom in interface ModelFactory<ConfluenceUser,User>