• Home
• io.permit
• permit-sdk-java
• 2.1.0-rc.3
• source code
• ApiClient.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.permit.sdk.api.ApiClient Maven / Gradle / Ivy

package io.permit.sdk.api;

import io.permit.sdk.PermitConfig;
import io.permit.sdk.api.models.CreateOrUpdateResult;
import io.permit.sdk.openapi.models.*;
import okhttp3.*;
import org.jetbrains.annotations.NotNull;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;

interface IDeprecatedApis {
    UserRead getUser(String userKey) throws IOException, PermitApiError, PermitContextError;
    RoleRead getRole(String roleKey) throws IOException, PermitApiError, PermitContextError;
    TenantRead getTenant(String tenantKey) throws IOException, PermitApiError, PermitContextError;
    RoleAssignmentRead[] getAssignedRoles(@NotNull String userKey, @NotNull String tenantKey) throws IOException, PermitApiError, PermitContextError;
    RoleAssignmentRead[] getAssignedRolesInAllTenants(@NotNull String userKey) throws IOException, PermitApiError, PermitContextError;
    CreateOrUpdateResult syncUser(UserCreate userData) throws IOException, PermitApiError, PermitContextError;
    void deleteUser(String userKey) throws IOException, PermitContextError, PermitApiError;
    TenantRead createTenant(TenantCreate tenantData) throws IOException, PermitApiError, PermitContextError;
    TenantRead updateTenant(String tenantKey, TenantUpdate tenantData) throws IOException, PermitApiError, PermitContextError;
    void deleteTenant(String tenantKey) throws IOException, PermitContextError, PermitApiError;
    RoleAssignmentRead assignRole(String userKey, String roleKey, String tenantKey) throws IOException, PermitApiError, PermitContextError;
    void unassignRole(String userKey, String roleKey, String tenantKey) throws IOException, PermitContextError, PermitApiError;
}

/**
 * The {@code ApiClient} class provides a client for interacting with the Permit REST API.
 * It encapsulates the HTTP client and provides methods for accessing different API endpoints.
 */
public class ApiClient implements IDeprecatedApis {
    final static Logger logger = LoggerFactory.getLogger(ApiClient.class);
    private final OkHttpClient client;
    private final PermitConfig config;

    /**
     * The {@code ProjectsApi} instance for accessing project related API endpoints.
     */
    public final ProjectsApi projects;

    /**
     * The {@code EnvironmentsApi} instance for accessing environment related API endpoints.
     */
    public final EnvironmentsApi environments;

    /**
     * The {@code ResourcesApi} instance for accessing resource related API endpoints.
     */
    public final ResourcesApi resources;

    /**
     * The {@code ResourceActionsApi} instance for accessing resource actions related API endpoints.
     */
    public final ResourceActionsApi resourceActions;

    /**
     * The {@code ResourceActionGroupsApi} instance for accessing action group related API endpoints.
     */
    public final ResourceActionGroupsApi resourceActionGroups;

    /**
     * The {@code ResourceAttributesApi} instance for accessing resource attributes related API endpoints.
     */
    public final ResourceAttributesApi resourceAttributes;

    /**
     * The {@code ResourceRolesApi} instance for accessing Resource Roles.
     */
    public final ResourceRolesApi resourceRoles;

    /**
     * The {@code ResourceRelationsApi} instance for accessing Resource Relations.
     */
    public final ResourceRelationsApi resourceRelations;

    /**
     * The {@code ResourceInstancesApi} instance for accessing Resource Instances.
     */
    public final ResourceInstancesApi resourceInstances;

    /**
     * The {@code RolesApi} instance for accessing role related API endpoints.
     */
    public final RolesApi roles;

    /**
     * The {@code ConditionSetsApi} instance for accessing condition set related API endpoints.
     */
    public final ConditionSetsApi conditionSets;

    /**
     * The {@code TenantsApi} instance for accessing tenant related API endpoints.
     */
    public final TenantsApi tenants;

    /**
     * The {@code UsersApi} instance for accessing user related API endpoints.
     */
    public final UsersApi users;

    /**
     * The {@code RoleAssignmentsApi} instance for accessing role assignment related API endpoints.
     */
    public final RoleAssignmentsApi roleAssignments;

    /**
     * The {@code RelationshipTuplesApi} instance for accessing Relationship Tuples.
     */
    public final RelationshipTuplesApi relationshipTuples;

    /**
     * The {@code ConditionSetRulesApi} instance for accessing condition set rules related API endpoints.
     */
    public final ConditionSetRulesApi conditionSetRules;

    /**
     * The {@code ElementsApi} instance for accessing Permit Elements related API endpoints.
     */
    public final ElementsApi elements;


    /**
     * Constructs a new instance of the {@code ApiClient} class with the specified configuration.
     *
     * @param config The Permit SDK configuration.
     */
    public ApiClient(PermitConfig config) {
        this.config = config;
        this.client = new OkHttpClient.Builder()
                .addInterceptor(new HttpLoggingInterceptor(logger, config))
                .build();

        this.projects = new ProjectsApi(this.client, this.config);
        this.environments = new EnvironmentsApi(this.client, this.config);
        this.resources = new ResourcesApi(this.client, this.config);
        this.resourceActions = new ResourceActionsApi(this.client, this.config);
        this.resourceActionGroups = new ResourceActionGroupsApi(this.client, this.config);
        this.resourceAttributes = new ResourceAttributesApi(this.client, this.config);
        this.resourceRoles = new ResourceRolesApi(this.client, this.config);
        this.resourceRelations = new ResourceRelationsApi(this.client, this.config);
        this.resourceInstances = new ResourceInstancesApi(this.client, this.config);
        this.roles = new RolesApi(this.client, this.config);
        this.conditionSets = new ConditionSetsApi(this.client, this.config);
        this.tenants = new TenantsApi(this.client, this.config);
        this.users = new UsersApi(this.client, this.config);
        this.roleAssignments = new RoleAssignmentsApi(this.client, this.config);
        this.relationshipTuples = new RelationshipTuplesApi(this.client, this.config);
        this.conditionSetRules = new ConditionSetRulesApi(this.client, this.config);
        this.elements = new ElementsApi(this.client, this.config);
    }

    /**
     * Gets a user by its key
     *
     * @deprecated replaced with permit.api.users.get()
     * @see io.permit.sdk.api.UsersApi#get(String)
     */
    @Deprecated
    @Override
    public UserRead getUser(String userKey) throws IOException, PermitApiError, PermitContextError {
        return this.users.get(userKey);
    }

    /**
     * Gets a role by its key
     *
     * @deprecated replaced with permit.api.users.get()
     * @see io.permit.sdk.api.RolesApi#get(String)
     */
    @Deprecated
    @Override
    public RoleRead getRole(String roleKey) throws IOException, PermitApiError, PermitContextError {
        return this.roles.get(roleKey);
    }

    /**
     * Gets a role by its key
     *
     * @deprecated replaced with permit.api.users.get()
     * @see io.permit.sdk.api.TenantsApi#get(String)
     */
    @Deprecated
    @Override
    public TenantRead getTenant(String tenantKey) throws IOException, PermitApiError, PermitContextError {
        return this.tenants.get(tenantKey);
    }

    /**
     * Gets the roles assigned to a user in a specific tenant
     *
     * @deprecated replaced with permit.api.users.getAssignedRoles()
     * @see io.permit.sdk.api.UsersApi#getAssignedRoles(String, String, int, int)
     */
    @Deprecated
    @Override
    public RoleAssignmentRead[] getAssignedRoles(@NotNull String userKey, @NotNull String tenantKey) throws IOException, PermitApiError, PermitContextError {
        return this.users.getAssignedRoles(userKey, tenantKey, 1, 100);
    }

    /**
     * Gets the roles assigned to a user in all tenants
     *
     * @deprecated replaced with permit.api.users.getAssignedRoles()
     * @see io.permit.sdk.api.UsersApi#getAssignedRoles(String, String, int, int)
     */
    @Deprecated
    @Override
    public RoleAssignmentRead[] getAssignedRolesInAllTenants(@NotNull String userKey) throws IOException, PermitApiError, PermitContextError {
        return this.users.getAssignedRoles(userKey, null, 1, 100);
    }

    /**
     * Syncs a user to the permissions system, i.e: creates the user if it's not already created, or updates the user in place.
     * The user is identified by its key (a customer-side unique id that identifies the user).
     *
     * @deprecated replaced with permit.api.users.get()
     * @see io.permit.sdk.api.UsersApi#sync(UserCreate)
     */
    @Deprecated
    @Override
    public CreateOrUpdateResult syncUser(UserCreate userData) throws IOException, PermitApiError, PermitContextError {
        return this.users.sync(userData);
    }

    /**
     * Deletes a user from the permission system (this will delete the user from all tenants at once).
     *
     * @deprecated replaced with permit.api.users.delete()
     * @see io.permit.sdk.api.UsersApi#delete(String)
     */
    @Deprecated
    @Override
    public void deleteUser(String userKey) throws IOException, PermitContextError, PermitApiError {
        this.users.delete(userKey);
    }

    /**
     * Creates a new tenant. 
     * @throws PermitApiError If the Permit API returns a response with an error status code.
     *
     * @deprecated replaced with permit.api.tenants.create()
     * @see io.permit.sdk.api.TenantsApi#create(TenantCreate) 
     */
    @Deprecated
    @Override
    public TenantRead createTenant(TenantCreate tenantData) throws IOException, PermitApiError, PermitContextError {
        return this.tenants.create(tenantData);
    }

    /**
     * Updates a tenant.
     *
     * @deprecated replaced with permit.api.tenants.update()
     * @see io.permit.sdk.api.TenantsApi#update(String, TenantUpdate)
     */
    @Deprecated
    @Override
    public TenantRead updateTenant(String tenantKey, TenantUpdate tenantData) throws IOException, PermitApiError, PermitContextError {
        return this.tenants.update(tenantKey, tenantData);
    }

    /**
     * Deletes a tenant from the system.
     * All roles assigned to users in that tenants will be unassigned as a result.
     *
     * @deprecated replaced with permit.api.tenants.delete()
     * @see io.permit.sdk.api.TenantsApi#delete(String)
     */
    @Deprecated
    @Override
    public void deleteTenant(String tenantKey) throws IOException, PermitContextError, PermitApiError {
        this.tenants.delete(tenantKey);
    }

    /**
     * assigns a role to user in tenant, if not already assigned.
     *
     * @deprecated replaced with permit.api.users.assignRole()
     * @see io.permit.sdk.api.UsersApi#assignRole(String, String, String)
     */
    @Deprecated
    @Override
    public RoleAssignmentRead assignRole(String userKey, String roleKey, String tenantKey) throws IOException, PermitApiError, PermitContextError {
        return this.users.assignRole(userKey, roleKey, tenantKey);
    }

    /**
     * unassigns a role to user in tenant, if assigned.
     *
     * @deprecated replaced with permit.api.users.unassignRole()
     * @see io.permit.sdk.api.UsersApi#unassignRole(String, String, String)
     */
    @Deprecated
    @Override
    public void unassignRole(String userKey, String roleKey, String tenantKey) throws IOException, PermitContextError, PermitApiError {
        this.users.unassignRole(userKey, roleKey, tenantKey);
    }
}