io.federecio.dropwizard.swagger

Class AuthParamFilter

java.lang.Object

io.federecio.dropwizard.swagger.AuthParamFilter

All Implemented Interfaces:

io.swagger.core.filter.SwaggerSpecFilter

public class AuthParamFilter
extends Object
implements io.swagger.core.filter.SwaggerSpecFilter

This SwaggerSpecFilter checks for the presence of an access=internal @ApiParam annotation, and hides the parameter if it is present. This is primarily useful for hiding Dropwizard @Auth parameters. From: https://www.reonomy.com/augmenting-dropwizard-with-swagger/

Constructor Summary

Constructors

Constructor and Description
AuthParamFilter()

Method Summary

Modifier and Type	Method and Description
boolean	isOperationAllowed(io.swagger.models.Operation operation, io.swagger.model.ApiDescription api, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
boolean	isParamAllowed(io.swagger.models.parameters.Parameter parameter, io.swagger.models.Operation operation, io.swagger.model.ApiDescription api, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
boolean	isPropertyAllowed(io.swagger.models.Model model, io.swagger.models.properties.Property property, String propertyName, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthParamFilter

public AuthParamFilter()

Method Detail

isOperationAllowed

public boolean isOperationAllowed(io.swagger.models.Operation operation,
                                  io.swagger.model.ApiDescription api,
                                  Map<String,List<String>> params,
                                  Map<String,String> cookies,
                                  Map<String,List<String>> headers)

Specified by:

isOperationAllowed in interface io.swagger.core.filter.SwaggerSpecFilter

isParamAllowed

public boolean isParamAllowed(io.swagger.models.parameters.Parameter parameter,
                              io.swagger.models.Operation operation,
                              io.swagger.model.ApiDescription api,
                              Map<String,List<String>> params,
                              Map<String,String> cookies,
                              Map<String,List<String>> headers)

Specified by:

isParamAllowed in interface io.swagger.core.filter.SwaggerSpecFilter

isPropertyAllowed

public boolean isPropertyAllowed(io.swagger.models.Model model,
                                 io.swagger.models.properties.Property property,
                                 String propertyName,
                                 Map<String,List<String>> params,
                                 Map<String,String> cookies,
                                 Map<String,List<String>> headers)

Specified by:

isPropertyAllowed in interface io.swagger.core.filter.SwaggerSpecFilter