aoqi@0: /* aoqi@0: * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: package com.sun.xml.internal.ws.api.pipe.helper; aoqi@0: aoqi@0: import com.sun.xml.internal.ws.api.pipe.Pipe; aoqi@0: import com.sun.xml.internal.ws.api.pipe.PipeCloner; aoqi@0: import com.sun.xml.internal.ws.api.message.Packet; aoqi@0: aoqi@0: /** aoqi@0: * Default implementation of {@link Pipe} that is used as a filter. aoqi@0: * aoqi@0: *

aoqi@0: * A filter pipe works on a {@link Packet}, then pass it onto the next pipe. aoqi@0: * aoqi@0: * aoqi@0: *

How do I implement a filter?

aoqi@0: *

aoqi@0: * Filter {@link Pipe}s are ideal for those components that wish to aoqi@0: * do some of the followings: aoqi@0: * aoqi@0: *

aoqi@0: *
aoqi@0: * To read an incoming message and perform some work before the aoqi@0: * application (or more precisely the next pipe sees it) aoqi@0: * aoqi@0: *
aoqi@0: * Implement the {@link #process} method and do some processing before aoqi@0: * you pass the packet to the next pipe: aoqi@0: *
aoqi@0:  * process(request) {
aoqi@0:  *   doSomethingWith(request);
aoqi@0:  *   return next.process(request);
aoqi@0:  * }
aoqi@0:  * 
aoqi@0: * aoqi@0: * aoqi@0: *
aoqi@0: * To intercept an incoming message and prevent the next pipe from seeing it. aoqi@0: * aoqi@0: *
aoqi@0: * Implement the {@link #process} method and do some processing, aoqi@0: * then do NOT pass the request onto the next pipe. aoqi@0: *
aoqi@0:  * process(request) {
aoqi@0:  *   if(isSomethingWrongWith(request))
aoqi@0:  *     return createErrorMessage();
aoqi@0:  *   else
aoqi@0:  *     return next.proces(request);
aoqi@0:  * }
aoqi@0:  * 
aoqi@0: * aoqi@0: *
aoqi@0: * To post process a reply and possibly modify a message: aoqi@0: * aoqi@0: *
aoqi@0: * Implement the {@link #process} method and do some processing, aoqi@0: * then do NOT pass the request onto the next pipe. aoqi@0: *
aoqi@0:  * process(request) {
aoqi@0:  *   op = request.getMessage().getOperation();
aoqi@0:  *   reply = next.proces(request);
aoqi@0:  *   if(op is something I care) {
aoqi@0:  *     reply = playWith(reply);
aoqi@0:  *   }
aoqi@0:  *   return reply;
aoqi@0:  * }
aoqi@0:  * 
aoqi@0: * aoqi@0: *
aoqi@0: * aoqi@0: * @author Kohsuke Kawaguchi aoqi@0: */ aoqi@0: public abstract class AbstractFilterPipeImpl extends AbstractPipeImpl { aoqi@0: /** aoqi@0: * Next pipe to call. aoqi@0: */ aoqi@0: protected final Pipe next; aoqi@0: aoqi@0: protected AbstractFilterPipeImpl(Pipe next) { aoqi@0: this.next = next; aoqi@0: assert next!=null; aoqi@0: } aoqi@0: aoqi@0: protected AbstractFilterPipeImpl(AbstractFilterPipeImpl that, PipeCloner cloner) { aoqi@0: super(that, cloner); aoqi@0: this.next = cloner.copy(that.next); aoqi@0: assert next!=null; aoqi@0: } aoqi@0: aoqi@0: public Packet process(Packet packet) { aoqi@0: return next.process(packet); aoqi@0: } aoqi@0: aoqi@0: @Override aoqi@0: public void preDestroy() { aoqi@0: next.preDestroy(); aoqi@0: } aoqi@0: }