com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client

Class FeatureKeyClient

java.lang.Object

com.atlassian.jira.testkit.client.RestApiClient<FeatureKeyClient>

com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.FeatureKeyClient

public class FeatureKeyClient
extends com.atlassian.jira.testkit.client.RestApiClient<FeatureKeyClient>

Client for the site dark features resource.

Since:

v7.1

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.jira.testkit.client.RestApiClient

com.atlassian.jira.testkit.client.RestApiClient.Method

Field Summary

Fields inherited from class com.atlassian.jira.testkit.client.RestApiClient

loginAs, loginPassword, REST_VERSION

Constructor Summary

Constructors

Constructor and Description
FeatureKeyClient(com.atlassian.jira.testkit.client.JIRAEnvironmentData environmentData) Constructs a new FeatureKeyClient for a JIRA instance.

Method Summary

Modifier and Type	Method and Description
protected com.sun.jersey.api.client.WebResource	featureFlags() Returns a WebResource for site dark features.
protected com.sun.jersey.api.client.WebResource	featureFlagWithKey(String featureKey) Returns a WebResource for site dark features for the given key.
Map<?,?>	get() GETs all the defined feature flags
com.atlassian.jira.testkit.client.restclient.DarkFeature	get(String featureKey) GETs the dark feature with the given key.
com.atlassian.jira.testkit.client.restclient.Response	getResponse() GETs all the defined feature flags returning a Response object.
com.atlassian.jira.testkit.client.restclient.Response	getResponse(String featureKey) GETs the featureKey, returning a Response object.
void	put(String featureKey, boolean enabled) PUTs the feature key and enablement
com.atlassian.jira.testkit.client.restclient.Response	putResponse(String featureKey, boolean enabled) PUTs the featureKey and enablement, returning a Response object.

Methods inherited from class com.atlassian.jira.testkit.client.RestApiClient

anonymous, cleanUp, client, createResource, createResourceGadget, createResourceInternal, errorResponse, expanded, getEnvironmentData, loginAs, loginAs, percentEncode, registerResponse, resourceRoot, setOf, toResponse, toResponse, toResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureKeyClient

public FeatureKeyClient(com.atlassian.jira.testkit.client.JIRAEnvironmentData environmentData)

Constructs a new FeatureKeyClient for a JIRA instance.

Parameters:

environmentData - The JIRA environment data

Method Detail

put

public void put(String featureKey,
                boolean enabled)
         throws com.sun.jersey.api.client.UniformInterfaceException

PUTs the feature key and enablement

Parameters:

featureKey - feature key

enabled - whether to enable or disable the dark feature

Throws:

com.sun.jersey.api.client.UniformInterfaceException - if there's a problem enabling the dark feature

putResponse

public com.atlassian.jira.testkit.client.restclient.Response putResponse(String featureKey,
                                                                         boolean enabled)

PUTs the featureKey and enablement, returning a Response object.

Parameters:

featureKey - feature key

enabled - whether to enable or disable the dark feature

Returns:

a Response

get

public Map<?,?> get()
             throws com.sun.jersey.api.client.UniformInterfaceException

GETs all the defined feature flags

Returns:

the dark feature

Throws:

com.sun.jersey.api.client.UniformInterfaceException - if there's a problem enabling the dark feature

getResponse

public com.atlassian.jira.testkit.client.restclient.Response getResponse()

GETs all the defined feature flags returning a Response object.

Returns:

a Response

get

public com.atlassian.jira.testkit.client.restclient.DarkFeature get(String featureKey)
                                                             throws com.sun.jersey.api.client.UniformInterfaceException

GETs the dark feature with the given key.

Parameters:

featureKey - the feature key

Returns:

the dark feature

Throws:

com.sun.jersey.api.client.UniformInterfaceException - if there's a problem enabling the dark feature

getResponse

public com.atlassian.jira.testkit.client.restclient.Response getResponse(String featureKey)

GETs the featureKey, returning a Response object.

Parameters:

featureKey - feature key

Returns:

a Response

featureFlags

protected com.sun.jersey.api.client.WebResource featureFlags()

Returns a WebResource for site dark features.

Returns:

a WebResource

featureFlagWithKey

protected com.sun.jersey.api.client.WebResource featureFlagWithKey(String featureKey)

Returns a WebResource for site dark features for the given key.

Parameters:

featureKey - feature key

Returns:

a WebResource