jakarta.security.auth.message.callback.CertStoreCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jakarta.authentication-api Show documentation

Jakarta Authentication defines a general low-level SPI for authentication mechanisms, which are controllers that interact with a caller and a container's environment to obtain the caller's credentials, validate these, and pass an authenticated identity (such as name and groups) to the container. Jakarta Authentication consists of several profiles, with each profile telling how a specific container (such as Jakarta Servlet) can integrate with- and adapt to this SPI.

There is a newer version: 3.1.0

Show newest version

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates and others.
 * All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.security.auth.message.callback;

import java.security.cert.CertStore;
import javax.security.auth.callback.Callback;

/**
 * Callback for CertStore.
 *
 * 
 * A CertStore is a generic repository for certificates. CertStores may be searched to locate public key certificates,
 * as well as to put together certificate chains. Such a search may be necessary when the caller needs to verify a
 * signature.
 *
 */
public class CertStoreCallback implements Callback {

    private CertStore certStore;

    /**
     * Used by the CallbackHandler to set the CertStore within the Callback.
     *
     * @param certStore The certificate store, which may be null
     */
    public void setCertStore(CertStore certStore) {
        this.certStore = certStore;
    }

    /**
     * Used by the CertStore user to obtain the CertStore set within the Callback.
     *
     * @return The CertStore, or null.
     */
    public CertStore getCertStore() {
        return certStore;
    }
}