io.thestencil.iam.api.IAMClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stencil-iam-api Show documentation
The newest version!
package io.thestencil.iam.api;

import java.util.List;

/*-
 * #%L
 * iam-api
 * %%
 * Copyright (C) 2021 - 2022 Copyright 2021 ReSys OÜ
 * %%
 * 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.
 * #L%
 */

import javax.annotation.Nullable;

import org.eclipse.microprofile.jwt.JsonWebToken;
import org.immutables.value.Value;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import io.smallrye.mutiny.Uni;
import io.vertx.mutiny.ext.web.client.WebClient;

public interface IAMClient {

  LivenessQuery livenessQuery();
  UserQuery userQuery();
  UserRolesQuery personRolesQuery();
  UserRolesQuery companyRolesQuery();
  
  IAMClientConfig getConfig();
  
  interface LivenessQuery {
    Uni get();
  }
  interface UserQuery {
    Uni get();
  }
  interface UserRolesQuery {
    UserRolesQuery id(String id);
    Uni get();
  }
  @Value.Immutable @JsonSerialize(as = ImmutableUserRolesResult.class) @JsonDeserialize(as = ImmutableUserRolesResult.class)
  interface UserRolesResult {
    ResultType getType();
    @Nullable
    UserRoles getUserRoles();
  }
  @Value.Immutable @JsonSerialize(as = ImmutableUserRoles.class) @JsonDeserialize(as = ImmutableUserRoles.class)
  interface UserRoles {
    List getRoles();
    @Nullable
    UserRolesPrincipal getPrincipal(); 
  }
  @Value.Immutable @JsonSerialize(as = ImmutableUserRolesPrincipal.class) @JsonDeserialize(as = ImmutableUserRolesPrincipal.class)
  interface UserRolesPrincipal {
    String getIdentifier();
    String getName();
  }
  
  @Value.Immutable @JsonSerialize(as = ImmutableUserLiveness.class) @JsonDeserialize(as = ImmutableUserLiveness.class)
  interface UserLiveness {
    // Issuance in seconds
    long getIssuedAtTime();
    
    // Expiration in seconds
    long getExpiresIn();
  }

  @Value.Immutable @JsonSerialize(as = ImmutableRepresentedPerson.class) @JsonDeserialize(as = ImmutableRepresentedPerson.class)
  interface RepresentedPerson {
    String getPersonId();
    String getName();
  }
  
  @Value.Immutable @JsonSerialize(as = ImmutableRepresentedCompany.class) @JsonDeserialize(as = ImmutableRepresentedCompany.class)
  interface RepresentedCompany {
    String getCompanyId();
    String getName();
  }
  
  
  @Value.Immutable @JsonSerialize(as = ImmutableUser.class) @JsonDeserialize(as = ImmutableUser.class)
  interface User {
    String getId();
    String getSsn();
    String getUsername();
    String getFirstName();
    String getLastName();
    Contact getContact();
    Boolean getProtectionOrder();
    @Nullable
    RepresentedPerson getRepresentedPerson();
    @Nullable
    RepresentedCompany getRepresentedCompany();  
  }

  @Value.Immutable @JsonSerialize(as = ImmutableContact.class) @JsonDeserialize(as = ImmutableContact.class)
  interface Contact {
    String getEmail();
    @Nullable
    Address getAddress();
    @Nullable
    String getAddressValue();
  }

  @Value.Immutable @JsonSerialize(as = ImmutableAddress.class) @JsonDeserialize(as = ImmutableAddress.class)
  interface Address {
    String getLocality();
    String getStreet();
    String getPostalCode();
    String getCountry();
  }
  
  enum ResultType { OK, ANONYMOUS, ERROR, EMPTY }
  
  @Value.Immutable @JsonSerialize(as = ImmutableUserQueryResult.class) @JsonDeserialize(as = ImmutableUserQueryResult.class)
  interface UserQueryResult {
    ResultType getType();
    @Nullable
    User getUser();
  }
  
  
  @Value.Immutable
  interface IAMClientConfig {
    JsonWebToken getToken();
    WebClient getWebClient();
    String getServicePath();
    RemoteIntegration getPersonSecurityProxy();
    RemoteIntegration getCompanySecurityProxy();
  }

}