/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.api.pipe.helper;
import com.sun.xml.ws.api.message.Packet;
import com.sun.xml.ws.api.pipe.Fiber;
import com.sun.xml.ws.api.pipe.NextAction;
import com.sun.xml.ws.api.pipe.Pipe;
import com.sun.xml.ws.api.pipe.PipeCloner;
import com.sun.xml.ws.api.pipe.Tube;
import com.sun.xml.ws.api.pipe.TubeCloner;
/**
* Base class for {@link Tube} implementation.
*
* <p>
* This can be also used as a {@link Pipe}, and thus effectively
* making every {@link Tube} usable as a {@link Pipe}.
*
* @author Kohsuke Kawaguchi
*/
public abstract class AbstractTubeImpl implements Tube, Pipe {
/**
* Default constructor.
*/
protected AbstractTubeImpl() {
}
/**
* Copy constructor.
*/
protected AbstractTubeImpl(AbstractTubeImpl that, TubeCloner cloner) {
cloner.add(that,this);
}
protected final NextAction doInvoke(Tube next, Packet packet) {
NextAction na = new NextAction();
na.invoke(next,packet);
return na;
}
protected final NextAction doInvokeAndForget(Tube next, Packet packet) {
NextAction na = new NextAction();
na.invokeAndForget(next,packet);
return na;
}
protected final NextAction doReturnWith(Packet response) {
NextAction na = new NextAction();
na.returnWith(response);
return na;
}
protected final NextAction doThrow(Packet response, Throwable t) {
NextAction na = new NextAction();
na.throwException(response, t);
return na;
}
@Deprecated
protected final NextAction doSuspend() {
NextAction na = new NextAction();
na.suspend();
return na;
}
protected final NextAction doSuspend(Runnable onExitRunnable) {
NextAction na = new NextAction();
na.suspend(onExitRunnable);
return na;
}
@Deprecated
protected final NextAction doSuspend(Tube next) {
NextAction na = new NextAction();
na.suspend(next);
return na;
}
protected final NextAction doSuspend(Tube next, Runnable onExitRunnable) {
NextAction na = new NextAction();
na.suspend(next, onExitRunnable);
return na;
}
protected final NextAction doThrow(Throwable t) {
NextAction na = new NextAction();
na.throwException(t);
return na;
}
/**
* "Dual stack" compatibility mechanism.
* Allows {@link Tube} to be invoked from a {@link Pipe}.
*/
public Packet process(Packet p) {
return Fiber.current().runSync(this,p);
}
/**
* Needs to be implemented by the derived class, but we can't make it abstract
* without upsetting javac.
*/
public final AbstractTubeImpl copy(PipeCloner cloner) {
return copy((TubeCloner)cloner);
}
public abstract AbstractTubeImpl copy(TubeCloner cloner);
}