Package io.swagger.v3.parser.reference

Class ReferenceVisitor

java.lang.Object

io.swagger.v3.parser.reference.AbstractVisitor

io.swagger.v3.parser.reference.ReferenceVisitor

All Implemented Interfaces:

Visitor

public class ReferenceVisitor
extends AbstractVisitor

Field Summary

Fields

Modifier and Type	Field	Description
protected DereferencerContext	context
protected OpenAPI31Traverser	openAPITraverser
protected Reference	reference
protected HashSet<Object>	visited
protected HashMap<Object,Object>	visitedMap

Constructor Summary

Constructors

Constructor	Description
ReferenceVisitor(Reference reference, OpenAPI31Traverser openAPITraverser, HashSet<Object> visited, HashMap<Object,Object> visitedMap)
ReferenceVisitor(Reference reference, OpenAPI31Traverser openAPITraverser, HashSet<Object> visited, HashMap<Object,Object> visitedMap, DereferencerContext context)

Method Summary

Modifier and Type	Method	Description
protected void	checkUrlIsPermitted(String refSet)
com.fasterxml.jackson.databind.JsonNode	deserializeIntoTree(String content)
com.fasterxml.jackson.databind.JsonNode	findAnchor(com.fasterxml.jackson.databind.JsonNode root, String anchor)
com.fasterxml.jackson.databind.JsonNode	parse(String absoluteUri, List<AuthorizationValue> auths)
String	readHttp(String uri, List<AuthorizationValue> auths)
<T> T	resolveRef(T visiting, String ref, Class<T> clazz, BiFunction<T,ReferenceVisitor,T> traverseFunction)
io.swagger.v3.oas.models.media.Schema	resolveSchemaRef(io.swagger.v3.oas.models.media.Schema visiting, String ref, List<String> inheritedIds)
String	toBaseURI(String uri)
Reference	toReference(String uri)
Reference	toSchemaReference(String baseUri, com.fasterxml.jackson.databind.JsonNode node)
io.swagger.v3.oas.models.examples.Example	visitExample(io.swagger.v3.oas.models.examples.Example example)
io.swagger.v3.oas.models.headers.Header	visitHeader(io.swagger.v3.oas.models.headers.Header header)
io.swagger.v3.oas.models.links.Link	visitLink(io.swagger.v3.oas.models.links.Link link)
io.swagger.v3.oas.models.parameters.Parameter	visitParameter(io.swagger.v3.oas.models.parameters.Parameter parameter)
io.swagger.v3.oas.models.PathItem	visitPathItem(io.swagger.v3.oas.models.PathItem pathItem)
io.swagger.v3.oas.models.parameters.RequestBody	visitRequestBody(io.swagger.v3.oas.models.parameters.RequestBody requestBody)
io.swagger.v3.oas.models.responses.ApiResponse	visitResponse(io.swagger.v3.oas.models.responses.ApiResponse response)
io.swagger.v3.oas.models.media.Schema	visitSchema(io.swagger.v3.oas.models.media.Schema schema, List<String> inheritedIds)
io.swagger.v3.oas.models.security.SecurityScheme	visitSecurityScheme(io.swagger.v3.oas.models.security.SecurityScheme securityScheme)

Methods inherited from class io.swagger.v3.parser.reference.AbstractVisitor

visitComponents, visitEncoding, visitMediaType, visitOpenApi, visitOperation, visitPaths, visitResponses

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.swagger.v3.parser.reference.Visitor

readClasspath, readFile, readURI

Field Detail

visited

protected HashSet<Object> visited

visitedMap

protected HashMap<Object,Object> visitedMap

openAPITraverser

protected OpenAPI31Traverser openAPITraverser

reference

protected Reference reference

context

protected DereferencerContext context

Constructor Detail

ReferenceVisitor

public ReferenceVisitor(Reference reference,
                        OpenAPI31Traverser openAPITraverser,
                        HashSet<Object> visited,
                        HashMap<Object,Object> visitedMap)

ReferenceVisitor

public ReferenceVisitor(Reference reference,
                        OpenAPI31Traverser openAPITraverser,
                        HashSet<Object> visited,
                        HashMap<Object,Object> visitedMap,
                        DereferencerContext context)

Method Detail

toBaseURI

public String toBaseURI(String uri)
                 throws Exception

Throws:

Exception

toReference

public Reference toReference(String uri)
                      throws Exception

Throws:

Exception

toSchemaReference

public Reference toSchemaReference(String baseUri,
                                   com.fasterxml.jackson.databind.JsonNode node)
                            throws Exception

Throws:

Exception

visitPathItem

public io.swagger.v3.oas.models.PathItem visitPathItem(io.swagger.v3.oas.models.PathItem pathItem)

Specified by:

visitPathItem in interface Visitor

Overrides:

visitPathItem in class AbstractVisitor

visitParameter

public io.swagger.v3.oas.models.parameters.Parameter visitParameter(io.swagger.v3.oas.models.parameters.Parameter parameter)

Specified by:

visitParameter in interface Visitor

Overrides:

visitParameter in class AbstractVisitor

visitExample

public io.swagger.v3.oas.models.examples.Example visitExample(io.swagger.v3.oas.models.examples.Example example)

Specified by:

visitExample in interface Visitor

Overrides:

visitExample in class AbstractVisitor

visitSchema

public io.swagger.v3.oas.models.media.Schema visitSchema(io.swagger.v3.oas.models.media.Schema schema,
                                                         List<String> inheritedIds)

Specified by:

visitSchema in interface Visitor

Overrides:

visitSchema in class AbstractVisitor

visitResponse

public io.swagger.v3.oas.models.responses.ApiResponse visitResponse(io.swagger.v3.oas.models.responses.ApiResponse response)

Specified by:

visitResponse in interface Visitor

Overrides:

visitResponse in class AbstractVisitor

visitRequestBody

public io.swagger.v3.oas.models.parameters.RequestBody visitRequestBody(io.swagger.v3.oas.models.parameters.RequestBody requestBody)

Specified by:

visitRequestBody in interface Visitor

Overrides:

visitRequestBody in class AbstractVisitor

visitLink

public io.swagger.v3.oas.models.links.Link visitLink(io.swagger.v3.oas.models.links.Link link)

Specified by:

visitLink in interface Visitor

Overrides:

visitLink in class AbstractVisitor

visitSecurityScheme

public io.swagger.v3.oas.models.security.SecurityScheme visitSecurityScheme(io.swagger.v3.oas.models.security.SecurityScheme securityScheme)

Specified by:

visitSecurityScheme in interface Visitor

Overrides:

visitSecurityScheme in class AbstractVisitor

visitHeader

public io.swagger.v3.oas.models.headers.Header visitHeader(io.swagger.v3.oas.models.headers.Header header)

Specified by:

visitHeader in interface Visitor

Overrides:

visitHeader in class AbstractVisitor

readHttp

public String readHttp(String uri,
                       List<AuthorizationValue> auths)
                throws Exception

Throws:

Exception

resolveRef

public <T> T resolveRef(T visiting,
                        String ref,
                        Class<T> clazz,
                        BiFunction<T,ReferenceVisitor,T> traverseFunction)

resolveSchemaRef

public io.swagger.v3.oas.models.media.Schema resolveSchemaRef(io.swagger.v3.oas.models.media.Schema visiting,
                                                              String ref,
                                                              List<String> inheritedIds)

findAnchor

public com.fasterxml.jackson.databind.JsonNode findAnchor(com.fasterxml.jackson.databind.JsonNode root,
                                                          String anchor)

deserializeIntoTree

public com.fasterxml.jackson.databind.JsonNode deserializeIntoTree(String content)
                                                            throws Exception

Throws:

Exception

parse

public com.fasterxml.jackson.databind.JsonNode parse(String absoluteUri,
                                                     List<AuthorizationValue> auths)
                                              throws Exception

Throws:

Exception

checkUrlIsPermitted

protected void checkUrlIsPermitted(String refSet)
                            throws HostDeniedException

Throws:

HostDeniedException