Package com.atlassian.jira.rest.v1.images

Class HeaderSeparatorResouce

java.lang.Object

com.atlassian.jira.rest.v1.images.HeaderSeparatorResouce

@Path("header-separator")
@Produces("image/png")
public class HeaderSeparatorResouce
extends Object

REST endpoint for retrieving a header separator of a given colour.

Since:

v4.0

Constructor Summary

Constructors

Constructor	Description
HeaderSeparatorResouce(HeaderSeparatorService headerSeparatorService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getImage(String colorHex, String backgroundColorHex)	Retrieve a header separator for the passed in colors.
javax.ws.rs.core.Response	getImageFromPath(String colorHex, String backgroundColorHex)	Same as the /header-separator?color&bgcolor url, but the colours are specified in the path not the query string.

Methods inherited from class java.lang.Object

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

Constructor Details

HeaderSeparatorResouce

@Inject
public HeaderSeparatorResouce(HeaderSeparatorService headerSeparatorService)

Method Details

getImage

@GET
public javax.ws.rs.core.Response getImage(@QueryParam("color")
 String colorHex,
 @QueryParam("bgcolor")
 String backgroundColorHex)

Retrieve a header separator for the passed in colors.

Input strings can ontain a leading hash (#) and can be a 3 char or 6 char hex string. See any web tutorial for what colour the string represents.

This is cached effectively forever

Parameters:

colorHex - The main color of the separator

backgroundColorHex - The background colour of the separator.

Returns:

An array of bytes that represent the returned png. This is cached effectively forever

getImageFromPath

@GET
@Path("/{hash}/{color}/{bgcolor}/img.png")
public javax.ws.rs.core.Response getImageFromPath(@PathParam("color")
 String colorHex,
 @PathParam("bgcolor")
 String backgroundColorHex)

Same as the /header-separator?color&bgcolor url, but the colours are specified in the path not the query string. The leading (hash) component of the path is ignored.