001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.ws.api.server;
038:
039: import com.sun.xml.ws.api.pipe.Codec;
040: import com.sun.xml.ws.api.message.Packet;
041: import com.sun.xml.ws.api.WSBinding;
042: import com.sun.xml.ws.api.server.WSEndpoint.PipeHead;
043: import com.sun.xml.ws.util.Pool;
044:
045: /**
046: * Receives incoming messages from a transport (such as HTTP, JMS, etc)
047: * in a transport specific way, and delivers it to {@link WSEndpoint.PipeHead#process}.
048: *
049: * <p>
050: * Since this class mostly concerns itself with converting a
051: * transport-specific message representation to a {@link Packet},
052: * the name is the "adapter".
053: *
054: * <p>
055: * The purpose of this class is twofolds:
056: *
057: * <ol>
058: * <li>
059: * To hide the logic of converting a transport-specific connection
060: * to a {@link Packet} and do the other way around.
061: *
062: * <li>
063: * To manage thread-unsafe resources, such as {@link WSEndpoint.PipeHead},
064: * and {@link Codec}.
065: * </ol>
066: *
067: * <p>
068: * {@link Adapter}s are extended to work with each kind of transport,
069: * and therefore {@link Adapter} class itself is not all that
070: * useful by itself --- it merely provides a design template
071: * that can be followed.
072: *
073: * <p>
074: * For managing resources, an adapter uses an object called {@link Toolkit}
075: * (think of it as a tray full of tools that a dentist uses ---
076: * trays are identical, but each patient has to get one. You have
077: * a pool of them and you assign it to a patient.)
078: *
079: * {@link Adapter.Toolkit} can be extended by derived classes.
080: * That actual type is the {@code TK} type parameter this class takes.
081: *
082: * @author Kohsuke Kawaguchi
083: */
084: public abstract class Adapter<TK extends Adapter.Toolkit> {
085:
086: protected final WSEndpoint<?> endpoint;
087:
088: /**
089: * Object that groups all thread-unsafe resources.
090: */
091: public class Toolkit {
092: /**
093: * For encoding/decoding infoset to/from the byte stream.
094: */
095: public final Codec codec;
096: /**
097: * This object from {@link WSEndpoint} serves the request.
098: */
099: public final PipeHead head;
100:
101: public Toolkit() {
102: this .codec = endpoint.createCodec();
103: this .head = endpoint.createPipeHead();
104: }
105: }
106:
107: /**
108: * Pool of {@link Toolkit}s.
109: */
110: protected final Pool<TK> pool = new Pool<TK>() {
111: protected TK create() {
112: return createToolkit();
113: }
114: };
115:
116: /**
117: * Creates an {@link Adapter} that delivers
118: * messages to the given endpoint.
119: */
120: protected Adapter(WSEndpoint endpoint) {
121: assert endpoint != null;
122: this .endpoint = endpoint;
123: }
124:
125: /**
126: * Gets the endpoint that this {@link Adapter} is serving.
127: *
128: * @return
129: * always non-null.
130: */
131: public WSEndpoint<?> getEndpoint() {
132: return endpoint;
133: }
134:
135: /**
136: * Creates a {@link Toolkit} instance.
137: *
138: * <p>
139: * If the derived class doesn't have to add any per-thread state
140: * to {@link Toolkit}, simply implement this as {@code new Toolkit()}.
141: */
142: protected abstract TK createToolkit();
143: }
|