com.atlassian.jira.rest.factory

Class Responder

java.lang.Object

com.atlassian.jira.rest.factory.Responder

@Component
public class Responder
extends Object

Provides ways standard ways of creating a Response.

Since:

6.4

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response.ResponseBuilder	builder(javax.ws.rs.core.Response.Status status) Starts a response builder for a given status.
javax.ws.rs.core.Response	errors(ErrorCollection errors) Converts an ErrorCollection to a Response.
javax.ws.rs.core.Response	exception(Exception exception) Creates a response about an exception.
javax.ws.rs.core.Response	restfulErrors(ErrorCollection errors) Converts an ErrorCollection to a Response.
javax.ws.rs.core.Response	successfulDelete() Standard response for a successful DELETE request.

Methods inherited from class java.lang.Object

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

Method Detail

errors

public javax.ws.rs.core.Response errors(ErrorCollection errors)

Converts an ErrorCollection to a Response.

Parameters:

errors - Errors to be converted

Returns:

Response with the worst reason as the status and the errors as the entity

restfulErrors

public javax.ws.rs.core.Response restfulErrors(ErrorCollection errors)

Converts an ErrorCollection to a Response.

Parameters:

errors - Errors to be converted

Returns:

Response with the worst reason as the status and the errors as the entity

successfulDelete

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

Standard response for a successful DELETE request.

Returns:

Standard response.

builder

public javax.ws.rs.core.Response.ResponseBuilder builder(javax.ws.rs.core.Response.Status status)

Starts a response builder for a given status.

Parameters:

status - Initial status

Returns:

Started builder

exception

public javax.ws.rs.core.Response exception(Exception exception)

Creates a response about an exception.

Parameters:

exception - Exception included in the response

Returns:

Response with the exception