VerificationResult.java

Go to the documentation of this file.

package dev.rafex.ether.jwt;
 
/*-
 * #%L
 * ether-jwt
 * %%
 * Copyright (C) 2025 - 2026 Raúl Eduardo González Argote
 * %%
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 * #L%
 */
 
import java.util.Objects;
import java.util.Optional;
 
/** Result returned by token verification. */
public final class VerificationResult {
 
    private final boolean ok;
    private final VerificationCode code;
    private final TokenClaims claims;
 
    private VerificationResult(final boolean ok, final VerificationCode code, final TokenClaims claims) {
        this.ok = ok;
        this.code = Objects.requireNonNull(code, "code");
        this.claims = claims;
    }
 
    public static VerificationResult ok(final TokenClaims claims) {
        return new VerificationResult(true, VerificationCode.OK, Objects.requireNonNull(claims, "claims"));
    }
 
    public static VerificationResult fail(final VerificationCode code) {
        return new VerificationResult(false, code, null);
    }
 
    public boolean ok() {
        return ok;
    }
 
    public VerificationCode verificationCode() {
        return code;
    }
 
    public String code() {
        return code.code();
    }
 
    public Optional<TokenClaims> claims() {
        return Optional.ofNullable(claims);
    }
}