com.atlassian.jira.issue.fields.rest.json

Interface UserBeanFactory

All Known Implementing Classes:

DefaultUserBeanFactory

@ExperimentalApi
public interface UserBeanFactory

This provides a simple, dependency-free, straight forward API to generating the JSON corresponding to a User.

Since:

v5.2

Method Summary

Modifier and Type	Method and Description
UserJsonBean	createBean(ApplicationUser createdUser) Deprecated. Use createBean(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser)
UserJsonBean	createBean(ApplicationUser createdUser, ApplicationUser loggedInUser) Generate a bean suitable for serialisation by Jackon into JSON for given user in the context of loggedInUser.
UserJsonBean	createBean(ApplicationUser createdUser, ApplicationUser loggedInUser, JiraBaseUrls jiraBaseUrls, EmailFormatter emailFormatter, TimeZoneManager timeZoneManager) Generate a bean suitable for serialisation by Jackon into JSON for given user in the context of loggedInUser.
Collection<UserJsonBean>	createBeanCollection(Collection<ApplicationUser> createdUsers, ApplicationUser loggedInUser) Generate a bean suitable for serialisation by Jackon into JSON for given user in the context of loggedInUser.
Collection<UserJsonBean>	createBeanCollection(Collection<ApplicationUser> createdUsers, ApplicationUser loggedInUser, JiraBaseUrls jiraBaseUrls, EmailFormatter emailFormatter, TimeZoneManager timeZoneManager) Generate a bean suitable for serialisation by Jackon into JSON for given user in the context of loggedInUser.

Method Detail

createBean

@Deprecated
UserJsonBean createBean(ApplicationUser createdUser)

Deprecated. Use createBean(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.user.ApplicationUser)

Generate a bean suitable for serialisation by Jackon into JSON.

Parameters:

createdUser - Create UserJsonBean for this user

createBean

UserJsonBean createBean(ApplicationUser createdUser,
                        ApplicationUser loggedInUser)

Generate a bean suitable for serialisation by Jackon into JSON for given user in the context of loggedInUser.

Parameters:

createdUser - Create UserJsonBean for createdUser

loggedInUser - UserJsonBean will be created in the context of loggedInUser (i.e. escape/hide email address if necessary)

createBean

UserJsonBean createBean(ApplicationUser createdUser,
                        ApplicationUser loggedInUser,
                        JiraBaseUrls jiraBaseUrls,
                        EmailFormatter emailFormatter,
                        TimeZoneManager timeZoneManager)

Generate a bean suitable for serialisation by Jackon into JSON for given user in the context of loggedInUser.

Parameters:

createdUser - Create UserJsonBean for createdUser

loggedInUser - UserJsonBean will be created in the context of loggedInUser (i.e. escape/hide email address if necessary)

jiraBaseUrls - JiraBaseUrls

emailFormatter - EmailFormatter

timeZoneManager - TimeZoneManager

createBeanCollection

Collection<UserJsonBean> createBeanCollection(Collection<ApplicationUser> createdUsers,
                                              ApplicationUser loggedInUser)

Generate a bean suitable for serialisation by Jackon into JSON for given user in the context of loggedInUser.

Parameters:

createdUsers - Create UserJsonBeans for createdUsers

loggedInUser - UserJsonBean will be created in the context of loggedInUser (i.e. escape/hide email address if necessary)

createBeanCollection

Collection<UserJsonBean> createBeanCollection(Collection<ApplicationUser> createdUsers,
                                              ApplicationUser loggedInUser,
                                              JiraBaseUrls jiraBaseUrls,
                                              EmailFormatter emailFormatter,
                                              TimeZoneManager timeZoneManager)

Generate a bean suitable for serialisation by Jackon into JSON for given user in the context of loggedInUser.

Parameters:

createdUsers - Create UserJsonBeans for createdUsers

loggedInUser - UserJsonBean will be created in the context of loggedInUser (i.e. escape/hide email address if necessary)

jiraBaseUrls - JiraBaseUrls

emailFormatter - EmailFormatter

timeZoneManager - TimeZoneManager