/*
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.xml.internal.ws.api.server;
import com.sun.xml.internal.ws.api.pipe.Codec;
import com.sun.xml.internal.ws.api.message.Packet;
import com.sun.xml.internal.ws.api.WSBinding;
import com.sun.xml.internal.ws.api.server.WSEndpoint.PipeHead;
import com.sun.xml.internal.ws.util.Pool;
/**
* Receives incoming messages from a transport (such as HTTP, JMS, etc)
* in a transport specific way, and delivers it to {@link WSEndpoint.PipeHead#process}.
*
* <p>
* Since this class mostly concerns itself with converting a
* transport-specific message representation to a {@link Packet},
* the name is the "adapter".
*
* <p>
* The purpose of this class is twofolds:
*
* <ol>
* <li>
* To hide the logic of converting a transport-specific connection
* to a {@link Packet} and do the other way around.
*
* <li>
* To manage thread-unsafe resources, such as {@link WSEndpoint.PipeHead},
* and {@link Codec}.
* </ol>
*
* <p>
* {@link Adapter}s are extended to work with each kind of transport,
* and therefore {@link Adapter} class itself is not all that
* useful by itself --- it merely provides a design template
* that can be followed.
*
* <p>
* For managing resources, an adapter uses an object called {@link Toolkit}
* (think of it as a tray full of tools that a dentist uses ---
* trays are identical, but each patient has to get one. You have
* a pool of them and you assign it to a patient.)
*
* {@link Adapter.Toolkit} can be extended by derived classes.
* That actual type is the {@code TK} type parameter this class takes.
*
* @author Kohsuke Kawaguchi
*/
public abstract class Adapter<TK extends Adapter.Toolkit> {
protected final WSEndpoint<?> endpoint;
/**
* Object that groups all thread-unsafe resources.
*/
public class Toolkit {
/**
* For encoding/decoding infoset to/from the byte stream.
*/
public final Codec codec;
/**
* This object from {@link WSEndpoint} serves the request.
*/
public final PipeHead head;
public Toolkit() {
this.codec = endpoint.createCodec();
this.head = endpoint.createPipeHead();
}
}
/**
* Pool of {@link Toolkit}s.
*/
protected final Pool<TK> pool = new Pool<TK>() {
protected TK create() {
return createToolkit();
}
};
/**
* Creates an {@link Adapter} that delivers
* messages to the given endpoint.
*/
protected Adapter(WSEndpoint endpoint) {
assert endpoint!=null;
this.endpoint = endpoint;
}
/**
* Gets the endpoint that this {@link Adapter} is serving.
*
* @return
* always non-null.
*/
public WSEndpoint<?> getEndpoint() {
return endpoint;
}
/**
* Creates a {@link Toolkit} instance.
*
* <p>
* If the derived class doesn't have to add any per-thread state
* to {@link Toolkit}, simply implement this as {@code new Toolkit()}.
*/
protected abstract TK createToolkit();
}