cd.connect.features

Interface FeatureService

All Known Implementing Classes:

FeatureServiceImpl

@Generated(value="cd.connect.openapi.Jersey2V3ApiGenerator",
           date="2019-05-10T22:38:37.127+12:00[Pacific/Auckland]")
 @Path(value="/features")
public interface FeatureService

Method Summary

Modifier and Type	Method and Description
List<FeatureState>	allFeatures() Gets a list of features and their states
List<FeatureState>	applyAll(List<FeatureState> body) Sets a list of features and their states in a single request
Integer	count() count number of features.
List<String>	disabledFeatures() the features that are disabled.
FeatureState	disableFeature(String name) Disables feature
List<String>	enabledFeatures() the features that are enabled.
FeatureState	enableFeature(String name) Enables feature
List<FeatureState>	ensureExists(List<String> body) Ensures that this list of features exists in the feature service
FeatureState	getFeature(String name) Gets the details about the feature identified by the name
FeatureState	lockFeature(String name) Locks feature
String	refresh() refresh feature states
FeatureState	unlockFeature(String name) Unlocks feature

Method Detail

allFeatures

@GET
 @Produces(value="application/json")
List<FeatureState> allFeatures()

Gets a list of features and their states

Returns:

List<FeatureState>

applyAll

@PUT
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<FeatureState> applyAll(List<FeatureState> body)

Sets a list of features and their states in a single request

Parameters:

body - (required)

Returns:

List<FeatureState>

count

@GET
 @Path(value="/count")
 @Produces(value="text/plain")
Integer count()

count number of features. Convenience function for UI.

Returns:

Integer

disableFeature

@PUT
 @Path(value="/disable/{name}")
 @Produces(value="application/json")
FeatureState disableFeature(@PathParam(value="name")
                                                                                                      String name)

Disables feature

Parameters:

name - the feature name (required)

Returns:

FeatureState

disabledFeatures

@GET
 @Path(value="/disabled")
 @Produces(value="application/json")
List<String> disabledFeatures()

the features that are disabled. Convenience function for UI.

Returns:

List<String>

enableFeature

@PUT
 @Path(value="/enable/{name}")
 @Produces(value="application/json")
FeatureState enableFeature(@PathParam(value="name")
                                                                                                    String name)

Enables feature

Parameters:

name - the feature name (required)

Returns:

FeatureState

enabledFeatures

@GET
 @Path(value="/enabled")
 @Produces(value="application/json")
List<String> enabledFeatures()

the features that are enabled. Convenience function for UI.

Returns:

List<String>

ensureExists

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<FeatureState> ensureExists(List<String> body)

Ensures that this list of features exists in the feature service

Parameters:

body - (required)

Returns:

List<FeatureState>

getFeature

@GET
 @Path(value="/feature/{name}")
 @Produces(value="application/json")
FeatureState getFeature(@PathParam(value="name")
                                                                                                  String name)

Gets the details about the feature identified by the name

Parameters:

name - the feature name (required)

Returns:

FeatureState

lockFeature

@PUT
 @Path(value="/lock/{name}")
 @Produces(value="application/json")
FeatureState lockFeature(@PathParam(value="name")
                                                                                                String name)

Locks feature

Parameters:

name - the feature name (required)

Returns:

FeatureState

refresh

@PUT
 @Path(value="/refresh")
 @Produces(value="application/json")
String refresh()

refresh feature states

Returns:

String

unlockFeature

@PUT
 @Path(value="/unlock/{name}")
 @Produces(value="application/json")
FeatureState unlockFeature(@PathParam(value="name")
                                                                                                    String name)

Unlocks feature

Parameters:

name - the feature name (required)

Returns:

FeatureState