io.fusionauth.domain.UserActionLog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fusionauth-java-client Show documentation
The Java Client library provides a native Java binding to the FusionAuth REST API.
The newest version!
/*
 * Copyright (c) 2018-2020, FusionAuth, All Rights Reserved
 *
 * 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.fusionauth.domain;

import java.time.ZoneOffset;
import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.UUID;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.inversoft.json.ToString;
import static io.fusionauth.domain.util.Normalizer.trim;

/**
 * A log for an action that was taken on a User.
 *
 * @author Brian Pontarelli
 */
public class UserActionLog implements Buildable {
  public UUID actioneeUserId;

  public UUID actionerUserId;

  public List applicationIds = new ArrayList<>();

  public String comment;

  /**
   * FusionAuth will email the user when the action ends.
   */
  public boolean emailUserOnEnd;

  public Boolean endEventSent;

  public ZonedDateTime expiry;

  public LogHistory history;

  public UUID id;

  public ZonedDateTime insertInstant;

  public String localizedName;

  public String localizedOption;

  public String localizedReason;

  public String name;

  /**
   * Webhooks will use this to determine if they should notify the user
   */
  public boolean notifyUserOnEnd;

  public String option;

  public String reason;

  public String reasonCode;

  public UUID userActionId;

  public UserActionLog() {
  }

  public UserActionLog(UUID actioneeUserId, UUID actionerUserId, UUID userActionId, List applicationIds,
                       String comment, ZonedDateTime expiry, String name, String localizedName, String option,
                       String localizedOption, String reason, String localizedReason, String reasonCode,
                       ZonedDateTime insertInstant, Boolean endEventSent, LogHistory history, boolean notifyUserOnEnd,
                       boolean emailUserOnEnd) {
    this.actioneeUserId = actioneeUserId;
    this.actionerUserId = actionerUserId;
    this.userActionId = userActionId;

    if (applicationIds != null) {
      this.applicationIds = applicationIds;
    }

    this.comment = comment;
    this.expiry = expiry;
    this.name = name;
    this.localizedName = localizedName;
    this.option = option;
    this.reason = reason;
    this.reasonCode = reasonCode;
    this.insertInstant = insertInstant;
    this.endEventSent = endEventSent;
    this.history = history;
    this.localizedOption = localizedOption;
    this.localizedReason = localizedReason;
    this.emailUserOnEnd = emailUserOnEnd;
    this.notifyUserOnEnd = notifyUserOnEnd;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (!(o instanceof UserActionLog)) {
      return false;
    }
    UserActionLog that = (UserActionLog) o;
    Collections.sort(this.applicationIds);
    Collections.sort(that.applicationIds);
    return Objects.equals(emailUserOnEnd, that.emailUserOnEnd) &&
           Objects.equals(actioneeUserId, that.actioneeUserId) &&
           Objects.equals(actionerUserId, that.actionerUserId) &&
           Objects.equals(applicationIds, that.applicationIds) &&
           Objects.equals(comment, that.comment) &&
           Objects.equals(id, that.id) &&
           Objects.equals(insertInstant, that.insertInstant) &&
           Objects.equals(endEventSent, that.endEventSent) &&
           Objects.equals(notifyUserOnEnd, that.notifyUserOnEnd) &&
           Objects.equals(expiry, that.expiry) &&
           Objects.equals(history, that.history) &&
           Objects.equals(localizedName, that.localizedName) &&
           Objects.equals(localizedOption, that.localizedOption) &&
           Objects.equals(localizedReason, that.localizedReason) &&
           Objects.equals(name, that.name) &&
           Objects.equals(option, that.option) &&
           Objects.equals(reason, that.reason) &&
           Objects.equals(reasonCode, that.reasonCode) &&
           Objects.equals(userActionId, that.userActionId);
  }

  @Override
  public int hashCode() {
    return Objects.hash(actioneeUserId, actionerUserId, applicationIds, comment, id, insertInstant, emailUserOnEnd, endEventSent, expiry,
                        history, localizedName, localizedOption, localizedReason, name, option, reason, reasonCode, userActionId, notifyUserOnEnd);
  }

  @JsonIgnore
  public boolean isActive() {
    return expiry != null && expiry.isAfter(ZonedDateTime.now(ZoneOffset.UTC));
  }

  public void normalize() {
    comment = trim(comment);
  }

  public String toString() {
    return ToString.toString(this);
  }
}