com.authlete.common.dto.ClaimRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of authlete-java-common Show documentation

Authlete Java library used commonly by service implementations and the Authlete server.

There is a newer version: 4.15

/*
 * Copyright (C) 2019 Authlete, Inc.
 *
 * 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 com.authlete.common.dto;


import com.authlete.common.types.ClaimRuleOperation;


/**
 * A rule for processing a claim.
 *
 * @since 2.39
 */
public class ClaimRule
{
    private ClaimRuleOperation operation;
    private String claimName;
    private String comparisonValue;


    /**
     * Get the operation that this rule will apply to any claims it processes.
     *
     * @return
     *         The operation.
     *
     * @since 2.39
     */
    public ClaimRuleOperation getOperation()
    {
        return operation;
    }


    /**
     * Set the operation that this rule will apply to any claims it processes.
     *
     * @param operation
     *         The operation.
     *
     * @return
     *         {@code this} object.
     *
     * @since 2.39
     */
    public ClaimRule setOperation(ClaimRuleOperation operation)
    {
        this.operation = operation;

        return this;
    }


    /**
     * Get the name of the claim that this rule applies to.
     *
     * @return
     *         The claim name.
     *
     * @since 2.39
     */
    public String getClaimName()
    {
        return claimName;
    }


    /**
     * Set the name of the claim that this rule applies to.
     *
     * @param claimName
     *         The claim name.
     *
     * @return
     *         {@code this} object.
     *
     * @since 2.39
     */
    public ClaimRule setClaimName(String claimName)
    {
        this.claimName = claimName;

        return this;
    }


    /**
     * Get the value to compare the claim value to, if the operation is {@link
     * ClaimRuleOperation#EQUALS EQUALS}. Values are compared based on their
     * serialization as strings.
     *
     * @return
     *         The comparison value, as a string.
     *
     * @since 2.39
     */
    public String getComparisonValue()
    {
        return comparisonValue;
    }


    /**
     * Set the value to compare the claim value to, if the operation is {@link
     * ClaimRuleOperation#EQUALS EQUALS}. Values are compared based on their
     * serialization as strings.
     *
     * @param comparisonValue
     *         The comparison value, as a string.
     *
     * @return
     *         {@code this} object.
     *
     * @since 2.39
     */
    public ClaimRule setComparisonValue(String comparisonValue)
    {
        this.comparisonValue = comparisonValue;

        return this;
    }
}