1 /*

     2  * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 /*

    26  * $Id: KeySelectorResult.java,v 1.3 2005/05/10 15:47:42 mullan Exp $

    27  */

    28 package javax.xml.crypto;

    29 

    30 import java.security.Key;

    31 

    32 /**

    33  * The result returned by the {@link KeySelector#select KeySelector.select}

    34  * method.

    35  * <p>

    36  * At a minimum, a <code>KeySelectorResult</code> contains the <code>Key</code>

    37  * selected by the <code>KeySelector</code>. Implementations of this interface

    38  * may add methods to return implementation or algorithm specific information,

    39  * such as a chain of certificates or debugging information.

    40  *

    41  * @author Sean Mullan

    42  * @author JSR 105 Expert Group

    43  * @since 1.6

    44  * @see KeySelector

    45  */

    46 public interface KeySelectorResult {

    47 

    48     /**

    49      * Returns the selected key.

    50      *

    51      * @return the selected key, or <code>null</code> if none can be found

    52      */

    53     Key getKey();

    54 }