CertSelector.java

package org.bouncycastle.jce.cert;

import java.security.cert.Certificate;

/**
 * A selector that defines a set of criteria for selecting
 * <code>Certificate</code>s. Classes that implement this interface
 * are often used to specify which <code>Certificate</code>s should
 * be retrieved from a <code>CertStore</code>.<br />
 * <br />
 * <b>Concurrent Access</b><br />
 * <br />
 * Unless otherwise specified, the methods defined in this interface are not
 * thread-safe. Multiple threads that need to access a single
 * object concurrently should synchronize amongst themselves and
 * provide the necessary locking. Multiple threads each manipulating
 * separate objects need not synchronize.
 *
 * @see Certificate
 * @see CertStore
 * @see CertStore#getCertificates
 */
public interface CertSelector extends Cloneable
{
        /**
     * Decides whether a <code>Certificate</code> should be selected.
     *
     * @param cert the <code>Certificate</code> to be checked
     * @return <code>true</code> if the <code>Certificate</code> 
     * should be selected, <code>false</code> otherwise
     */
    public boolean match(Certificate cert);

    /**
     * Makes a copy of this <code>CertSelector</code>. Changes to the 
     * copy will not affect the original and vice versa.
     *
     * @return a copy of this <code>CertSelector</code>
     */
    public Object clone();
}