io.fusionauth.domain.event.UserActionEvent 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-2024, 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.event;

import java.time.Instant;
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.inversoft.json.JacksonConstructor;
import io.fusionauth.domain.Buildable;
import io.fusionauth.domain.EventInfo;
import io.fusionauth.domain.email.Email;

/**
 * Models the user action Event.
 *
 * @author Brian Pontarelli
 */
public class UserActionEvent extends BaseEvent implements Buildable, ObjectIdentifiable {
  public static ZonedDateTime Infinite = ZonedDateTime.ofInstant(Instant.ofEpochMilli(Long.MAX_VALUE), ZoneOffset.UTC);

  public final List applicationIds = new ArrayList<>();

  public String action;

  public UUID actionId;

  public UUID actioneeUserId;

  public UUID actionerUserId;

  public String comment;

  public Email email;

  public boolean emailedUser;

  public ZonedDateTime expiry;

  public String localizedAction;

  public String localizedDuration;

  public String localizedOption;

  public String localizedReason;

  public boolean notifyUser;

  public String option;

  public UserActionPhase phase;

  public String reason;

  public String reasonCode;

  @JacksonConstructor
  public UserActionEvent() {
  }

  /**
   * @param info              The event info object containing IP information, and possibly location from the request.
   * @param actionId          The id that tracks this user action (the log id).
   * @param actioneeUserId    The user id of the person being actioned.
   * @param actionerUserId    The user id of the person that took the action.
   * @param applicationIds    The ids of the applications the action is being performed in.
   * @param action            the user action
   * @param localizedAction   The localized action.
   * @param option            the action option
   * @param localizedOption   The localized option.
   * @param reason            The user action   reason.
   * @param localizedReason   The localized reason.
   * @param reasonCode        The user action reason code.
   * @param expiry            The expiration instant.
   * @param localizedDuration The localized duration text.
   * @param phase             The phase for time-based user actions.
   * @param comment           A comment from the moderator.
   * @param notifyUser        A flag to tell the webhook to notify user of the action.
   * @param emailedUser       A flag indicating that FusionAuth emailed the user.
   * @param email             The email that should be sent to the end user.
   */
  public UserActionEvent(EventInfo info, UUID actionId, UUID actioneeUserId, UUID actionerUserId, List applicationIds,
                         String action, String localizedAction, String option, String localizedOption,
                         String reason, String localizedReason, String reasonCode, ZonedDateTime expiry,
                         String localizedDuration, UserActionPhase phase, String comment, boolean notifyUser,
                         boolean emailedUser, Email email) {
    super(info);
    this.actionId = actionId;
    this.action = action;
    this.actioneeUserId = actioneeUserId;
    this.actionerUserId = actionerUserId;
    this.comment = comment;
    this.expiry = expiry;
    this.localizedAction = localizedAction;
    this.localizedDuration = localizedDuration;
    this.localizedOption = localizedOption;
    this.localizedReason = localizedReason;
    this.notifyUser = notifyUser;
    this.option = option;
    this.phase = phase;
    this.reason = reason;
    this.reasonCode = reasonCode;
    this.emailedUser = emailedUser;
    this.email = email;

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

  public boolean active() {
    return expiry != null && ZonedDateTime.now(ZoneOffset.UTC).isBefore(expiry);
  }

  @Override
  public boolean equals(Object o) {
    if (!super.equals(o)) {
      return false;
    }
    UserActionEvent that = (UserActionEvent) o;
    return Objects.equals(applicationIds, that.applicationIds) &&
           Objects.equals(action, that.action) &&
           Objects.equals(actionId, that.actionId) &&
           Objects.equals(actioneeUserId, that.actioneeUserId) &&
           Objects.equals(actionerUserId, that.actionerUserId) &&
           Objects.equals(comment, that.comment) &&
           Objects.equals(email, that.email) &&
           Objects.equals(emailedUser, that.emailedUser) &&
           Objects.equals(expiry, that.expiry) &&
           Objects.equals(localizedAction, that.localizedAction) &&
           Objects.equals(localizedDuration, that.localizedDuration) &&
           Objects.equals(localizedOption, that.localizedOption) &&
           Objects.equals(localizedReason, that.localizedReason) &&
           Objects.equals(notifyUser, that.notifyUser) &&
           Objects.equals(option, that.option) &&
           Objects.equals(phase, that.phase) &&
           Objects.equals(reason, that.reason) &&
           Objects.equals(reasonCode, that.reasonCode);
  }

  @Override
  public UUID getLinkedObjectId() {
    return actioneeUserId;
  }

  @Override
  public void setLinkedObjectId(UUID linkedObjectId) {
    // needs a setter for the deserializer.
  }

  @Override
  public EventType getType() {
    return EventType.UserAction;
  }

  @Override
  public int hashCode() {
    return Objects.hash(super.hashCode(), actionId, applicationIds, action, actioneeUserId, actionerUserId, comment, email, expiry,
                        localizedAction, localizedDuration, localizedOption, localizedReason, notifyUser, option, emailedUser,
                        phase, reason, reasonCode);
  }
}