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