@ExperimentalApi public interface

UserBeanFactory

com.atlassian.jira.issue.fields.rest.json.UserBeanFactory
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Class Overview

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

Summary

Public Methods
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.
@Deprecated UserJsonBean createBean(ApplicationUser createdUser)
UserJsonBean createBean(ApplicationUser createdUser, 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)
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.

Public Methods

public 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

@Deprecated public UserJsonBean createBean (ApplicationUser createdUser)

This method is 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

public 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)

public 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)

public 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