KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > transport > local > LocalTransport


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2003 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 "Axis" 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. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55
56 package org.jboss.axis.transport.local;
57
58 import org.jboss.axis.AxisEngine;
59 import org.jboss.axis.MessageContext;
60 import org.jboss.axis.client.Call;
61 import org.jboss.axis.client.Transport;
62 import org.jboss.axis.server.AxisServer;
63
64 /**
65  * A Transport which will cause an invocation via a "local" AxisServer.
66  * <p/>
67  * Serialization will still be tested, as the requests and responses
68  * pass through a String conversion (see LocalSender.java) - this is
69  * primarily for testing and debugging.
70  * <p/>
71  * This transport will either allow the LocalSender to create its own
72  * AxisServer, or if you have one you've configured and wish to use,
73  * you may pass it in to the constructor here.
74  *
75  * @author Rob Jellinghaus (robj@unrealities.com)
76  * @author Doug Davis (dug@us.ibm.com)
77  * @author Glen Daniels (gdaniels@allaire.com)
78  */
79 public class LocalTransport extends Transport
80 {
81    public static final String JavaDoc LOCAL_SERVER = "LocalTransport.AxisServer";
82    public static final String JavaDoc REMOTE_SERVICE = "LocalTransport.RemoteService";
83
84    private AxisServer server;
85
86    /**
87     * The name of a particular remote service to invoke.
88     */
89    private String JavaDoc remoteServiceName;
90
91    /**
92     * No-arg constructor, which will use an AxisServer constructed
93     * by the LocalSender (see LocalSender.java).
94     */
95    public LocalTransport()
96    {
97       transportName = "local";
98    }
99
100    /**
101     * Use this constructor if you have a particular server kicking
102     * around (perhaps which you've already deployed useful stuff into)
103     * which you'd like to use.
104     *
105     * @param server an AxisServer which will bubble down to the LocalSender
106     */
107    public LocalTransport(AxisServer server)
108    {
109       transportName = "local";
110       this.server = server;
111    }
112
113    /**
114     * Use this to indicate a particular "remote" service which should be
115     * invoked on the target AxisServer. This can be used programatically
116     * in place of a service-specific URL.
117     *
118     * @param remoteServiceName the name of the remote service to invoke
119     */
120    public void setRemoteService(String JavaDoc remoteServiceName)
121    {
122       this.remoteServiceName = remoteServiceName;
123    }
124
125    /**
126     * Set up any transport-specific derived properties in the message context.
127     *
128     * @param context the context to set up
129     * @param message the client service instance
130     * @param engine the engine containing the registries
131     */
132    public void setupMessageContextImpl(MessageContext mc,
133                                        Call call,
134                                        AxisEngine engine)
135    {
136       if (server != null)
137          mc.setProperty(LOCAL_SERVER, server);
138       if (remoteServiceName != null)
139          mc.setProperty(REMOTE_SERVICE, remoteServiceName);
140    }
141 }
142
143
Popular Tags