com.authlete.common.dto.TrustAnchor 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.

The newest version!

/*
 * Copyright (C) 2022-2023 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 java.io.Serializable;
import java.net.URI;


/**
 * Trust anchor.
 *
 * @since 3.22
 *
 * @see OpenID Federation 1.0
 */
public class TrustAnchor implements Serializable
{
    private static final long serialVersionUID = 1L;


    /**
     * The entity ID of the trust anchor.
     */
    private URI entityId;


    /**
     * The JWK Set document containing public keys of the trust anchor.
     */
    private String jwks;


    /**
     * Get the entity ID of the trust anchor.
     *
     * @return
     *         The entity ID.
     */
    public URI getEntityId()
    {
        return entityId;
    }


    /**
     * Set the entity ID of the trust anchor.
     *
     * @param entityId
     *         The entity ID.
     *
     * @return
     *         {@code this} object.
     */
    public TrustAnchor setEntityId(URI entityId)
    {
        this.entityId = entityId;

        return this;
    }


    /**
     * Get the JWK Set document containing public keys of the trust anchor.
     *
     * 
     * The keys are used to verify signatures of entity statements issued
     * by the trust anchor.
     * 
     *
     * @return
     *         The JWK Set document containing public keys of the trust anchor.
     *
     * @see RFC 7517 JSON Web Key (JWK)
     */
    public String getJwks()
    {
        return jwks;
    }


    /**
     * Set the JWK Set document containing public keys of the trust anchor.
     *
     * 
     * The keys are used to verify signatures of entity statements issued
     * by the trust anchor.
     * 
     *
     * @param jwks
     *         The JWK Set document containing public keys of the trust anchor.
     *
     * @return
     *         {@code this} object.
     *
     * @see RFC 7517 JSON Web Key (JWK)
     */
    public TrustAnchor setJwks(String jwks)
    {
        this.jwks = jwks;

        return this;
    }
}