1/*
2 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.xml.internal.ws.api.pipe.helper;
27
28import com.sun.istack.internal.NotNull;
29import com.sun.xml.internal.ws.api.message.Packet;
30import com.sun.xml.internal.ws.api.pipe.NextAction;
31import com.sun.xml.internal.ws.api.pipe.Tube;
32import com.sun.xml.internal.ws.api.pipe.TubeCloner;
33
34/**
35 * Convenient default implementation for filtering {@link Tube}.
36 *
37 * <p>
38 * In this prototype, this is not that convenient, but in the real production
39 * code where we have {@code preDestroy()} and {@code clone()}, this
40 * is fairly handy.
41 *
42 * @author Kohsuke Kawaguchi
43 */
44public abstract class AbstractFilterTubeImpl extends AbstractTubeImpl {
45    protected final Tube next;
46
47    protected AbstractFilterTubeImpl(Tube next) {
48        this.next = next;
49    }
50
51    protected AbstractFilterTubeImpl(AbstractFilterTubeImpl that, TubeCloner cloner) {
52        super(that, cloner);
53        if (that.next != null) {
54            this.next = cloner.copy(that.next);
55        } else {
56            this.next = null;
57        }
58    }
59
60    /**
61     * Default no-op implementation.
62     */
63    public @NotNull NextAction processRequest(Packet request) {
64        return doInvoke(next,request);
65    }
66
67    /**
68     * Default no-op implementation.
69     */
70    public @NotNull NextAction processResponse(Packet response) {
71        return doReturnWith(response);
72    }
73
74    /**
75     * Default no-op implementation.
76     */
77    public @NotNull NextAction processException(Throwable t) {
78        return doThrow(t);
79    }
80
81    public void preDestroy() {
82        if (next != null) {
83          next.preDestroy();
84        }
85    }
86}
87