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

Class PersonFactory

java.lang.Object

com.atlassian.confluence.api.impl.service.content.factory.ModelFactory<ConfluenceUser,User>

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

public class PersonFactory
extends ModelFactory<ConfluenceUser,User>

Builder for Person objects.

Constructor Summary

Constructors

Constructor and Description
PersonFactory(UserAccessor userAccessor, com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider, I18NBeanFactory i18nBeanFactory, UserDetailsManager userDetailsManager)

Method Summary

Modifier and Type	Method and Description
Anonymous	anonymous()
User	buildFrom(ConfluenceUser hibernateObject, Expansions expansions)
Person	forCurrentUser(Expansion... expansions) Construct the person object for the current user.
Person	forUser(ConfluenceUser user, Expansion... expansions) Construct the person object for a particular user.
Person	forUsername(String username) Construct the person object for a particular username.
User	fromUser(ConfluenceUser user, Expansion... expansions) Constructs a User object for a particular user.

Methods inherited from class com.atlassian.confluence.api.impl.service.content.factory.ModelFactory

asFunction, buildFrom

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonFactory

public PersonFactory(UserAccessor userAccessor,
                     com.atlassian.plugin.webresource.WebResourceUrlProvider webResourceUrlProvider,
                     I18NBeanFactory i18nBeanFactory,
                     UserDetailsManager userDetailsManager)

Method Detail

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

forUser

public Person forUser(ConfluenceUser user,
                      Expansion... 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

expansions - any expansions to apply to the returned user.

Returns:

the corresponding Person object

See Also:

forCurrentUser(Expansion...)

forCurrentUser

@Nonnull
public Person forCurrentUser(Expansion... expansions)

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

Parameters:

expansions - any expansions to apply to the returned user.

Returns:

the corresponding Person object for the thread-local authenticated user

See Also:

forUser(ConfluenceUser, Expansion...)

fromUser

public User fromUser(@Nonnull
                     ConfluenceUser user,
                     Expansion... expansions)

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

Parameters:

user - ConfluenceUser object to construct User from.

expansions - any expansions to apply to the returned user.

Returns:

a User object corresponding to the given user.

anonymous

public Anonymous anonymous()

buildFrom

public User buildFrom(ConfluenceUser hibernateObject,
                      Expansions expansions)

Specified by:

buildFrom in class ModelFactory<ConfluenceUser,User>