io.inversion.action.security.AuthScheme Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of inversion-core-api Show documentation

Inversion Cloud API Engine

The newest version!

/*
 * Copyright (c) 2015-2021 Rocket Partners, LLC
 * https://github.com/inversion-api
 *
 * 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.inversion.action.security;

import io.inversion.*;

import java.util.ArrayList;
import java.util.List;

public abstract class AuthScheme {

    public enum AuthSchemeType {http, apiKey, openIdConnect, oauth2}


    String         name        = null;
    String         description = null;
    AuthSchemeType type        = null;
    List    params      = new ArrayList();


    public abstract User getUser(Request req, Response res) throws ApiException;

    public String getName() {
        return name;
    }

    public AuthScheme withName(String name) {
        this.name = name;
        return this;
    }

    public String getDescription() {
        return description;
    }

    public AuthScheme withDescription(String description) {
        this.description = description;
        return this;
    }

    public AuthSchemeType getType() {
        return type;
    }

    public AuthScheme withType(AuthSchemeType type) {
        this.type = type;
        return this;
    }

    public List getParams() {
        return params;
    }

    public AuthScheme withParams(List params) {
        this.params = params;
        return this;
    }

    public AuthScheme withParam(Param param) {
        if (param != null && !params.contains(param))
            this.params.add(param);
        return this;
    }

}