io.federecio.dropwizard.swagger.SwaggerOAuth2Configuration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dropwizard-swagger Show documentation

A simple way to document your REST APIs in DropWizard using Swagger

There is a newer version: 4.0.5-1

// Copyright (C) 2014 Federico Recio
/**
 * Licensed 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 io.federecio.dropwizard.swagger;

import java.util.Map;
import javax.annotation.Nullable;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.google.common.collect.Maps;

/**
 * For the meaning of all these properties please refer to Swagger UI
 * documentation or
 * {@see https://github.com/swagger-api/swagger-ui/blob/master/lib/swagger-oauth.js}
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class SwaggerOAuth2Configuration {

    @Nullable
    private String clientId;

    @Nullable
    private String clientSecret;

    @Nullable
    private String realm;

    @Nullable
    private String appName;

    @Nullable
    private String scopeSeparator;

    private Map additionalQueryStringParams = Maps.newHashMap();

    @Nullable
    public String getClientId() {
        return clientId;
    }

    public void setClientId(@Nullable String clientId) {
        this.clientId = clientId;
    }

    @Nullable
    public String getClientSecret() {
        return clientSecret;
    }

    public void setClientSecret(@Nullable String clientSecret) {
        this.clientSecret = clientSecret;
    }

    @Nullable
    public String getRealm() {
        return realm;
    }

    public void setRealm(@Nullable String realm) {
        this.realm = realm;
    }

    @Nullable
    public String getAppName() {
        return appName;
    }

    public void setAppName(@Nullable String appName) {
        this.appName = appName;
    }

    @Nullable
    public String getScopeSeparator() {
        return scopeSeparator;
    }

    public void setScopeSeparator(@Nullable String scopeSeparator) {
        this.scopeSeparator = scopeSeparator;
    }

    public Map getAdditionalQueryStringParams() {
        return additionalQueryStringParams;
    }

    public void setAdditionalQueryStringParams(
            Map additionalQueryStringParams) {
        this.additionalQueryStringParams = additionalQueryStringParams;
    }
}