01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.ws.api.security.trust;
38:
39: import java.util.List;
40: import java.util.Map;
41: import javax.security.auth.Subject;
42: import javax.xml.namespace.QName;
43:
44: /**
45: * <p>
46: * This interface is a plugin for attrinute services to a Security Token Service (STS).
47: * An attribute service provides the attributes about a requestor. The attributes are
48: * included in the issued toekn for the requestor using with the target servicce for
49: * authentication and authorization purpose. The usual services mechanism is used to find implementing class
50: * of <code>STSAttributeProvider</code>.
51: * </p>
52: @author Jiandong Guo
53: */
54:
55: public interface STSAttributeProvider {
56: public static final String NAME_IDENTIFIER = "NameID";
57:
58: /**
59: * Returns the map of claimed attributes of the requestor apply to the targeted service.
60: * @param subject The <code>Subject</code> contgaining authentication information and context of the
61: * authenticated requestor.
62: * @param appliesTo Identifying target service(s)
63: * @param tokenType Type of token to be issued which will contain these attributes.
64: * @param cliams Identifying the attributes of the requestor claimed by the target service.
65: * @return map of attribut key and values. The key of the map is a <code>QName</code> contains the key name the the name space
66: * for the key. The value of the map is a <code>List</code> of <code>String</code> contains
67: * a list of the values. One particular value with the requestor
68: * identity to be in the issued token with key name<code>NAME_IDENTIFIER</code> must be in the map.
69: */
70: Map<QName, List<String>> getClaimedAttributes(Subject subject,
71: String appliesTo, String tokenType, Claims claims);
72: }
|