@ahmttyydn/java-integration 1.0.1

package/scalar-core/src/main/java/com/scalar/maven/core/authentication/flows/OAuthFlow.java

@@ -0,0 +1,185 @@
+package com.scalar.maven.core.authentication.flows;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Base class containing common properties for all OAuth2 flows.
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public abstract class OAuthFlow {
+
+    /**
+     * Gets or sets the URL to be used for obtaining refresh tokens.
+     */
+    private String refreshUrl;
+
+    /**
+     * Gets or sets the preselected scopes for the request.
+     */
+    private List<String> selectedScopes;
+
+    /**
+     * Gets or sets the client ID associated with the OAuth flow.
+     */
+    @JsonProperty("x-scalar-client-id")
+    private String clientId;
+
+    /**
+     * Gets or sets the authentication token.
+     */
+    private String token;
+
+    /**
+     * Gets or sets additional query parameters that should be included in the auth request.
+     */
+    @JsonProperty("x-scalar-security-query")
+    private Map<String, String> additionalQueryParameters;
+
+    /**
+     * Gets or sets additional body parameters that should be included in the token request.
+     */
+    @JsonProperty("x-scalar-security-body")
+    private Map<String, String> additionalBodyParameters;
+
+    /**
+     * Gets or sets the name of the token used in the OAuth flow.
+     */
+    @JsonProperty("x-tokenName")
+    private String tokenName;
+
+    /**
+     * Creates a new OAuthFlow.
+     */
+    protected OAuthFlow() {
+    }
+
+    /**
+     * Gets the refresh URL.
+     *
+     * @return the refresh URL
+     */
+    public String getRefreshUrl() {
+        return refreshUrl;
+    }
+
+    /**
+     * Sets the refresh URL.
+     *
+     * @param refreshUrl the refresh URL
+     */
+    public void setRefreshUrl(String refreshUrl) {
+        this.refreshUrl = refreshUrl;
+    }
+
+    /**
+     * Gets the selected scopes.
+     *
+     * @return the selected scopes
+     */
+    public List<String> getSelectedScopes() {
+        return selectedScopes;
+    }
+
+    /**
+     * Sets the selected scopes.
+     *
+     * @param selectedScopes the selected scopes
+     */
+    public void setSelectedScopes(List<String> selectedScopes) {
+        this.selectedScopes = selectedScopes;
+    }
+
+    /**
+     * Gets the client ID.
+     *
+     * @return the client ID
+     */
+    public String getClientId() {
+        return clientId;
+    }
+
+    /**
+     * Sets the client ID.
+     *
+     * @param clientId the client ID
+     */
+    public void setClientId(String clientId) {
+        this.clientId = clientId;
+    }
+
+    /**
+     * Gets the token.
+     *
+     * @return the token
+     */
+    public String getToken() {
+        return token;
+    }
+
+    /**
+     * Sets the token.
+     *
+     * @param token the token
+     */
+    public void setToken(String token) {
+        this.token = token;
+    }
+
+    /**
+     * Gets the additional query parameters.
+     *
+     * @return the additional query parameters
+     */
+    public Map<String, String> getAdditionalQueryParameters() {
+        return additionalQueryParameters;
+    }
+
+    /**
+     * Sets the additional query parameters.
+     *
+     * @param additionalQueryParameters the additional query parameters
+     */
+    public void setAdditionalQueryParameters(Map<String, String> additionalQueryParameters) {
+        this.additionalQueryParameters = additionalQueryParameters;
+    }
+
+    /**
+     * Gets the additional body parameters.
+     *
+     * @return the additional body parameters
+     */
+    public Map<String, String> getAdditionalBodyParameters() {
+        return additionalBodyParameters;
+    }
+
+    /**
+     * Sets the additional body parameters.
+     *
+     * @param additionalBodyParameters the additional body parameters
+     */
+    public void setAdditionalBodyParameters(Map<String, String> additionalBodyParameters) {
+        this.additionalBodyParameters = additionalBodyParameters;
+    }
+
+    /**
+     * Gets the token name.
+     *
+     * @return the token name
+     */
+    public String getTokenName() {
+        return tokenName;
+    }
+
+    /**
+     * Sets the token name.
+     *
+     * @param tokenName the token name
+     */
+    public void setTokenName(String tokenName) {
+        this.tokenName = tokenName;
+    }
+}

package/scalar-core/src/main/java/com/scalar/maven/core/authentication/flows/PasswordFlow.java

@@ -0,0 +1,134 @@
+package com.scalar.maven.core.authentication.flows;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.scalar.maven.core.enums.CredentialsLocation;
+
+/**
+ * Represents the OAuth2 Password flow configuration.
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class PasswordFlow extends OAuthFlow {
+
+    /**
+     * Gets or sets the client secret used for authentication.
+     */
+    private String clientSecret;
+
+    /**
+     * Gets or sets the token URL to be used for this flow.
+     */
+    private String tokenUrl;
+
+    /**
+     * Gets or sets the default username for the password flow.
+     */
+    private String username;
+
+    /**
+     * Gets or sets the default password for the password flow.
+     */
+    private String password;
+
+    /**
+     * Gets or sets the location where authentication credentials should be placed in HTTP requests.
+     */
+    @JsonProperty("x-scalar-credentials-location")
+    private CredentialsLocation credentialsLocation;
+
+    /**
+     * Creates a new PasswordFlow.
+     */
+    public PasswordFlow() {
+    }
+
+    /**
+     * Gets the client secret.
+     *
+     * @return the client secret
+     */
+    public String getClientSecret() {
+        return clientSecret;
+    }
+
+    /**
+     * Sets the client secret.
+     *
+     * @param clientSecret the client secret
+     */
+    public void setClientSecret(String clientSecret) {
+        this.clientSecret = clientSecret;
+    }
+
+    /**
+     * Gets the token URL.
+     *
+     * @return the token URL
+     */
+    public String getTokenUrl() {
+        return tokenUrl;
+    }
+
+    /**
+     * Sets the token URL.
+     *
+     * @param tokenUrl the token URL
+     */
+    public void setTokenUrl(String tokenUrl) {
+        this.tokenUrl = tokenUrl;
+    }
+
+    /**
+     * Gets the username.
+     *
+     * @return the username
+     */
+    public String getUsername() {
+        return username;
+    }
+
+    /**
+     * Sets the username.
+     *
+     * @param username the username
+     */
+    public void setUsername(String username) {
+        this.username = username;
+    }
+
+    /**
+     * Gets the password.
+     *
+     * @return the password
+     */
+    public String getPassword() {
+        return password;
+    }
+
+    /**
+     * Sets the password.
+     *
+     * @param password the password
+     */
+    public void setPassword(String password) {
+        this.password = password;
+    }
+
+    /**
+     * Gets the credentials location.
+     *
+     * @return the credentials location
+     */
+    public CredentialsLocation getCredentialsLocation() {
+        return credentialsLocation;
+    }
+
+    /**
+     * Sets the credentials location.
+     *
+     * @param credentialsLocation the credentials location
+     */
+    public void setCredentialsLocation(CredentialsLocation credentialsLocation) {
+        this.credentialsLocation = credentialsLocation;
+    }
+}

package/scalar-core/src/main/java/com/scalar/maven/core/authentication/flows/ScalarFlows.java

@@ -0,0 +1,113 @@
+package com.scalar.maven.core.authentication.flows;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+/**
+ * Represents the available OAuth 2.0 flows for authentication.
+ * This class defines the different OAuth 2.0 flow types that can be used for
+ * authentication.
+ * Each flow type has its own configuration properties that are used to prefill
+ * or overwrite
+ * values during the authentication process.
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class ScalarFlows {
+
+    /**
+     * Gets or sets the implicit flow configuration.
+     */
+    private ImplicitFlow implicit;
+
+    /**
+     * Gets or sets the password flow configuration.
+     */
+    private PasswordFlow password;
+
+    /**
+     * Gets or sets the client credentials flow configuration.
+     */
+    private ClientCredentialsFlow clientCredentials;
+
+    /**
+     * Gets or sets the authorization code flow configuration.
+     */
+    private AuthorizationCodeFlow authorizationCode;
+
+    /**
+     * Creates a new ScalarFlows.
+     */
+    public ScalarFlows() {
+    }
+
+    /**
+     * Gets the implicit flow configuration.
+     *
+     * @return the implicit flow configuration
+     */
+    public ImplicitFlow getImplicit() {
+        return implicit;
+    }
+
+    /**
+     * Sets the implicit flow configuration.
+     *
+     * @param implicit the implicit flow configuration
+     */
+    public void setImplicit(ImplicitFlow implicit) {
+        this.implicit = implicit;
+    }
+
+    /**
+     * Gets the password flow configuration.
+     *
+     * @return the password flow configuration
+     */
+    public PasswordFlow getPassword() {
+        return password;
+    }
+
+    /**
+     * Sets the password flow configuration.
+     *
+     * @param password the password flow configuration
+     */
+    public void setPassword(PasswordFlow password) {
+        this.password = password;
+    }
+
+    /**
+     * Gets the client credentials flow configuration.
+     *
+     * @return the client credentials flow configuration
+     */
+    public ClientCredentialsFlow getClientCredentials() {
+        return clientCredentials;
+    }
+
+    /**
+     * Sets the client credentials flow configuration.
+     *
+     * @param clientCredentials the client credentials flow configuration
+     */
+    public void setClientCredentials(ClientCredentialsFlow clientCredentials) {
+        this.clientCredentials = clientCredentials;
+    }
+
+    /**
+     * Gets the authorization code flow configuration.
+     *
+     * @return the authorization code flow configuration
+     */
+    public AuthorizationCodeFlow getAuthorizationCode() {
+        return authorizationCode;
+    }
+
+    /**
+     * Sets the authorization code flow configuration.
+     *
+     * @param authorizationCode the authorization code flow configuration
+     */
+    public void setAuthorizationCode(AuthorizationCodeFlow authorizationCode) {
+        this.authorizationCode = authorizationCode;
+    }
+}

package/scalar-core/src/main/java/com/scalar/maven/core/authentication/schemes/ScalarApiKeySecurityScheme.java

@@ -0,0 +1,77 @@
+package com.scalar.maven.core.authentication.schemes;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+/**
+ * Represents a security scheme that uses HTTP header authentication.
+ * This scheme is used to prefill or overwrite HTTP header values for authentication purposes
+ * when making API requests. It allows specifying a custom header name and value pair.
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class ScalarApiKeySecurityScheme extends ScalarSecurityScheme {
+
+    /**
+     * Gets or sets the name of the HTTP header to be used for authentication.
+     * Common examples include "Authorization", "X-API-Key", or custom header names.
+     */
+    private String name;
+
+    /**
+     * Gets or sets the value of the HTTP header to be used for authentication.
+     * This value will be sent as-is in the specified header. For example, "Bearer token123" or "ApiKey abc123".
+     */
+    private String value;
+
+    /**
+     * Creates a new ScalarApiKeySecurityScheme.
+     */
+    public ScalarApiKeySecurityScheme() {
+    }
+
+    /**
+     * Creates a new ScalarApiKeySecurityScheme with the specified name and value.
+     *
+     * @param name  the header name
+     * @param value the header value
+     */
+    public ScalarApiKeySecurityScheme(String name, String value) {
+        this.name = name;
+        this.value = value;
+    }
+
+    /**
+     * Gets the name of the HTTP header.
+     *
+     * @return the header name
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Sets the name of the HTTP header.
+     *
+     * @param name the header name
+     */
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    /**
+     * Gets the value of the HTTP header.
+     *
+     * @return the header value
+     */
+    public String getValue() {
+        return value;
+    }
+
+    /**
+     * Sets the value of the HTTP header.
+     *
+     * @param value the header value
+     */
+    public void setValue(String value) {
+        this.value = value;
+    }
+}

package/scalar-core/src/main/java/com/scalar/maven/core/authentication/schemes/ScalarHttpSecurityScheme.java

@@ -0,0 +1,115 @@
+package com.scalar.maven.core.authentication.schemes;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+
+/**
+ * Represents a security scheme that uses HTTP authentication mechanisms like Basic or Bearer.
+ * This scheme is used to prefill or overwrite authentication values.
+ * It supports both Basic authentication (username/password) and Bearer authentication (token).
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class ScalarHttpSecurityScheme extends ScalarSecurityScheme {
+
+    /**
+     * Gets or sets the username used for HTTP basic authentication.
+     * When provided, this value will be used to prefill or overwrite the username
+     * for Basic authentication requests.
+     */
+    private String username;
+
+    /**
+     * Gets or sets the password used for HTTP basic authentication.
+     * When provided, this value will be used to prefill or overwrite the password
+     * for Basic authentication requests.
+     */
+    private String password;
+
+    /**
+     * Gets or sets the token used for HTTP bearer authentication.
+     * When provided, this value will be used to prefill or overwrite the token
+     * for Bearer authentication requests.
+     */
+    private String token;
+
+    /**
+     * Creates a new ScalarHttpSecurityScheme.
+     */
+    public ScalarHttpSecurityScheme() {
+    }
+
+    /**
+     * Creates a new ScalarHttpSecurityScheme for Basic authentication.
+     *
+     * @param username the username
+     * @param password the password
+     */
+    public ScalarHttpSecurityScheme(String username, String password) {
+        this.username = username;
+        this.password = password;
+    }
+
+    /**
+     * Creates a new ScalarHttpSecurityScheme for Bearer authentication.
+     *
+     * @param token the bearer token
+     */
+    public static ScalarHttpSecurityScheme forBearer(String token) {
+        ScalarHttpSecurityScheme scheme = new ScalarHttpSecurityScheme();
+        scheme.setToken(token);
+        return scheme;
+    }
+
+    /**
+     * Gets the username.
+     *
+     * @return the username
+     */
+    public String getUsername() {
+        return username;
+    }
+
+    /**
+     * Sets the username.
+     *
+     * @param username the username
+     */
+    public void setUsername(String username) {
+        this.username = username;
+    }
+
+    /**
+     * Gets the password.
+     *
+     * @return the password
+     */
+    public String getPassword() {
+        return password;
+    }
+
+    /**
+     * Sets the password.
+     *
+     * @param password the password
+     */
+    public void setPassword(String password) {
+        this.password = password;
+    }
+
+    /**
+     * Gets the token.
+     *
+     * @return the token
+     */
+    public String getToken() {
+        return token;
+    }
+
+    /**
+     * Sets the token.
+     *
+     * @param token the token
+     */
+    public void setToken(String token) {
+        this.token = token;
+    }
+}

package/scalar-core/src/main/java/com/scalar/maven/core/authentication/schemes/ScalarOAuth2SecurityScheme.java

@@ -0,0 +1,75 @@
+package com.scalar.maven.core.authentication.schemes;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.scalar.maven.core.authentication.flows.ScalarFlows;
+
+import java.util.List;
+
+/**
+ * Represents a security scheme that uses OAuth 2.0 authentication.
+ * This scheme is used to prefill or overwrite OAuth 2.0 authentication values
+ * when making API requests. It specifies flows and default scopes to be used
+ * during the authorization process.
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class ScalarOAuth2SecurityScheme extends ScalarSecurityScheme {
+
+    /**
+     * Gets or sets the OAuth 2.0 flows configuration for this security scheme.
+     * Contains configuration for different OAuth flow types like implicit, password,
+     * client credentials, or authorization code. The configured flows determine how
+     * the authentication process is handled.
+     */
+    private ScalarFlows flows;
+
+    /**
+     * Gets or sets the default OAuth 2.0 scopes to request during authorization.
+     * These scopes are prefilled or used to overwrite the requested scopes when initiating
+     * the OAuth flow.
+     */
+    @JsonProperty("x-default-scopes")
+    private List<String> defaultScopes;
+
+    /**
+     * Creates a new ScalarOAuth2SecurityScheme.
+     */
+    public ScalarOAuth2SecurityScheme() {
+    }
+
+    /**
+     * Gets the OAuth 2.0 flows configuration.
+     *
+     * @return the flows configuration
+     */
+    public ScalarFlows getFlows() {
+        return flows;
+    }
+
+    /**
+     * Sets the OAuth 2.0 flows configuration.
+     *
+     * @param flows the flows configuration
+     */
+    public void setFlows(ScalarFlows flows) {
+        this.flows = flows;
+    }
+
+    /**
+     * Gets the default OAuth 2.0 scopes.
+     *
+     * @return the default scopes
+     */
+    public List<String> getDefaultScopes() {
+        return defaultScopes;
+    }
+
+    /**
+     * Sets the default OAuth 2.0 scopes.
+     *
+     * @param defaultScopes the default scopes
+     */
+    public void setDefaultScopes(List<String> defaultScopes) {
+        this.defaultScopes = defaultScopes;
+    }
+}