com.atlassian.greenhopper.web

Class AbstractResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

Direct Known Subclasses:

AbstractGadgetResource, AssigneeUserPickerResource, AttachmentsResource, CacheControlResource, CardColorResource, CardLayoutResource, ClassicMigrationResource, CompleteSprintResource, DetailViewFieldResource, EpicPropertiesResource, EpicResource, FeaturesResource, FlagResource, IssueResource, JiraTaskResource, LexoRankResource, ManagedCustomFieldsResource, ManagedIssueLinkTypesResource, ManagedIssueTypesResource, PlanningModeResource, ProjectResource, QuickFilterResource, RankResource, RankResource, RapidBoardResource, RapidChartResource, RapidViewEditResource, RapidViewListResource, RapidViewResource, ReleaseResource, RemoteEpicLinkResource, RemoteIssueLinkResource, RemoteLinkConversationResource, RemoteSprintLinkResource, SavedFilterResource, SearchConfluencePagesResource, SprintHealthResource, SprintMarkerMigrationResource, SprintMigrationBannerResource, SprintPagesResource, SprintQueryResource, SprintRankResource, SprintRemainingDaysResource, SprintResource, StartSprintResource, SubqueryResource, SwimlaneResource, TeamCalendarsResource, UserDataResource, VersionResource, WelcomeResource, WorkflowResource, WorkingDaysResource, WorkResource

public abstract class AbstractResource
extends Object

To be extended by all GreenHopper rest resources. Provides no-cache logic.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_HEADER_GREENHOPPER_GADGET
protected LoggerWrapper	log

Constructor Summary

Constructors

Constructor and Description
AbstractResource()

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	check(ServiceOutcome<T> outcome) Check this outcome for errors.
javax.ws.rs.core.Response	createErrorResponse(ErrorCollection errors) Deprecated. Use ErrorCollection.checkErrors(com.atlassian.greenhopper.model.I18n2) instead.
javax.ws.rs.core.Response	createFromServiceOutcome(ServiceOutcome<? extends RestTemplate> outcome) Deprecated.
javax.ws.rs.core.Response	createNoContentResponse()
javax.ws.rs.core.Response	createOkResponse(RestTemplate entity) Returns an ok response with NO_CACHE headers applied to it.
javax.ws.rs.core.Response	createOkResponse(RestTemplate template, javax.ws.rs.core.EntityTag eTag) Creates an ok response including an etag.
protected com.atlassian.crowd.embedded.api.User	getUser()
protected boolean	isGadgetRequest() Is this request for rendering a gadget? GH.Ajax.get() puts in a special header if sending ajax requests for gadgets.
protected <T> Set<T>	nullSafe(Set<T> set) Used for converting sets created by Jersey.
protected javax.ws.rs.core.Response	response(Callable<javax.ws.rs.core.Response> responseCallable) A standard way to invoke a REST resource and handle errors that might be throw.
protected javax.ws.rs.core.Response	responseWithoutAccessCheck(Callable<javax.ws.rs.core.Response> responseCallable) A standard way to invoke a REST resource and handle errors that might be throw.
void	wireAuthenticationContext(com.atlassian.jira.security.JiraAuthenticationContext authenticationContext)
void	wireI18nFactoryService(I18nFactoryService i18nFactoryService)
void	wireLicenseChecker(LicenseService licenseService)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final LoggerWrapper log

HTTP_HEADER_GREENHOPPER_GADGET

public static final String HTTP_HEADER_GREENHOPPER_GADGET

See Also:

Constant Field Values

Constructor Detail

AbstractResource

public AbstractResource()

Method Detail

wireI18nFactoryService

public void wireI18nFactoryService(I18nFactoryService i18nFactoryService)

wireAuthenticationContext

public void wireAuthenticationContext(com.atlassian.jira.security.JiraAuthenticationContext authenticationContext)

wireLicenseChecker

public void wireLicenseChecker(LicenseService licenseService)

response

protected javax.ws.rs.core.Response response(Callable<javax.ws.rs.core.Response> responseCallable)

A standard way to invoke a REST resource and handle errors that might be throw. JIRA as of 5.0 lose stuff when bad errors happen and this way any badness is captured into atlassian-greenhopper.log

Will perform the access check before invoking the passed in callable.

Parameters:

responseCallable - a callable block of code

Returns:

the REST response from that callable block of code 403 if the current user is not a software user

responseWithoutAccessCheck

protected javax.ws.rs.core.Response responseWithoutAccessCheck(Callable<javax.ws.rs.core.Response> responseCallable)

A standard way to invoke a REST resource and handle errors that might be throw. JIRA as of 5.0 lose stuff when bad errors happen and this way any badness is captured into atlassian-greenhopper.log

Does not perform the access check before invoking the passed in callable.

Parameters:

responseCallable - a callable block of code

Returns:

the REST response from that callable block of code

createOkResponse

public javax.ws.rs.core.Response createOkResponse(RestTemplate entity)

Returns an ok response with NO_CACHE headers applied to it.

Parameters:

entity - the returned rest template

Returns:

a REST response

createOkResponse

public javax.ws.rs.core.Response createOkResponse(RestTemplate template,
                                         javax.ws.rs.core.EntityTag eTag)

Creates an ok response including an etag.

Parameters:

template - the template to used

eTag - an entity tag

Returns:

a REST response

createNoContentResponse

public javax.ws.rs.core.Response createNoContentResponse()

createFromServiceOutcome

@Deprecated
public javax.ws.rs.core.Response createFromServiceOutcome(ServiceOutcome<? extends RestTemplate> outcome)

Deprecated.

createErrorResponse

@Deprecated
public javax.ws.rs.core.Response createErrorResponse(ErrorCollection errors)

Deprecated. Use ErrorCollection.checkErrors(com.atlassian.greenhopper.model.I18n2) instead.

check

public <T> T check(ServiceOutcome<T> outcome)

Check this outcome for errors. If found, will implement ErrorCollection.checkErrors(com.atlassian.greenhopper.model.I18n2), which will throw some REST exceptions.

Parameters:

outcome - the outcome to check

nullSafe

protected <T> Set<T> nullSafe(Set<T> set)

Used for converting sets created by Jersey. They're null if the respective parameter wasn't specified. Null collections are bad. Stupid Jersey.

Parameters:

set - that cant be null

Returns:

a non null set

getUser

protected com.atlassian.crowd.embedded.api.User getUser()

isGadgetRequest

protected boolean isGadgetRequest()

Is this request for rendering a gadget? GH.Ajax.get() puts in a special header if sending ajax requests for gadgets.

Returns:

true or false