io.gravitee.management.model.configuration.identity.SocialIdentityProviderEntity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-management-api-model Show documentation
Gravitee IO Manager Model
There is a newer version: 1.30.31
Show newest version
/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * 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.gravitee.management.model.configuration.identity;

import com.fasterxml.jackson.annotation.JsonIgnore;

import java.util.List;
import java.util.Map;

/**
 * @author David BRASSELY (david.brassely at graviteesource.com)
 * @author GraviteeSource Team
 */
public abstract class SocialIdentityProviderEntity {

    private static final String DEFAULT_AUTHORIZATION_HEADER = "Bearer %s";
    private static final String DEFAULT_SCOPE_DELIMITER = " ";

    private String id;

    private String name;

    private String description;

    private String clientId;

    private boolean emailRequired;

    @JsonIgnore
    private String clientSecret;

    @JsonIgnore
    private List groupMappings;

    @JsonIgnore
    private List roleMappings;

    public static class UserProfile {
        public static final String ID = "id";
        public static final String SUB = "sub";
        public static final String FIRSTNAME = "firstname";
        public static final String LASTNAME = "lastname";
        public static final String PICTURE = "picture";
        public static final String EMAIL = "email";
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getClientId() {
        return clientId;
    }

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

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

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

    public String getScopeDelimiter() {
        return DEFAULT_SCOPE_DELIMITER;
    }

    @JsonIgnore
    public String getAuthorizationHeader() {
        return DEFAULT_AUTHORIZATION_HEADER;
    }

    public abstract IdentityProviderType getType();

    public abstract String getAuthorizationEndpoint();

    public String getTokenIntrospectionEndpoint() {
        return null;
    }

    @JsonIgnore
    public abstract String getTokenEndpoint();

    @JsonIgnore
    public abstract String getUserInfoEndpoint();

    public String getUserLogoutEndpoint() {
        return null;
    }

    public abstract List getRequiredUrlParams();

    public abstract List getOptionalUrlParams();

    public abstract List getScopes();

    public abstract String getDisplay();

    public abstract String getState();

    public abstract String getColor();

    public abstract String getIcon();

    @JsonIgnore
    public abstract Map getUserProfileMapping();

    public List getGroupMappings() {
        return groupMappings;
    }

    public void setGroupMappings(List groupMappings) {
        this.groupMappings = groupMappings;
    }

    public List getRoleMappings() {
        return roleMappings;
    }

    public void setRoleMappings(List roleMappings) {
        this.roleMappings = roleMappings;
    }

    public boolean isEmailRequired() {
        return emailRequired;
    }

    public void setEmailRequired(boolean emailRequired) {
        this.emailRequired = emailRequired;
    }
}