Index (analyse 0.34.0 API)

A B C E F G I L N O P R S T V W
All Classes and Interfaces|All Packages

A

analyse(String, Path) - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory: Creates a new analyser and analyses all the endpoints in the specification.
analyse(String, List<String>) - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory: Creates a new analyser and analyses the endpoints for specific entities in the specification.
analyseAll() - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Analyse all the endpoints in the specification.
analyseEntities(List<String>) - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Analyse the endpoints for specific entities in the specification.
analyseEntity(String) - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Analyse the endpoints for specific entity in the specification.
analyser(String) - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory: Creates a new analyser for a specification.
analyseSpecial() - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Analyse the special endpoints that do not fit the regular entity endpoints.
AnalysisOptions - Class in org.brapi.schematools.analyse: Options for the BrAPISpecificationAnalyserFactory.
AnalysisOptions() - Constructor for class org.brapi.schematools.analyse.AnalysisOptions
AnalysisReport - Class in org.brapi.schematools.analyse: Holds all the information from an Endpoint analysis.
AnalysisReport() - Constructor for class org.brapi.schematools.analyse.AnalysisReport
APIRequest - Class in org.brapi.schematools.analyse: Holds all the information required for an HTTP API request
APIRequest() - Constructor for class org.brapi.schematools.analyse.APIRequest
APIRequest.APIRequestBuilder - Class in org.brapi.schematools.analyse: Builder class for APIRequest
APIRequestBuilder() - Constructor for class org.brapi.schematools.analyse.APIRequest.APIRequestBuilder
APIRequestOptions - Class in org.brapi.schematools.analyse: Provides API Request options for the analysis of endpoints
APIRequestOptions() - Constructor for class org.brapi.schematools.analyse.APIRequestOptions
AuthorizationProvider - Interface in org.brapi.schematools.analyse.authorization: Interface for authorisation
autoFilterColumns() - Method in class org.brapi.schematools.analyse.TabularReportWriter: Auto-filter all columns
autoSizeColumns() - Method in class org.brapi.schematools.analyse.TabularReportWriter: Auto-sizes all columns

B

BasicAuthorizationProvider - Class in org.brapi.schematools.analyse.authorization: The Basic Authorisation
BasicAuthorizationProvider() - Constructor for class org.brapi.schematools.analyse.authorization.BasicAuthorizationProvider
BrAPISpecificationAnalyserFactory - Class in org.brapi.schematools.analyse: Analyses BrAPI endpoints against an OpenAPI Specification
BrAPISpecificationAnalyserFactory(String, HttpClient, AuthorizationProvider) - Constructor for class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory: Create an Analyser Factory
BrAPISpecificationAnalyserFactory(String, HttpClient, AuthorizationProvider, AnalysisOptions) - Constructor for class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory: Create an Analyser
BrAPISpecificationAnalyserFactory.Analyser - Class in org.brapi.schematools.analyse: Analyser provides direct access to the analysis functions.

C

clearSummary() - Method in class org.brapi.schematools.analyse.TabularReportGenerator: Clears the summary for generator reuse

E

Endpoint - Class in org.brapi.schematools.analyse: Defines an Endpoint
Endpoint() - Constructor for class org.brapi.schematools.analyse.Endpoint

F

freezePane() - Method in class org.brapi.schematools.analyse.TabularReportWriter: Freeze pane all columns

G

generateReport(List<AnalysisReport>) - Method in class org.brapi.schematools.analyse.TabularReportGenerator: Generates a DataFrame from a list of AnalysisReport
generateReportByEntity(List<AnalysisReport>) - Method in class org.brapi.schematools.analyse.TabularReportGenerator: Generates DataFrames from a list of AnalysisReports with a separate Data Frame per entity.
generateReportTable(List<AnalysisReport>) - Method in class org.brapi.schematools.analyse.TabularReportGenerator: Generates a table from a list of AnalysisReport
generator() - Static method in class org.brapi.schematools.analyse.TabularReportGenerator: Creates the default Generator
getAuthorization() - Method in interface org.brapi.schematools.analyse.authorization.AuthorizationProvider: Gets a response containing the Authorisation Header is AuthorizationProvider.required() is true, otherwise an empty response
getAuthorization() - Method in class org.brapi.schematools.analyse.authorization.BasicAuthorizationProvider
getAuthorization() - Method in class org.brapi.schematools.analyse.authorization.oauth.SingleSignOn
getColumnNames() - Method in class org.brapi.schematools.analyse.TabularReportGenerator: Get the column names in the report
getDeprecatedEndpoints() - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Gets a list of deprecated endpoints that will be skipped.
getEndpoints() - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Gets a list of endpoints that are to be tested.
getEntityName() - Method in class org.brapi.schematools.analyse.AnalysisReport: Gets the entity name of the report
getEntityNames() - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Get the list of entities available on the server
getErrors() - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Get any errors found in the specification
getName() - Method in class org.brapi.schematools.analyse.AnalysisReport: Gets the name of the report
getParameterName() - Method in class org.brapi.schematools.analyse.ParameterLink: The name of the parameter
getPrerequisitesFor(String) - Method in class org.brapi.schematools.analyse.APIRequestOptions: Gets the prerequisites for a specific primary model.
getRequiredParametersFor(String) - Method in class org.brapi.schematools.analyse.APIRequestOptions: Gets the required parameters for a specific primary model.
getSkippedEndpoints() - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Gets a list of endpoints that will not be tested under due to the current option settings.
getSummary() - Method in class org.brapi.schematools.analyse.TabularReportGenerator: Clear the summary for generator reuse
getSummaryColumnNames() - Method in class org.brapi.schematools.analyse.TabularReportGenerator: Get the summary column names in the report
getTimeElapsed() - Method in class org.brapi.schematools.analyse.AnalysisReport: Get the time elapsed from the start of the analysis to it completion in milliseconds
getToken() - Method in class org.brapi.schematools.analyse.authorization.oauth.SingleSignOn: Gets the current token if not expired or fetches a new one, or fails with a message explaining the reason why a valid token can not be obtained.
getUnmatchedEndpoints() - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Gets a list of endpoints that are not tested under any situation.

I

isAnalysingCreateForEntity(String) - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the Analyser should analyse the get API for an Entity.
isAnalysingDeleteForEntity(String) - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the Analyser should analyse the Delete API for an Entity.
isAnalysingDepreciated() - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the Analyser should analyse depreciated endpoints
isAnalysingEntity(String) - Method in class org.brapi.schematools.analyse.APIRequestOptions: Gets if to analysis for a specific primary mode.
isAnalysingGetForEntity(String) - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the Analyser should analyse the get API for an Entity.
isAnalysingListForEntity(String) - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the Analyser should analyse the list API for an Entity.
isAnalysingSearchForEntity(String) - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the Analyser should analyse the Search API for an Entity.
isAnalysingSearchResultForEntity(String) - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the Analyser should analyse the result from Search API for an Entity.
isAnalysingTableForEntity(String) - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the Analyser should analyse the get or post table API for an Entity.
isAnalysingUpdateForEntity(String) - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the Analyser should analyse the Update API for an Entity.
isPartitionedByCrop() - Method in class org.brapi.schematools.analyse.AnalysisOptions: Determines if the request is partition by crop, so that queries are not across crops

L

load() - Static method in class org.brapi.schematools.analyse.AnalysisOptions: Load the default options
load(InputStream) - Static method in class org.brapi.schematools.analyse.AnalysisOptions: Load the options from an options input stream in YAML or Json.
load(Path) - Static method in class org.brapi.schematools.analyse.AnalysisOptions: Load the options from an options file in YAML or Json.
loginWithClientId(String) - Method in class org.brapi.schematools.analyse.authorization.oauth.SingleSignOn: Login with clientId
loginWithPassword(String) - Method in class org.brapi.schematools.analyse.authorization.oauth.SingleSignOn: Login the current user and password
logout() - Method in class org.brapi.schematools.analyse.authorization.oauth.SingleSignOn: Logout the current user

N

NoAuthorizationProvider - Class in org.brapi.schematools.analyse.authorization: The case when no Authorisation is required
NoAuthorizationProvider() - Constructor for class org.brapi.schematools.analyse.authorization.NoAuthorizationProvider

O

OpenIDToken - Class in org.brapi.schematools.analyse.authorization.oauth: Encapsulates all the information returned by the OAuth server
OpenIDToken() - Constructor for class org.brapi.schematools.analyse.authorization.oauth.OpenIDToken
org.brapi.schematools.analyse - package org.brapi.schematools.analyse
org.brapi.schematools.analyse.authorization - package org.brapi.schematools.analyse.authorization
org.brapi.schematools.analyse.authorization.oauth - package org.brapi.schematools.analyse.authorization.oauth
override(AnalysisOptions) - Method in class org.brapi.schematools.analyse.AnalysisOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null
override(APIRequestOptions) - Method in class org.brapi.schematools.analyse.APIRequestOptions: Overrides the values in this Options Object from the provided Options Object if they are non-null

P

Parameter - Class in org.brapi.schematools.analyse: Defines defines a parameter
Parameter() - Constructor for class org.brapi.schematools.analyse.Parameter
ParameterLink - Class in org.brapi.schematools.analyse: Defines the link between an OpenAPI Parameter in a query or path or body to a variable
ParameterLink() - Constructor for class org.brapi.schematools.analyse.ParameterLink
params() - Method in class org.brapi.schematools.analyse.authorization.oauth.TokenRequest: Get the parameters for the request
PropertyLink - Class in org.brapi.schematools.analyse: Defines the link between an OpenAPI Property in a request body to a variable.
PropertyLink() - Constructor for class org.brapi.schematools.analyse.PropertyLink

R

required() - Method in interface org.brapi.schematools.analyse.authorization.AuthorizationProvider: Determines if authorisation is required no not
required() - Method in class org.brapi.schematools.analyse.authorization.oauth.SingleSignOn

S

setAnalysingEntityFor(String, Boolean) - Method in class org.brapi.schematools.analyse.APIRequestOptions: Sets if to do analysis for a specific primary model.
setPrerequisitesFor(String, List<String>) - Method in class org.brapi.schematools.analyse.APIRequestOptions: Sets the prerequisites for a specific primary model.
setRequiredParametersFor(String, List<Parameter>) - Method in class org.brapi.schematools.analyse.APIRequestOptions: Sets the required parameters for a specific primary model.
SingleSignOn - Class in org.brapi.schematools.analyse.authorization.oauth: Handles OAuth login and logout.
summariseAcrossReports() - Method in class org.brapi.schematools.analyse.TabularReportGenerator: Summarise across multiple reports

T

TabularReportGenerator - Class in org.brapi.schematools.analyse: Generates a tabular report from a list of AnalysisReports
TabularReportWriter - Class in org.brapi.schematools.analyse: Writes a tabular report to file.
TokenRequest - Class in org.brapi.schematools.analyse.authorization.oauth: The request object used for OAuth
TokenRequest() - Constructor for class org.brapi.schematools.analyse.authorization.oauth.TokenRequest
toString() - Method in class org.brapi.schematools.analyse.Endpoint

V

validate() - Method in class org.brapi.schematools.analyse.AnalysisOptions
validate() - Method in class org.brapi.schematools.analyse.APIRequestOptions
validate() - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory.Analyser: Validates the options against the specification.
validate(String) - Method in class org.brapi.schematools.analyse.BrAPISpecificationAnalyserFactory: Creates a new analyser and validates the options against the specification.
Variable - Class in org.brapi.schematools.analyse: Defines a Variable and a json path to get the value of the variable from a response body, and the parameter name for which this variable will be used, if different from the variable name.
Variable() - Constructor for class org.brapi.schematools.analyse.Variable
VariableValue - Class in org.brapi.schematools.analyse: Defines a Value for a Variable, and the parameter name for which this variable value will be used, if different from the variable name.
VariableValue() - Constructor for class org.brapi.schematools.analyse.VariableValue

W

writer() - Static method in class org.brapi.schematools.analyse.TabularReportWriter: Creates the default Writer
writeToExcel(List<DataFrame>, Path) - Method in class org.brapi.schematools.analyse.TabularReportWriter: Write the tabular reports to an Excel file
writeToExcel(DataFrame, Path) - Method in class org.brapi.schematools.analyse.TabularReportWriter: Write the tabular reports to an Excel file

A B C E F G I L N O P R S T V W
All Classes and Interfaces|All Packages