src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/helper/AbstractFilterPipeImpl.java

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api.pipe.helper;
ohair@286 27
ohair@286 28 import com.sun.xml.internal.ws.api.pipe.Pipe;
ohair@286 29 import com.sun.xml.internal.ws.api.pipe.PipeCloner;
ohair@286 30 import com.sun.xml.internal.ws.api.message.Packet;
ohair@286 31
ohair@286 32 /**
ohair@286 33 * Default implementation of {@link Pipe} that is used as a filter.
ohair@286 34 *
ohair@286 35 * <p>
ohair@286 36 * A filter pipe works on a {@link Packet}, then pass it onto the next pipe.
ohair@286 37 *
ohair@286 38 *
ohair@286 39 * <h2>How do I implement a filter?</h2>
ohair@286 40 * <p>
ohair@286 41 * Filter {@link Pipe}s are ideal for those components that wish to
ohair@286 42 * do some of the followings:
ohair@286 43 *
ohair@286 44 * <dl>
ohair@286 45 * <dt><b>
ohair@286 46 * To read an incoming message and perform some work before the
ohair@286 47 * application (or more precisely the next pipe sees it)
ohair@286 48 * </b>
ohair@286 49 * <dd>
ohair@286 50 * Implement the {@link #process} method and do some processing before
ohair@286 51 * you pass the packet to the next pipe:
ohair@286 52 * <pre>
ohair@286 53 * process(request) {
ohair@286 54 * doSomethingWith(request);
ohair@286 55 * return next.process(request);
ohair@286 56 * }
ohair@286 57 * </pre>
ohair@286 58 *
ohair@286 59 *
ohair@286 60 * <dt><b>
ohair@286 61 * To intercept an incoming message and prevent the next pipe from seeing it.
ohair@286 62 * </b>
ohair@286 63 * <dd>
ohair@286 64 * Implement the {@link #process} method and do some processing,
ohair@286 65 * then do NOT pass the request onto the next pipe.
ohair@286 66 * <pre>
ohair@286 67 * process(request) {
ohair@286 68 * if(isSomethingWrongWith(request))
ohair@286 69 * return createErrorMessage();
ohair@286 70 * else
ohair@286 71 * return next.proces(request);
ohair@286 72 * }
ohair@286 73 * </pre>
ohair@286 74 *
ohair@286 75 * <dt><b>
ohair@286 76 * To post process a reply and possibly modify a message:
ohair@286 77 * </b>
ohair@286 78 * <dd>
ohair@286 79 * Implement the {@link #process} method and do some processing,
ohair@286 80 * then do NOT pass the request onto the next pipe.
ohair@286 81 * <pre>
ohair@286 82 * process(request) {
ohair@286 83 * op = request.getMessage().getOperation();
ohair@286 84 * reply = next.proces(request);
ohair@286 85 * if(op is something I care) {
ohair@286 86 * reply = playWith(reply);
ohair@286 87 * }
ohair@286 88 * return reply;
ohair@286 89 * }
ohair@286 90 * </pre>
ohair@286 91 *
ohair@286 92 * </dl>
ohair@286 93 *
ohair@286 94 * @author Kohsuke Kawaguchi
ohair@286 95 */
ohair@286 96 public abstract class AbstractFilterPipeImpl extends AbstractPipeImpl {
ohair@286 97 /**
ohair@286 98 * Next pipe to call.
ohair@286 99 */
ohair@286 100 protected final Pipe next;
ohair@286 101
ohair@286 102 protected AbstractFilterPipeImpl(Pipe next) {
ohair@286 103 this.next = next;
ohair@286 104 assert next!=null;
ohair@286 105 }
ohair@286 106
ohair@286 107 protected AbstractFilterPipeImpl(AbstractFilterPipeImpl that, PipeCloner cloner) {
ohair@286 108 super(that, cloner);
ohair@286 109 this.next = cloner.copy(that.next);
ohair@286 110 assert next!=null;
ohair@286 111 }
ohair@286 112
ohair@286 113 public Packet process(Packet packet) {
ohair@286 114 return next.process(packet);
ohair@286 115 }
ohair@286 116
ohair@286 117 @Override
ohair@286 118 public void preDestroy() {
ohair@286 119 next.preDestroy();
ohair@286 120 }
ohair@286 121 }

mercurial