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: /*
38: * ClientSequenceFactory.java
39: *
40: *
41: * @author Mike Grogan
42: * Created on January 19, 2007, 10:16 AM
43: *
44: */
45:
46: package com.sun.xml.ws.api.rm.client;
47:
48: import com.sun.xml.ws.api.rm.SequenceSettings;
49: import javax.xml.namespace.QName;
50: import javax.xml.ws.Service;
51: import com.sun.xml.ws.rm.jaxws.runtime.client.RMSource;
52:
53: /**
54: * Factory used by clients who need to provide their own
55: * sequences for use by the RMClient runtime. Typically, the
56: * client application is maintaining its own persistent store
57: * of sent messages and needs to monitor their acknowledgements.
58: */
59: public class ClientSequenceFactory {
60:
61: private ClientSequenceFactory() {
62: }
63:
64: /**
65: * Establishes a new session with the endpoint. The returned (@link ClientSequence}
66: * can be specified for use by one or more client instances connected to the endpoint
67: * by setting it as the value of the <code>com.sun.xml.rm.session</code> property.
68: *
69: * @param service The JAX-WS service representing the service.
70: * @param portName The name of the endpoint.
71: * @return The ClientSequence obtained by sending a RM Protol CreateSequence message
72: * to the endpoint. Returns <code>null</code> if the
73: * sequence creation fails.
74: */
75: public static ClientSequence createSequence(
76: javax.xml.ws.Service service, QName portName) {
77: return RMSource.getRMSource().createSequence(service, portName);
78: }
79:
80: /**
81: * Re-establishes a session using persisted data from an existing session.
82: *
83: * @param service The JAX-WS service representing the service.
84: * @param portName The name of the endpoint.
85: * @return The ClientSequence obtained by sending a RM Protol CreateSequence message
86: * to the endpoint and replacing its state with the state saved
87: * previously from another session with the same endpoint. Returns
88: * <code>null</code> is sequence creation fails.
89: */
90: public static ClientSequence createSequence(
91: javax.xml.ws.Service service, QName portName,
92: SequenceSettings settings) {
93: return RMSource.getRMSource().createSequence(service, portName,
94: settings.sequenceId, settings.companionSequenceId);
95: }
96:
97: }
|