com.atlassian.bamboo.plugins.rest.resource

Class QuickFilterResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.resource.QuickFilterResource

@Singleton
public class QuickFilterResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static RestQuickFilter	QUICK_FILTER_CREATE_EXAMPLE
static RestQuickFilter	QUICK_FILTER_RESPONSE_EXAMPLE
static RestQuickFilter	QUICK_FILTER_UPDATE_EXAMPLE

Constructor Summary

Constructors

Constructor and Description
QuickFilterResource(BambooUserManager bambooUserManager, QuickFilterManager quickFilterManager, com.atlassian.struts.TextProvider textProvider, UserActiveQuickFilterService userActiveQuickFilterService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	activateFilter(long quickFilterId, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Activates a quick filter for currently logged in user.
RestQuickFilter	createQuickFilter(RestQuickFilter restQuickFilter) Create a new quick filter with basic configuration, e.g.
javax.ws.rs.core.Response	deactivateAllFilters(com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Deactivates all quick filter for currently logged in user.
javax.ws.rs.core.Response	deactivateFilter(long quickFilterId, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Deactivates a quick filter for currently logged in user.
javax.ws.rs.core.Response	deleteQuickFilter(long quickFilterId) Delete a quick filter.
List<RestQuickFilter>	getActiveFilters(com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext) Return active quick filters for currently logged in user.
RestQuickFilter	getQuickFilter(long quickFilterId) Get a single quick filter by ID.
List<RestQuickFilter>	getQuickFilters() Obtain a list of quick filters defined for this Bamboo instance.
RestQuickFilter	updateQuickFilter(long quickFilterId, RestQuickFilter restQuickFilter) Update quick filter's basic configuration, e.g.

Methods inherited from class java.lang.Object

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

Field Detail

QUICK_FILTER_CREATE_EXAMPLE

public static final RestQuickFilter QUICK_FILTER_CREATE_EXAMPLE

QUICK_FILTER_UPDATE_EXAMPLE

public static final RestQuickFilter QUICK_FILTER_UPDATE_EXAMPLE

QUICK_FILTER_RESPONSE_EXAMPLE

public static final RestQuickFilter QUICK_FILTER_RESPONSE_EXAMPLE

Constructor Detail

QuickFilterResource

public QuickFilterResource(BambooUserManager bambooUserManager,
                           QuickFilterManager quickFilterManager,
                           com.atlassian.struts.TextProvider textProvider,
                           UserActiveQuickFilterService userActiveQuickFilterService)

Method Detail

getQuickFilters

public List<RestQuickFilter> getQuickFilters()

Obtain a list of quick filters defined for this Bamboo instance.

getQuickFilter

public RestQuickFilter getQuickFilter(long quickFilterId)
                               throws WebValidationException

Get a single quick filter by ID.

Throws:

WebValidationException

createQuickFilter

public RestQuickFilter createQuickFilter(@NotNull
                                         RestQuickFilter restQuickFilter)
                                  throws WebValidationException

Create a new quick filter with basic configuration, e.g. name or position on list. This method does not allow to configure quick filter's rules.

Throws:

WebValidationException

updateQuickFilter

public RestQuickFilter updateQuickFilter(long quickFilterId,
                                         @NotNull
                                         RestQuickFilter restQuickFilter)
                                  throws WebValidationException

Update quick filter's basic configuration, e.g. name or position on list. This method does not allow to configure quick filter's rules.

Throws:

WebValidationException

deleteQuickFilter

public javax.ws.rs.core.Response deleteQuickFilter(long quickFilterId)
                                            throws WebValidationException

Delete a quick filter.

Throws:

WebValidationException

getActiveFilters

public List<RestQuickFilter> getActiveFilters(@Context
                                              com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Return active quick filters for currently logged in user.

activateFilter

public javax.ws.rs.core.Response activateFilter(long quickFilterId,
                                                @Context
                                                com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
                                         throws WebValidationException

Activates a quick filter for currently logged in user.

Throws:

WebValidationException

deactivateFilter

public javax.ws.rs.core.Response deactivateFilter(long quickFilterId,
                                                  @Context
                                                  com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
                                           throws WebValidationException

Deactivates a quick filter for currently logged in user.

Throws:

WebValidationException

deactivateAllFilters

public javax.ws.rs.core.Response deactivateAllFilters(@Context
                                                      com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)

Deactivates all quick filter for currently logged in user.