com.atlassian.jira.plugin.searchrequestview

Interface SearchRequestViewAccessErrorHandler

public interface SearchRequestViewAccessErrorHandler

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERMISSION_VIOLATION
static String	SEARCH_REQUEST_DOES_NOT_EXIST

Method Summary

Modifier and Type	Method and Description
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.

Field Detail

PERMISSION_VIOLATION

static final String PERMISSION_VIOLATION

See Also:

Constant Field Values

SEARCH_REQUEST_DOES_NOT_EXIST

static final String SEARCH_REQUEST_DOES_NOT_EXIST

See Also:

Constant Field Values

Method Detail

writeErrorHeaders

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.

Parameters:

requestHeaders -

writePermissionViolationError

void writePermissionViolationError(Writer writer)
                            throws IOException

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.

Parameters:

writer -

Throws:

IOException

writeSearchRequestDoesNotExistError

void writeSearchRequestDoesNotExistError(Writer writer)
                                  throws IOException

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.

Parameters:

writer -

Throws:

IOException