com.yahoo.bard.webservice.web.endpoints

Class FeatureFlagsServlet

java.lang.Object

com.yahoo.bard.webservice.web.endpoints.EndpointServlet

com.yahoo.bard.webservice.web.endpoints.FeatureFlagsServlet

@Path(value="flags")
 @Singleton
public class FeatureFlagsServlet
extends EndpointServlet

Web service endpoint to return the current status of feature flags.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.web.endpoints.EndpointServlet

objectMappers

Constructor Summary

Constructors

Constructor and Description
FeatureFlagsServlet(FeatureFlagRegistry flags, ObjectMappersSuite objectMappers) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getFeatureFlagStatus(String flagName, String format, javax.ws.rs.core.UriInfo uriInfo) Get the status of a specific feature flag.
javax.ws.rs.core.Response	getFeatureFlagStatusAll(String perPage, String page, String format, javax.ws.rs.core.UriInfo uriInfo) Get the status of all feature flags.

Methods inherited from class com.yahoo.bard.webservice.web.endpoints.EndpointServlet

formatResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureFlagsServlet

@Inject
public FeatureFlagsServlet(FeatureFlagRegistry flags,
                                   ObjectMappersSuite objectMappers)

Constructor.

Parameters:

flags - Feature Flags to know about

objectMappers - JSON tools

Method Detail

getFeatureFlagStatusAll

@GET
 @Timed
public javax.ws.rs.core.Response getFeatureFlagStatusAll(@DefaultValue(value="") @NotNull @QueryParam(value="perPage")
                                                                      String perPage,
                                                                      @DefaultValue(value="") @NotNull @QueryParam(value="page")
                                                                      String page,
                                                                      @QueryParam(value="format")
                                                                      String format,
                                                                      @Context
                                                                      javax.ws.rs.core.UriInfo uriInfo)

Get the status of all feature flags.

Parameters:

perPage - the number per page to return

page - the page to start from

format - the format to use

uriInfo - the injected UriInfo

Returns:

Response Format:

 {
      "feature flags": [
         {
              "name": "feature flag name",
              "value":  <true | false>
         },
         ...
     ]
 }
 

getFeatureFlagStatus

@GET
 @Timed
 @Produces(value="application/json")
 @Path(value="/{flagName}")
public javax.ws.rs.core.Response getFeatureFlagStatus(@PathParam(value="flagName")
                                                                                                                                    String flagName,
                                                                                                                                    @QueryParam(value="format")
                                                                                                                                    String format,
                                                                                                                                    @Context
                                                                                                                                    javax.ws.rs.core.UriInfo uriInfo)

Get the status of a specific feature flag.

Parameters:

flagName - The feature flag

format - The format to return results in

uriInfo - The injected UriInfo

Returns:

Response Format:

 {
     "feature flags": [
          "name": "feature flag name",
          "value":  <true | false>
     ]
 }