public interface

SearchRequestViewAccessErrorHandler

com.atlassian.jira.plugin.searchrequestview.SearchRequestViewAccessErrorHandler

Class Overview

This interface defines an access error handler for the search request views. This is used to allow customization of search request permission violation and search request not found errors.

Summary

Constants
String PERMISSION_VIOLATION
String SEARCH_REQUEST_DOES_NOT_EXIST
Public Methods
void writeErrorHeaders(RequestHeaders requestHeaders)
Prints the HTML headers for non-typial HTML such as Word or Excel views.
void writePermissionViolationError(Writer writer)
Prints the error to display to the users if there has been a permission violation error looking up the SearchRequest that this view is meant to service.
void writeSearchRequestDoesNotExistError(Writer writer)
Prints the error to display to the users if there has been a permission violation error looking up the SearchRequest that this view is meant to service.

Constants

public static final String PERMISSION_VIOLATION

Constant Value: "permissionViolation"

public static final String SEARCH_REQUEST_DOES_NOT_EXIST

Constant Value: "searchRequestDoesNotExist"

Public Methods

public void writeErrorHeaders (RequestHeaders requestHeaders)

Prints the HTML headers for non-typial HTML such as Word or Excel views. (e.g.: requestHeaders.addHeader("content-disposition", "attachment;filename="sample.doc";");) This method will be called before either writeSearchRequestDoesNotExistError or writePermissionViolationError.

Please make certain that you set the content type and character set in this method.

public void writePermissionViolationError (Writer writer)

Prints the error to display to the users if there has been a permission violation error looking up the SearchRequest that this view is meant to service.

Throws
IOException

public void writeSearchRequestDoesNotExistError (Writer writer)

Prints the error to display to the users if there has been a permission violation error looking up the SearchRequest that this view is meant to service.

Throws
IOException