01: /*
02: * $Id: WSTrustClientContract.java,v 1.3 2007/05/29 22:11:29 ofung Exp $
03: */
04:
05: /*
06: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
07: *
08: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
09: *
10: * The contents of this file are subject to the terms of either the GNU
11: * General Public License Version 2 only ("GPL") or the Common Development
12: * and Distribution License("CDDL") (collectively, the "License"). You
13: * may not use this file except in compliance with the License. You can obtain
14: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
15: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
16: * language governing permissions and limitations under the License.
17: *
18: * When distributing the software, include this License Header Notice in each
19: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
20: * Sun designates this particular file as subject to the "Classpath" exception
21: * as provided by Sun in the GPL Version 2 section of the License file that
22: * accompanied this code. If applicable, add the following below the License
23: * Header, with the fields enclosed by brackets [] replaced by your own
24: * identifying information: "Portions Copyrighted [year]
25: * [name of copyright owner]"
26: *
27: * Contributor(s):
28: *
29: * If you wish your version of this file to be governed by only the CDDL or
30: * only the GPL Version 2, indicate your decision by adding "[Contributor]
31: * elects to include this software in this distribution under the [CDDL or GPL
32: * Version 2] license." If you don't indicate a single choice of license, a
33: * recipient has the option to distribute your version of this file under
34: * either the CDDL, the GPL Version 2 or to extend the choice of license to
35: * its licensees as provided above. However, if you add GPL Version 2 code
36: * and therefore, elected the GPL Version 2 license, then the option applies
37: * only if the new code is made subject to such option by the copyright
38: * holder.
39: */
40:
41: package com.sun.xml.ws.security.trust;
42:
43: import com.sun.xml.ws.api.security.trust.WSTrustException;
44: import com.sun.xml.ws.policy.impl.bindings.AppliesTo;
45: import com.sun.xml.ws.security.IssuedTokenContext;
46: import com.sun.xml.ws.security.trust.elements.RequestSecurityToken;
47: import com.sun.xml.ws.security.trust.elements.RequestSecurityTokenResponse;
48:
49: import java.net.URI;
50:
51: /**
52: * The Contract to be used by the Trust-Plugin on the Client Side.
53: * TODO: Need to refine this....
54: * @author root
55: */
56: public interface WSTrustClientContract {
57:
58: /**
59: * Handle an RSTR returned by the Issuer and update Token information into the
60: * IssuedTokenContext.
61: */
62: public void handleRSTR(RequestSecurityToken rst,
63: RequestSecurityTokenResponse rstr,
64: IssuedTokenContext context) throws WSTrustException;
65:
66: /**
67: * Handle an RSTR returned by the Issuer and Respond to the Challenge
68: *
69: */
70: public RequestSecurityTokenResponse handleRSTRForNegotiatedExchange(
71: RequestSecurityToken rst,
72: RequestSecurityTokenResponse rstr,
73: IssuedTokenContext context) throws WSTrustException;
74:
75: /**
76: * Create an RSTR for a client initiated IssuedTokenContext establishment,
77: * for example a Client Initiated WS-SecureConversation context.
78: *
79: */
80: public RequestSecurityTokenResponse createRSTRForClientInitiatedIssuedTokenContext(
81: AppliesTo scopes, IssuedTokenContext context)
82: throws WSTrustException;
83:
84: /**
85: * Contains Challenge
86: * @return true if the RSTR contains a SignChallenge/BinaryExchange or
87: * some other custom challenge recognized by this implementation.
88: */
89: boolean containsChallenge(RequestSecurityTokenResponse rstr);
90:
91: /**
92: * Return the <wst:ComputedKey> URI if any inside the RSTR, null otherwise
93: */
94: URI getComputedKeyAlgorithmFromProofToken(
95: RequestSecurityTokenResponse rstr);
96: }
|