KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > xml > crypto > KeySelectorResult


1 /*
2  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
3  */
4 /*
5  * $Id: KeySelectorResult.java,v 1.3 2005/05/10 15:47:42 mullan Exp $
6  */
7 package javax.xml.crypto;
8
9 import java.security.Key JavaDoc;
10
11 /**
12  * The result returned by the {@link KeySelector#select KeySelector.select}
13  * method.
14  * <p>
15  * At a minimum, a <code>KeySelectorResult</code> contains the <code>Key</code>
16  * selected by the <code>KeySelector</code>. Implementations of this interface
17  * may add methods to return implementation or algorithm specific information,
18  * such as a chain of certificates or debugging information.
19  *
20  * @author Sean Mullan
21  * @author JSR 105 Expert Group
22  * @since 1.6
23  * @see KeySelector
24  */
25 public interface KeySelectorResult {
26
27     /**
28      * Returns the selected key.
29      *
30      * @return the selected key, or <code>null</code> if none can be found
31      */
32     Key JavaDoc getKey();
33 }
34
Popular Tags