IdAShellCmdUserLoginHistory.java

/*
 * Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.idstore.shell.admin.internal;

import com.io7m.idstore.admin_client.api.IdAClientSynchronousType;
import com.io7m.idstore.protocol.admin.IdACommandUserLoginHistory;
import com.io7m.idstore.protocol.admin.IdAResponseUserLoginHistory;
import com.io7m.quarrel.core.QCommandContextType;
import com.io7m.quarrel.core.QCommandMetadata;
import com.io7m.quarrel.core.QParameterNamed1;
import com.io7m.quarrel.core.QParameterNamedType;
import com.io7m.quarrel.core.QStringType.QConstant;

import java.util.List;
import java.util.Optional;
import java.util.UUID;

/**
 * "user-login-history"
 */

public final class IdAShellCmdUserLoginHistory
  extends IdAShellCmdAbstract<IdACommandUserLoginHistory, IdAResponseUserLoginHistory>
{
  private static final QParameterNamed1<UUID> USER_ID =
    new QParameterNamed1<>(
      "--user",
      List.of(),
      new QConstant("The user ID."),
      Optional.empty(),
      UUID.class
    );

  /**
   * Construct a command.
   *
   * @param inClient The client
   */

  public IdAShellCmdUserLoginHistory(
    final IdAClientSynchronousType inClient)
  {
    super(
      inClient,
      new QCommandMetadata(
        "user-login-history",
        new QConstant("Retrieve a user's login history."),
        Optional.empty()
      ),
      IdACommandUserLoginHistory.class,
      IdAResponseUserLoginHistory.class
    );
  }

  @Override
  public List<QParameterNamedType<?>> onListNamedParameters()
  {
    return List.of(USER_ID);
  }

  @Override
  protected IdACommandUserLoginHistory onCreateCommand(
    final QCommandContextType context)
  {
    return new IdACommandUserLoginHistory(context.parameterValue(USER_ID));
  }

  @Override
  protected void onFormatResponse(
    final QCommandContextType context,
    final IdAResponseUserLoginHistory response)
  {
    final var out = context.output();
    out.printf("# %-22s | %-15s | %s%n", "Time", "Host", "User Agent");
    for (final var history : response.history()) {
      out.printf(
        "%-24s |%-16s |%s%n",
        history.time(),
        history.host(),
        history.userAgent()
      );
    }
    out.flush();
  }
}