PermissionRequestResultKind.java

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *--------------------------------------------------------------------------------------------*/

package com.github.copilot.sdk.json;

import java.util.Objects;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

/**
 * Describes the outcome kind of a permission request result.
 *
 * <p>
 * This is a string-backed value type that can hold both well-known kinds (via
 * the static constants) and arbitrary extension values forwarded by the server.
 * Comparisons are case-insensitive to match server behaviour.
 *
 * <h2>Well-known kinds</h2>
 * <ul>
 * <li>{@link #APPROVED} — the permission was approved.</li>
 * <li>{@link #DENIED_BY_RULES} — the permission was denied by policy
 * rules.</li>
 * <li>{@link #DENIED_COULD_NOT_REQUEST_FROM_USER} — the permission was denied
 * because no approval rule was found and the user could not be prompted.</li>
 * <li>{@link #DENIED_INTERACTIVELY_BY_USER} — the permission was denied
 * interactively by the user.</li>
 * </ul>
 *
 * @see PermissionRequestResult
 * @since 1.1.0
 */
public final class PermissionRequestResultKind {

    /** The permission was approved. */
    public static final PermissionRequestResultKind APPROVED = new PermissionRequestResultKind("approved");

    /** The permission was denied by policy rules. */
    public static final PermissionRequestResultKind DENIED_BY_RULES = new PermissionRequestResultKind(
            "denied-by-rules");

    /**
     * The permission was denied because no approval rule was found and the user
     * could not be prompted.
     */
    public static final PermissionRequestResultKind DENIED_COULD_NOT_REQUEST_FROM_USER = new PermissionRequestResultKind(
            "denied-no-approval-rule-and-could-not-request-from-user");

    /** The permission was denied interactively by the user. */
    public static final PermissionRequestResultKind DENIED_INTERACTIVELY_BY_USER = new PermissionRequestResultKind(
            "denied-interactively-by-user");

    /**
     * Indicates that the permission request should be left unanswered (no result).
     * <p>
     * When a handler returns this kind, the pending permission request is not
     * responded to, allowing another client (in a multi-client scenario) to handle
     * it.
     * </p>
     *
     * @since 1.0.12
     */
    public static final PermissionRequestResultKind NO_RESULT = new PermissionRequestResultKind("no-result");

    private final String value;

    /**
     * Creates a new {@code PermissionRequestResultKind} with the given string
     * value. Useful for extension kinds not covered by the well-known constants.
     *
     * @param value
     *            the string value; {@code null} is treated as an empty string
     */
    @JsonCreator
    public PermissionRequestResultKind(String value) {
        this.value = value != null ? value : "";
    }

    /**
     * Returns the underlying string value of this kind.
     *
     * @return the string value, never {@code null}
     */
    @JsonValue
    public String getValue() {
        return value;
    }

    @Override
    public String toString() {
        return value;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof PermissionRequestResultKind)) {
            return false;
        }
        PermissionRequestResultKind other = (PermissionRequestResultKind) obj;
        return value.equalsIgnoreCase(other.value);
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(value.toLowerCase(java.util.Locale.ROOT));
    }
}