Package org.brapi.schematools.analyse

Class BrAPISpecificationAnalyserFactory

java.lang.Object

org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory

public class BrAPISpecificationAnalyserFactory
extends Object

Analyses BrAPI endpoints against an OpenAPI Specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BrAPISpecificationAnalyserFactory.Analyser	Analyser provides direct access to the analysis functions.

Constructor Summary

Constructors

Constructor	Description
BrAPISpecificationAnalyserFactory(String baseURL, HttpClient client, org.brapi.schematools.core.authorization.AuthorizationProvider authorizationProvider)	Create an Analyser Factory
BrAPISpecificationAnalyserFactory(String baseURL, HttpClient client, org.brapi.schematools.core.authorization.AuthorizationProvider authorizationProvider, AnalysisOptions options)	Create an Analyser

Method Summary

Modifier and Type	Method	Description
org.brapi.schematools.core.response.Response<List<AnalysisReport>>	analyse(String specification, Path schema)	Creates a new analyser and analyses all the endpoints in the specification.
org.brapi.schematools.core.response.Response<List<AnalysisReport>>	analyse(String specification, List<String> entityNames)	Creates a new analyser and analyses the endpoints for specific entities in the specification.
BrAPISpecificationAnalyserFactory.Analyser	analyser(String specification)	Creates a new analyser for a specification.
org.brapi.schematools.core.response.Response<org.brapi.schematools.core.validiation.Validation>	validate(String specification)	Creates a new analyser and validates the options against the specification.

Methods inherited from class java.lang.Object

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

Constructor Details

BrAPISpecificationAnalyserFactory

public BrAPISpecificationAnalyserFactory(String baseURL,
 HttpClient client,
 org.brapi.schematools.core.authorization.AuthorizationProvider authorizationProvider)

Create an Analyser Factory

Parameters:

baseURL - the base URl for the BrAPI server

client - the HTTP client to use for the execution of requests

authorizationProvider - the authorization provider need for authorization

BrAPISpecificationAnalyserFactory

public BrAPISpecificationAnalyserFactory(String baseURL,
 HttpClient client,
 org.brapi.schematools.core.authorization.AuthorizationProvider authorizationProvider,
 AnalysisOptions options)

Create an Analyser

Parameters:

baseURL - the base URl for the BrAPI server

client - the HTTP client to use for the execution of requests

authorizationProvider - the authorization provider need for authorization

options - analysis options ;

Method Details

analyse

public org.brapi.schematools.core.response.Response<List<AnalysisReport>> analyse(String specification,
 Path schema)

Creates a new analyser and analyses all the endpoints in the specification. Shortcut for AnalysisOptions.validate(), BrAPISpecificationAnalyserFactory.Analyser.analyseSpecial() and BrAPISpecificationAnalyserFactory.Analyser.analyseAll().

Parameters:

specification - the OpenAPI specification to br analysed.

Returns:

A response containing a list of AnalysisReports or failure explaining why it failed.

analyse

public org.brapi.schematools.core.response.Response<List<AnalysisReport>> analyse(String specification,
 List<String> entityNames)

Creates a new analyser and analyses the endpoints for specific entities in the specification. Shortcut for AnalysisOptions.validate(), BrAPISpecificationAnalyserFactory.Analyser.analyseSpecial() and BrAPISpecificationAnalyserFactory.Analyser.analyseEntities(List).

Parameters:

specification - the OpenAPI specification to br analysed.

entityNames - a list of entities to be analysed

Returns:

A response containing a list of AnalysisReports or failure explaining why it failed.

validate

public org.brapi.schematools.core.response.Response<org.brapi.schematools.core.validiation.Validation> validate(String specification)

Creates a new analyser and validates the options against the specification. Shortcut for AnalysisOptions.validate()

Parameters:

specification - the OpenAPI specification to br analysed.

Returns:

A response containing a list of AnalysisReports or failure explaining why it failed.

analyser

public BrAPISpecificationAnalyserFactory.Analyser analyser(String specification)

Creates a new analyser for a specification. Used for fine control over the analysis. It is recommended to use the factory directly analyse(String, List) (String)} or analyse(String, List) which handles option validation and the pre-processing steps, like calling BrAPISpecificationAnalyserFactory.Analyser.analyseSpecial()

Parameters:

specification - the OpenAPI specification to br analysed.

Returns:

A response containing a list of AnalysisReports or failure explaining why it failed.