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

Class StreamingCommentsJsonBean

java.lang.Object

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

All Implemented Interfaces:

CommentsJsonBean

public class StreamingCommentsJsonBean
extends Object
implements CommentsJsonBean

Since:

7.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMBEDDED_COMMENTS_BACKGROUND_LIMIT	Deprecated. use CommentsMaxCountProvider.EMBEDDED_COMMENTS_BACKGROUND_LIMIT_APPLICATION_PROPERTIES_KEY instead

Constructor Summary

Constructors

Modifier	Constructor	Description
	StreamingCommentsJsonBean(Issue issue, boolean isRendered, String rendererType)	Deprecated. Use StreamingCommentsJsonBean(Issue issue, boolean isRendered, String rendererType, ApplicationUser contextUser, ApplicationProperties applicationProperties, boolean isBackgroundProcessing)
	StreamingCommentsJsonBean(Issue issue, boolean isRendered, String rendererType, ApplicationUser contextUser)	Deprecated.
protected	StreamingCommentsJsonBean(Issue issue, boolean isRendered, String rendererType, ApplicationUser contextUser, int limit, boolean firstPage)
	StreamingCommentsJsonBean(Issue issue, boolean isRendered, String rendererType, ApplicationUser contextUser, ApplicationProperties applicationProperties, boolean isBackgroundProcessing)	Constructor for StreamingCommentsJsonBean that handles user context for filtering comments.

Method Summary

Modifier and Type	Method	Description
ApplicationUser	getContextUser()
Issue	getIssue()
int	getLimit()
String	getRendererType()
boolean	isFirstPageRequested()
boolean	isRendered()

Methods inherited from class java.lang.Object

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

Field Details

EMBEDDED_COMMENTS_BACKGROUND_LIMIT

@Deprecated
public static final String EMBEDDED_COMMENTS_BACKGROUND_LIMIT

Deprecated.

use CommentsMaxCountProvider.EMBEDDED_COMMENTS_BACKGROUND_LIMIT_APPLICATION_PROPERTIES_KEY instead

The limit relates to the webhook payloads that uses this serializer under the hood and cant be passed by any context due to how beans are serialized in webhooks. The desired approach is to make this implementation more flexible in the future

See Also:

• Constant Field Values

Constructor Details

StreamingCommentsJsonBean

@Deprecated
public StreamingCommentsJsonBean(Issue issue,
 boolean isRendered,
 String rendererType)

Deprecated.

Use StreamingCommentsJsonBean(Issue issue, boolean isRendered, String rendererType, ApplicationUser contextUser, ApplicationProperties applicationProperties, boolean isBackgroundProcessing)

Parameters:

issue - the issue associated with the comments

isRendered - whether the comments should be rendered

rendererType - the type of renderer to use for the comments

StreamingCommentsJsonBean

@Deprecated
public StreamingCommentsJsonBean(Issue issue,
 boolean isRendered,
 String rendererType,
 ApplicationUser contextUser)

Deprecated.

Constructor for StreamingCommentsJsonBean that handles user context for filtering comments. See JRASERVER-74097

Parameters:

issue - the issue associated with the comments

isRendered - whether the comments should be rendered

rendererType - the type of renderer to use for the comments

contextUser - the user context for filtering comments (check browse permissions)

Since:

v10.7.3

StreamingCommentsJsonBean

public StreamingCommentsJsonBean(Issue issue,
 boolean isRendered,
 String rendererType,
 ApplicationUser contextUser,
 ApplicationProperties applicationProperties,
 boolean isBackgroundProcessing)

Constructor for StreamingCommentsJsonBean that handles user context for filtering comments. See https://jira.atlassian.com/browse/JRASERVER-74097

Parameters:

issue - the issue associated with the comments

isRendered - whether the comments should be rendered

rendererType - the type of renderer to use for the comments

contextUser - the user context for filtering comments (check browse permissions)

applicationProperties - the application properties to retrieve the limit for comments page size

isBackgroundProcessing - inform if serialization is made in background (webhook) or foreground (rest) context

Since:

v10.3.8

StreamingCommentsJsonBean

protected StreamingCommentsJsonBean(Issue issue,
 boolean isRendered,
 String rendererType,
 ApplicationUser contextUser,
 int limit,
 boolean firstPage)

Method Details

getIssue

public Issue getIssue()

isRendered

public boolean isRendered()

getRendererType

public String getRendererType()

getContextUser

public ApplicationUser getContextUser()

getLimit

public int getLimit()

isFirstPageRequested

public boolean isFirstPageRequested()