FileDocCategorySizeDatePackage
CertSelector.javaAPI DocJava SE 5 API1549Fri Aug 26 14:57:16 BST 2005java.security.cert

CertSelector.java

/*
 * @(#)CertSelector.java	1.5 03/12/19
 *
 * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */

package java.security.cert;

/**
 * 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>.
 * <p>
 * <b>Concurrent Access</b>
 * <p>
 * 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
 *
 * @version 	1.5 12/19/03
 * @author	Steve Hanna
 * @since	1.4
 */
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
     */
    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>
     */
    Object clone();
}