io.nats.jwt.UserClaim Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jwt-java Show documentation
Java NATS.io server runner.
The newest version!
// Copyright 2021-2024 The NATS Authors
// 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.nats.jwt;

import io.nats.json.JsonValue;
import io.nats.json.JsonValueUtils;
import io.nats.json.JsonWriteUtils;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;

import static io.nats.json.JsonWriteUtils.beginJson;
import static io.nats.json.JsonWriteUtils.endJson;
import static io.nats.jwt.JwtUtils.NO_LIMIT;
import static io.nats.jwt.JwtUtils.USER_CLAIM_TYPE;

public class UserClaim extends GenericClaimFields {
    public String issuerAccount;            // User
    public Permission pub;                  // User/UserPermissionLimits/Permissions
    public Permission sub;                  // User/UserPermissionLimits/Permissions
    public ResponsePermission resp;         // User/UserPermissionLimits/Permissions
    public List src;                // User/UserPermissionLimits/Limits/UserLimits
    public List timeRanges;      // User/UserPermissionLimits/Limits/UserLimits
    public String locale;                   // User/UserPermissionLimits/Limits/UserLimits
    public long subs = NO_LIMIT;            // User/UserPermissionLimits/Limits/NatsLimits
    public long data = NO_LIMIT;            // User/UserPermissionLimits/Limits/NatsLimits
    public long payload = NO_LIMIT;         // User/UserPermissionLimits/Limits/NatsLimits
    public boolean bearerToken;             // User/UserPermissionLimits
    public List allowedConnectionTypes; // User/UserPermissionLimits

    public UserClaim() {
        super(USER_CLAIM_TYPE, 2);
    }

    public UserClaim(String issuerAccount) {
        super(USER_CLAIM_TYPE, 2);
        this.issuerAccount = issuerAccount;
    }

    public UserClaim(JsonValue jv) {
        super(jv, USER_CLAIM_TYPE, 2);
        issuerAccount = JsonValueUtils.readString(jv, "issuer_account");
        pub = Permission.optionalInstance(JsonValueUtils.readValue(jv, "pub"));
        sub = Permission.optionalInstance(JsonValueUtils.readValue(jv, "sub"));
        resp = ResponsePermission.optionalInstance(JsonValueUtils.readValue(jv, "resp"));
        src = JsonValueUtils.readOptionalStringList(jv, "src");
        timeRanges = TimeRange.optionalListOf(JsonValueUtils.readValue(jv, "times"));
        locale = JsonValueUtils.readString(jv, "times_location");
        subs = JsonValueUtils.readLong(jv, "subs", NO_LIMIT);
        data = JsonValueUtils.readLong(jv, "data", NO_LIMIT);
        payload = JsonValueUtils.readLong(jv, "payload", NO_LIMIT);
        bearerToken = JsonValueUtils.readBoolean(jv, "bearer_token");
        allowedConnectionTypes = JsonValueUtils.readOptionalStringList(jv, "allowed_connection_types");
    }

    @Override
    protected UserClaim getThis() {
        return this;
    }

    @Override
    public String toJson() {
        StringBuilder sb = beginJson();
        JsonWriteUtils.addField(sb, "issuer_account", issuerAccount);
        baseJson(sb);
        JsonWriteUtils.addField(sb, "pub", pub);
        JsonWriteUtils.addField(sb, "sub", sub);
        JsonWriteUtils.addField(sb, "resp", resp);
        JsonWriteUtils.addStrings(sb, "src", src);
        JsonWriteUtils.addJsons(sb, "times", timeRanges);
        JsonWriteUtils.addField(sb, "times_location", locale);
        JsonWriteUtils.addFieldWhenGteMinusOne(sb, "subs", subs);
        JsonWriteUtils.addFieldWhenGteMinusOne(sb, "data", data);
        JsonWriteUtils.addFieldWhenGteMinusOne(sb, "payload", payload);
        JsonWriteUtils.addFldWhenTrue(sb, "bearer_token", bearerToken);
        JsonWriteUtils.addStrings(sb, "allowed_connection_types", allowedConnectionTypes);
        return endJson(sb).toString();
    }

    public UserClaim issuerAccount(String issuerAccount) {
        this.issuerAccount = issuerAccount;
        return this;
    }

    public UserClaim pub(Permission pub) {
        this.pub = pub;
        return this;
    }

    public UserClaim sub(Permission sub) {
        this.sub = sub;
        return this;
    }

    public UserClaim resp(ResponsePermission resp) {
        this.resp = resp;
        return this;
    }

    public UserClaim src(String... src) {
        this.src = new ArrayList<>(Arrays.asList(src));
        return this;
    }

    public UserClaim src(List src) {
        this.src = src;
        return this;
    }

    public UserClaim timeRanges(List times) {
        this.timeRanges = times;
        return this;
    }

    public UserClaim locale(String locale) {
        this.locale = locale;
        return this;
    }

    public UserClaim subs(long subs) {
        this.subs = subs;
        return this;
    }

    public UserClaim data(long data) {
        this.data = data;
        return this;
    }

    public UserClaim payload(long payload) {
        this.payload = payload;
        return this;
    }

    public UserClaim bearerToken(boolean bearerToken) {
        this.bearerToken = bearerToken;
        return this;
    }

    public UserClaim allowedConnectionTypes(String... allowedConnectionTypes) {
        this.allowedConnectionTypes = Arrays.asList(allowedConnectionTypes);
        return this;
    }

    public UserClaim allowedConnectionTypes(List allowedConnectionTypes) {
        this.allowedConnectionTypes = allowedConnectionTypes;
        return this;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        if (!super.equals(o)) return false;

        UserClaim userClaim = (UserClaim) o;

        if (subs != userClaim.subs) return false;
        if (data != userClaim.data) return false;
        if (payload != userClaim.payload) return false;
        if (bearerToken != userClaim.bearerToken) return false;
        if (!Objects.equals(issuerAccount, userClaim.issuerAccount))
            return false;
        if (!Objects.equals(pub, userClaim.pub)) return false;
        if (!Objects.equals(sub, userClaim.sub)) return false;
        if (!Objects.equals(resp, userClaim.resp)) return false;
        if (!Objects.equals(src, userClaim.src)) return false;
        if (!Objects.equals(timeRanges, userClaim.timeRanges)) return false;
        if (!Objects.equals(locale, userClaim.locale)) return false;
        return Objects.equals(allowedConnectionTypes, userClaim.allowedConnectionTypes);
    }

    @Override
    public int hashCode() {
        int result = super.hashCode();
        result = 31 * result + (issuerAccount != null ? issuerAccount.hashCode() : 0);
        result = 31 * result + (pub != null ? pub.hashCode() : 0);
        result = 31 * result + (sub != null ? sub.hashCode() : 0);
        result = 31 * result + (resp != null ? resp.hashCode() : 0);
        result = 31 * result + (src != null ? src.hashCode() : 0);
        result = 31 * result + (timeRanges != null ? timeRanges.hashCode() : 0);
        result = 31 * result + (locale != null ? locale.hashCode() : 0);
        result = 31 * result + (int) (subs ^ (subs >>> 32));
        result = 31 * result + (int) (data ^ (data >>> 32));
        result = 31 * result + (int) (payload ^ (payload >>> 32));
        result = 31 * result + (bearerToken ? 1 : 0);
        result = 31 * result + (allowedConnectionTypes != null ? allowedConnectionTypes.hashCode() : 0);
        return result;
    }
}