KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > wsif > WSIFInterceptor


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2002 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "WSIF" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 2001, 2002, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package org.apache.wsif;
59
60 /**
61  * An interceptor gets the opportunity to pre- or post-process
62  * a service request or response, respectively, that's travelling
63  * through the WSIF. The interceptor also gets the opportunity
64  * to inform WSIF that the service is to be denied; i.e., that
65  * the service request (or response) should not be processed
66  * further.
67  *
68  * @author Sanjiva Weerawarana <sanjiva@watson.ibm.com>
69  * @author Paul Fremantle <pzf@uk.ibm.com>
70  */
71 public interface WSIFInterceptor {
72     /**
73      * Initialize the interceptor.
74      */
75     public void init(WSIFInterceptorConfig ic);
76
77     /**
78      * This method is invoked to allow the interceptor to process the
79      * incoming request. If the request should not be processed further,
80      * then this method should return false. The response object is also
81      * made available in case the interceptor wishes to manipulate that too.
82      *
83      * @param request the incoming service request
84      * @param response the outgoing service response
85      * @return true or false, indicating whether the request should continue
86      * to be processed or not.
87      * @exception WSIFException if something unexpected happens.
88      */
89     public boolean interceptIncoming(WSIFRequest request, WSIFResponse response)
90         throws WSIFException;
91
92     /**
93      * This method is invoked to allow the interceptor to process the
94      * outgoing response. If the response should not be processed further,
95      * then this method should return false.
96      *
97      * @param request the incoming service request
98      * @param response the outgoing service response
99      * @return true or false, indicating whether the response should continue
100      * to be processed or not.
101      * @exception WSIFException if something unexpected happens.
102      */
103     public boolean interceptOutgoing(WSIFRequest request, WSIFResponse response)
104         throws WSIFException;
105
106     /**
107      * Destroy this interceptor.
108      */
109     public void destroy();
110 }
111
Popular Tags