1/*
2 * Copyright (c) 2012, 2013, 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
26package com.sun.security.jgss;
27
28import org.ietf.jgss.*;
29
30/**
31 * The extended GSSCredential interface for supporting additional
32 * functionalities not defined by {@code org.ietf.jgss.GSSCredential}.
33 * @since 1.8
34 */
35public interface ExtendedGSSCredential extends GSSCredential {
36
37    /**
38     * Impersonates a principal. In Kerberos, this can be implemented
39     * using the Microsoft S4U2self extension.
40     * <p>
41     * A {@link GSSException#NO_CRED GSSException.NO_CRED} will be thrown if the
42     * impersonation fails. A {@link GSSException#FAILURE GSSException.FAILURE}
43     * will be  thrown if the impersonation method is not available to this
44     * credential object.
45     * @param name the name of the principal to impersonate
46     * @return a credential for that principal
47     * @throws GSSException  containing the following
48     * major error codes:
49     *   {@link GSSException#NO_CRED GSSException.NO_CRED}
50     *   {@link GSSException#FAILURE GSSException.FAILURE}
51     */
52    public GSSCredential impersonate(GSSName name) throws GSSException;
53}
54