org.openapitools.codegen.utils.ProcessUtils Maven / Gradle / Ivy
package org.openapitools.codegen.utils;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.openapitools.codegen.CodegenModel;
import org.openapitools.codegen.CodegenProperty;
import org.openapitools.codegen.CodegenSecurity;
import org.openapitools.codegen.model.ModelMap;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
public class ProcessUtils {
/**
* Add x-index extension to the model's properties
*
* @param models List of models
* @param initialIndex starting index to use
*/
public static void addIndexToProperties(List models, int initialIndex) {
for (ModelMap mo : models) {
CodegenModel cm = mo.getModel();
int i = initialIndex;
for (CodegenProperty var : cm.vars) {
var.vendorExtensions.put("x-index", i);
i++;
}
int j = initialIndex;
for (CodegenProperty var : cm.allVars) {
var.vendorExtensions.put("x-index", j);
j++;
}
}
}
/**
* Add x-index extension to the model's properties
*
* @param models List of models
*/
public static void addIndexToProperties(List models) {
addIndexToProperties(models, 0);
}
/**
* Returns true if the specified OAS model has at least one operation with the HTTP basic
* security scheme.
*
* @param authMethods List of auth methods.
* @return True if at least one operation has HTTP basic security scheme defined
*/
public static boolean hasHttpBasicMethods(List authMethods) {
if (authMethods != null && !authMethods.isEmpty()) {
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isBasicBasic)) {
return true;
}
}
}
return false;
}
/**
* Returns a list of OAS Codegen security objects
*
* @param authMethods List of auth methods.
* @return A list of OAS Codegen security objects
*/
public static List getHttpBasicMethods(List authMethods) {
List httpBasicMethods = new ArrayList<>();
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isBasicBasic)) {
httpBasicMethods.add(cs);
}
}
return httpBasicMethods;
}
/**
* Returns true if the specified OAS model has at least one operation with API keys.
*
* @param authMethods List of auth methods.
* @return True if at least one operation has API key security scheme defined
*/
public static boolean hasApiKeyMethods(List authMethods) {
if (authMethods != null && !authMethods.isEmpty()) {
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isApiKey)) {
return true;
}
}
}
return false;
}
/**
* Returns a list of OAS Codegen security objects
*
* @param authMethods List of auth methods.
* @return A list of OAS Codegen security objects
*/
public static List getApiKeyMethods(List authMethods) {
List apiKeyMethods = new ArrayList<>();
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isApiKey)) {
apiKeyMethods.add(cs);
}
}
return apiKeyMethods;
}
/**
* Returns true if the specified OAS model has at least one operation with the HTTP basic
* security scheme.
* The HTTP signature scheme is defined in https://datatracker.ietf.org/doc/draft-cavage-http-signatures/
*
* @param authMethods List of auth methods.
* @return True if at least one operation has HTTP signature security scheme defined
*/
public static boolean hasHttpSignatureMethods(List authMethods) {
if (authMethods != null && !authMethods.isEmpty()) {
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isHttpSignature)) {
return true;
}
}
}
return false;
}
/**
* Returns a list of OAS Codegen security objects
*
* @param authMethods List of auth methods.
* @return A list of OAS Codegen security objects
*/
public static List getHttpSignatureMethods(List authMethods) {
List httpSignatureMethods = new ArrayList<>();
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isHttpSignature)) {
httpSignatureMethods.add(cs);
}
}
return httpSignatureMethods;
}
/**
* Returns true if the specified OAS model has at least one operation with HTTP bearer.
*
* @param authMethods List of auth methods.
* @return True if at least one operation has HTTP bearer security scheme defined
*/
public static boolean hasHttpBearerMethods(List authMethods) {
if (authMethods != null && !authMethods.isEmpty()) {
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isBasicBearer)) {
return true;
}
}
}
return false;
}
/**
* Returns a list of Bearer Codegen security objects
*
* @param authMethods List of auth methods.
* @return A list of Bearer Codegen security objects
*/
public static List getHttpBearerMethods(List authMethods) {
List httpBearerMethods = new ArrayList<>();
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isBasicBearer)) {
httpBearerMethods.add(cs);
}
}
return httpBearerMethods;
}
/**
* Returns true if the specified OAS model has at least one operation with OAuth.
*
* @param authMethods List of auth methods.
* @return True if at least one operation has OAuth security scheme defined
*/
public static boolean hasOAuthMethods(List authMethods) {
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isOAuth)) {
return true;
}
}
return false;
}
/**
* Returns a list of OAuth Codegen security objects
*
* @param authMethods List of auth methods.
* @return A list of OAuth Codegen security objects
*/
public static List getOAuthMethods(List authMethods) {
List oauthMethods = new ArrayList<>();
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isOAuth)) {
oauthMethods.add(cs);
}
}
return oauthMethods;
}
/**
* Returns true if the specified OAS model has at least one operation with OAuth authentication.
*
* @param openAPI An instance of OpenAPI
* @return True if at least one operation has OAuth security scheme defined
*/
public static boolean hasOAuthMethods(OpenAPI openAPI) {
final Map securitySchemes = getSecuritySchemes(openAPI);
if (securitySchemes != null) {
for (Map.Entry scheme : securitySchemes.entrySet()) {
if (SecurityScheme.Type.OAUTH2.equals(scheme.getValue().getType())) {
return true;
}
}
}
return false;
}
/**
* Returns true if the specified OAS model has at least one operation with OpenIdConnect authentication.
*
* @param openAPI An instance of OpenAPI
* @return True if at least one operation has OpenIdConnect security scheme defined
*/
public static boolean hasOpenIdConnectMethods(OpenAPI openAPI) {
final Map securitySchemes = getSecuritySchemes(openAPI);
if (securitySchemes != null) {
for (Map.Entry scheme : securitySchemes.entrySet()) {
if (SecurityScheme.Type.OPENIDCONNECT.equals(scheme.getValue().getType())) {
return true;
}
}
}
return false;
}
/**
* Returns a list of OpenIdConnect Codegen security objects
*
* @param authMethods List of auth methods.
* @return A list of OpenIdConnect Codegen security objects
*/
public static List getOpenIdConnectMethods(List authMethods) {
List oauthMethods = new ArrayList<>();
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isOpenId)) {
oauthMethods.add(cs);
}
}
return oauthMethods;
}
/**
* Returns a list of OpenIdConnect Codegen security objects
*
* @param authMethods List of auth methods.
* @return A list of OpenIdConnect Codegen security objects
*/
public static boolean hasOpenIdConnectMethods(List authMethods) {
for (CodegenSecurity cs : authMethods) {
if (Boolean.TRUE.equals(cs.isOpenId)) {
return true;
}
}
return false;
}
/**
* Returns true if the specified OAS model has at least one operation with HTTP bearer authentication.
*
* @param openAPI An instance of OpenAPI
* @return True if at least one operation has HTTP bearer security scheme defined
*/
public static boolean hasHttpBearerMethods(OpenAPI openAPI) {
final Map securitySchemes = getSecuritySchemes(openAPI);
if (securitySchemes != null) {
for (Map.Entry scheme : securitySchemes.entrySet()) {
if (SecurityScheme.Type.HTTP.equals(scheme.getValue().getType()) && "bearer".equals(scheme.getValue().getScheme().strip().toLowerCase(Locale.ROOT))) {
return true;
}
}
}
return false;
}
/**
* Returns true if the specified OAS model has at least one operation with HTTP basic authentication.
*
* @param openAPI An instance of OpenAPI
* @return True if at least one operation has HTTP basic security scheme defined
*/
public static boolean hasHttpBasicMethods(OpenAPI openAPI) {
final Map securitySchemes = getSecuritySchemes(openAPI);
if (securitySchemes != null) {
for (Map.Entry scheme : securitySchemes.entrySet()) {
if (SecurityScheme.Type.HTTP.equals(scheme.getValue().getType()) && "basic".equals(scheme.getValue().getScheme().strip().toLowerCase(Locale.ROOT))) {
return true;
}
}
}
return false;
}
/**
* Returns true if the specified OAS model has at least one operation with HTTP signature authentication.
*
* @param openAPI An instance of OpenAPI
* @return True if at least one operation has HTTP signature security scheme defined
*/
public static boolean hasHttpSignatureMethods(OpenAPI openAPI) {
final Map securitySchemes = getSecuritySchemes(openAPI);
if (securitySchemes != null) {
for (Map.Entry scheme : securitySchemes.entrySet()) {
if (SecurityScheme.Type.HTTP.equals(scheme.getValue().getType()) && "signature".equals(scheme.getValue().getScheme().strip().toLowerCase(Locale.ROOT))) {
return true;
}
}
}
return false;
}
/**
* Returns true if the specified OAS model has at least one operation with API key authentication.
*
* @param openAPI An instance of OpenAPI
* @return True if at least one operation has API key security scheme defined
*/
public static boolean hasApiKeyMethods(OpenAPI openAPI) {
final Map securitySchemes = getSecuritySchemes(openAPI);
if (securitySchemes != null) {
for (Map.Entry scheme : securitySchemes.entrySet()) {
if (SecurityScheme.Type.APIKEY.equals(scheme.getValue().getType())) {
return true;
}
}
}
return false;
}
public static Map getSecuritySchemes(OpenAPI openAPI) {
if (openAPI == null) {
return null;
} else {
return openAPI.getComponents() != null ? openAPI.getComponents().getSecuritySchemes() : null;
}
}
}