org.apache.juneau.dto.swagger.SecurityScheme Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.dto.swagger;
import static org.apache.juneau.common.internal.StringUtils.*;
import static org.apache.juneau.internal.ArrayUtils.contains;
import static org.apache.juneau.internal.CollectionUtils.*;
import static org.apache.juneau.internal.ConverterUtils.*;
import java.util.*;
import org.apache.juneau.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.marshaller.*;
/**
* Allows the definition of a security scheme that can be used by the operations.
*
*
* Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's
* common flows (implicit, password, application and access code).
*
*
Example:
*
* // Basic authentication sample
* {
* "type" : "basic"
* }
*
* // API key sample
* {
* "type" : "apiKey" ,
* "name" : "api_key" ,
* "in" : "header"
* }
*
* // Implicit OAuth2 sample
* {
* "type" : "oauth2" ,
* "authorizationUrl" : "http://swagger.io/api/oauth/dialog" ,
* "flow" : "implicit" ,
* "scopes" : {
* "write:pets" : "modify pets in your account" ,
* "read:pets" : "read your pets"
* }
* }
*
*
* See Also:
*/
@Bean(properties="type,description,name,in,flow,authorizationUrl,tokenUrl,scopes,*")
@FluentSetters
public class SecurityScheme extends SwaggerElement {
private static final String[] VALID_TYPES = {"basic", "apiKey", "oauth2"};
private String
type,
description,
name,
in,
flow,
authorizationUrl,
tokenUrl;
private Map scopes;
/**
* Default constructor.
*/
public SecurityScheme() {}
/**
* Copy constructor.
*
* @param copyFrom The object to copy.
*/
public SecurityScheme(SecurityScheme copyFrom) {
super(copyFrom);
this.authorizationUrl = copyFrom.authorizationUrl;
this.description = copyFrom.description;
this.flow = copyFrom.flow;
this.in = copyFrom.in;
this.name = copyFrom.name;
this.scopes = copyOf(copyFrom.scopes);
this.tokenUrl = copyFrom.tokenUrl;
this.type = copyFrom.type;
}
/**
* Make a deep copy of this object.
*
* @return A deep copy of this object.
*/
public SecurityScheme copy() {
return new SecurityScheme(this);
}
@Override /* SwaggerElement */
protected SecurityScheme strict() {
super.strict();
return this;
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* Bean property getter: authorizationUrl .
*
*
* The authorization URL to be used for this flow.
*
* @return The property value, or null if it is not set.
*/
public String getAuthorizationUrl() {
return authorizationUrl;
}
/**
* Bean property setter: authorizationUrl .
*
*
* The authorization URL to be used for this flow.
*
* @param value
* The new value for this property.
*
This SHOULD be in the form of a URL.
*
Can be null to unset the property.
* @return This object.
*/
public SecurityScheme setAuthorizationUrl(String value) {
authorizationUrl = value;
return this;
}
/**
* Bean property getter: description .
*
*
* A short description for security scheme.
*
* @return The property value, or null if it is not set.
*/
public String getDescription() {
return description;
}
/**
* Bean property setter: description .
*
*
* A short description for security scheme.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object.
*/
public SecurityScheme setDescription(String value) {
description = value;
return this;
}
/**
* Bean property getter: flow .
*
*
* The flow used by the OAuth2 security scheme.
*
* @return The property value, or null if it is not set.
*/
public String getFlow() {
return flow;
}
/**
* Bean property setter: flow .
*
*
* The flow used by the OAuth2 security scheme.
*
* @param value
* The new value for this property.
*
Valid values:
*
* "implicit"
* "password"
* "application"
* "accessCode"
*
*
Can be null to unset the property.
* @return This object.
*/
public SecurityScheme setFlow(String value) {
flow = value;
return this;
}
/**
* Bean property getter: in .
*
*
* The location of the API key.
*
* @return The property value, or null if it is not set.
*/
public String getIn() {
return in;
}
/**
* Bean property setter: in .
*
*
* The location of the API key.
*
* @param value
* The new value for this property.
*
Valid values:
*
* "query"
* "header"
*
*
Can be null to unset the property.
* @return This object.
*/
public SecurityScheme setIn(String value) {
in = value;
return this;
}
/**
* Bean property getter: name .
*
*
* The name of the header or query parameter to be used.
*
* @return The property value, or null if it is not set.
*/
public String getName() {
return name;
}
/**
* Bean property setter: name .
*
*
* The name of the header or query parameter to be used.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object.
*/
public SecurityScheme setName(String value) {
name = value;
return this;
}
/**
* Bean property getter: scopes .
*
*
* The available scopes for the OAuth2 security scheme.
*
* @return The property value, or null if it is not set.
*/
public Map getScopes() {
return scopes;
}
/**
* Bean property setter: scopes .
*
*
* The available scopes for the OAuth2 security scheme.
*
* @param value
* The new value for this property.
*
Can be null to unset the property.
* @return This object.
*/
public SecurityScheme setScopes(Map value) {
scopes = copyOf(value);
return this;
}
/**
* Bean property appender: scopes .
*
*
* The available scopes for the OAuth2 security scheme.
*
* @param key The scope key.
* @param value The scope value.
* @return This object.
*/
public SecurityScheme addScope(String key, String value) {
scopes = mapBuilder(scopes).sparse().add(key, value).build();
return this;
}
/**
* Bean property getter: tokenUrl .
*
*
* The token URL to be used for this flow.
*
* @return The property value, or null if it is not set.
*/
public String getTokenUrl() {
return tokenUrl;
}
/**
* Bean property setter: tokenUrl .
*
*
* The token URL to be used for this flow.
*
* @param value
* The new value for this property.
*
This SHOULD be in the form of a URL.
*
Can be null to unset the property.
* @return This object.
*/
public SecurityScheme setTokenUrl(String value) {
tokenUrl = value;
return this;
}
/**
* Bean property getter: type .
*
*
* The type of the security scheme.
*
* @return The property value, or null if it is not set.
*/
public String getType() {
return type;
}
/**
* Bean property setter: type .
*
*
* The type of the security scheme.
*
* @param value
* The new value for this property.
*
Valid values:
*
* "basic"
* "apiKey"
* "oauth2"
*
*
Property value is required.
* @return This object.
*/
public SecurityScheme setType(String value) {
if (isStrict() && ! contains(value, VALID_TYPES))
throw new BasicRuntimeException(
"Invalid value passed in to setType(String). Value=''{0}'', valid values={1}",
value, Json5.of(VALID_TYPES)
);
type = value;
return this;
}
//
//
@Override /* SwaggerElement */
public T get(String property, Class type) {
if (property == null)
return null;
switch (property) {
case "authorizationUrl": return toType(getAuthorizationUrl(), type);
case "description": return toType(getDescription(), type);
case "flow": return toType(getFlow(), type);
case "in": return toType(getIn(), type);
case "name": return toType(getName(), type);
case "scopes": return toType(getScopes(), type);
case "tokenUrl": return toType(getTokenUrl(), type);
case "type": return toType(getType(), type);
default: return super.get(property, type);
}
}
@Override /* SwaggerElement */
public SecurityScheme set(String property, Object value) {
if (property == null)
return this;
switch (property) {
case "authorizationUrl": return setAuthorizationUrl(stringify(value));
case "description": return setDescription(stringify(value));
case "flow": return setFlow(stringify(value));
case "in": return setIn(stringify(value));
case "name": return setName(stringify(value));
case "scopes": return setScopes(mapBuilder(String.class,String.class).sparse().addAny(value).build());
case "tokenUrl": return setTokenUrl(stringify(value));
case "type": return setType(stringify(value));
default:
super.set(property, value);
return this;
}
}
@Override /* SwaggerElement */
public Set keySet() {
Set s = setBuilder(String.class)
.addIf(authorizationUrl != null, "authorizationUrl")
.addIf(description != null, "description")
.addIf(flow != null, "flow")
.addIf(in != null, "in")
.addIf(name != null, "name")
.addIf(scopes != null, "scopes")
.addIf(tokenUrl != null, "tokenUrl")
.addIf(type != null, "type")
.build();
return new MultiSet<>(s, super.keySet());
}
}