com.atlassian.plugins.rest.module

Class RestApiContext

java.lang.Object

com.atlassian.plugins.rest.module.RestApiContext

public class RestApiContext
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY_PATH_PATTERN
static String	LATEST
static String	SLASH

Constructor Summary

Constructors

Constructor and Description
RestApiContext(String restContext, String apiContext, ApiVersion version, Set<String> packages)

Method Summary

Modifier and Type	Method and Description
void	disabled()
String	getApiPath()
Optional<com.sun.jersey.api.core.DefaultResourceConfig>	getConfig()
String	getContextlessPathToVersion()
Set<String>	getPackages()
String	getPathToLatest()
String	getPathToVersion()
String	getPathToVersion(String version)
String	getRestContext()
ApiVersion	getVersion()
void	setConfig(com.sun.jersey.api.core.DefaultResourceConfig config)

Methods inherited from class java.lang.Object

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

Field Detail

SLASH

public static final String SLASH

See Also:

Constant Field Values

LATEST

public static final String LATEST

See Also:

Constant Field Values

ANY_PATH_PATTERN

public static final String ANY_PATH_PATTERN

See Also:

Constant Field Values

Constructor Detail

RestApiContext

public RestApiContext(String restContext,
                      String apiContext,
                      ApiVersion version,
                      Set<String> packages)

Method Detail

getRestContext

public String getRestContext()

Returns:

the REST context, always starts with "/".

getApiPath

public String getApiPath()

Returns:

the API path, always starts with "/"

getVersion

public ApiVersion getVersion()

Returns:

the API version

getPathToVersion

public String getPathToVersion()

Returns:

String representing /restContext/apiPath/version, always starts with "/"

getPathToLatest

public String getPathToLatest()

Returns:

String representing /restContext/apiPath/"latest", always starts with "/"

getPathToVersion

public String getPathToVersion(String version)

Parameters:

version - ApiVersion such as "1.2.3" or "none"

Returns:

String representing /restContext/apiPath/version, always starts with "/"

getContextlessPathToVersion

public String getContextlessPathToVersion()

Returns:

String representing /apiPath/version, always starts with "/"

getPackages

public Set<String> getPackages()

setConfig

public void setConfig(com.sun.jersey.api.core.DefaultResourceConfig config)

getConfig

public Optional<com.sun.jersey.api.core.DefaultResourceConfig> getConfig()

disabled

public void disabled()