springfox.documentation.spi.service.contexts

Class SecurityContext

java.lang.Object

springfox.documentation.spi.service.contexts.SecurityContext

public class SecurityContext
extends java.lang.Object

A class to represent a default set of authorizations to apply to each api operation To customize which request mappings the list of authorizations are applied to Specify the custom includePatterns or requestMethods

Constructor Summary

Constructors

Constructor and Description
SecurityContext(java.util.List<springfox.documentation.service.SecurityReference> securityReferences, com.google.common.base.Predicate<java.lang.String> selector)
SecurityContext(java.util.List<springfox.documentation.service.SecurityReference> securityReferences, com.google.common.base.Predicate<java.lang.String> selector, com.google.common.base.Predicate<org.springframework.http.HttpMethod> methodSelector)

Method Summary

Modifier and Type	Method and Description
static SecurityContextBuilder	builder()
com.google.common.base.Predicate<org.springframework.http.HttpMethod>	getMethodSelector()
java.util.List<springfox.documentation.service.SecurityReference>	getSecurityReferences()
java.util.List<springfox.documentation.service.SecurityReference>	securityForOperation(OperationContext operationContext)
java.util.List<springfox.documentation.service.SecurityReference>	securityForPath(java.lang.String path) Deprecated. securityForOperation(springfox.documentation.spi.service.contexts.OperationContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityContext

public SecurityContext(java.util.List<springfox.documentation.service.SecurityReference> securityReferences,
                       com.google.common.base.Predicate<java.lang.String> selector)

SecurityContext

public SecurityContext(java.util.List<springfox.documentation.service.SecurityReference> securityReferences,
                       com.google.common.base.Predicate<java.lang.String> selector,
                       com.google.common.base.Predicate<org.springframework.http.HttpMethod> methodSelector)

Method Detail

securityForPath

@Deprecated
public java.util.List<springfox.documentation.service.SecurityReference> securityForPath(java.lang.String path)

Deprecated. securityForOperation(springfox.documentation.spi.service.contexts.OperationContext)

Use securityForOperation instead

Parameters:

path - path to secure

Returns:

list of applicable security references

Since:

2.8.1

securityForOperation

public java.util.List<springfox.documentation.service.SecurityReference> securityForOperation(OperationContext operationContext)

getSecurityReferences

public java.util.List<springfox.documentation.service.SecurityReference> getSecurityReferences()

getMethodSelector

public com.google.common.base.Predicate<org.springframework.http.HttpMethod> getMethodSelector()

builder

public static SecurityContextBuilder builder()