com.atlassian.jwt

Interface CanonicalHttpRequest

public interface CanonicalHttpRequest

HTTP request that can be signed for use as a JWT claim.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
String	getMethod() HTTP method (e.g.
Map<String,String[]>	getParameterMap() The Map of parameter-name to parameter-values.
String	getRelativePath() The part of an absolute URL that is after the protocol, server, port and context (i.e.

Method Detail

getMethod

@Nonnull
String getMethod()

HTTP method (e.g. "GET", "POST" etc).

Returns:

the HTTP method in upper-case.

getRelativePath

@Nullable
String getRelativePath()

The part of an absolute URL that is after the protocol, server, port and context (i.e. base) path. E.g. "/the_path" in "http://server:80/context/the_path?param=value" where "/context" is the context path.

Returns:

the relative path with no case manipulation.

getParameterMap

@Nonnull
Map<String,String[]> getParameterMap()

The Map of parameter-name to parameter-values.

Returns:

Map representing { parameter-name-1 to { parameter-value-1, parameter-value-2 ... }, parameter-name-2 to { ... }, ... }