001    /**
002     *   GRANITE DATA SERVICES
003     *   Copyright (C) 2006-2013 GRANITE DATA SERVICES S.A.S.
004     *
005     *   This file is part of the Granite Data Services Platform.
006     *
007     *   Granite Data Services is free software; you can redistribute it and/or
008     *   modify it under the terms of the GNU Lesser General Public
009     *   License as published by the Free Software Foundation; either
010     *   version 2.1 of the License, or (at your option) any later version.
011     *
012     *   Granite Data Services is distributed in the hope that it will be useful,
013     *   but WITHOUT ANY WARRANTY; without even the implied warranty of
014     *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
015     *   General Public License for more details.
016     *
017     *   You should have received a copy of the GNU Lesser General Public
018     *   License along with this library; if not, write to the Free Software
019     *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
020     *   USA, or see <http://www.gnu.org/licenses/>.
021     */
022    package org.granite.gravity.weblogic;
023    
024    import java.io.IOException;
025    
026    import javax.servlet.ServletConfig;
027    import javax.servlet.ServletException;
028    import javax.servlet.http.HttpServletRequest;
029    import javax.servlet.http.HttpServletResponse;
030    
031    import org.granite.gravity.AbstractGravityServlet;
032    import org.granite.gravity.AsyncHttpContext;
033    import org.granite.gravity.Gravity;
034    import org.granite.gravity.GravityManager;
035    import org.granite.gravity.GravityServletUtil;
036    import org.granite.logging.Logger;
037    import org.granite.util.ServletParams;
038    
039    import weblogic.servlet.http.AbstractAsyncServlet;
040    import weblogic.servlet.http.RequestResponseKey;
041    import flex.messaging.messages.CommandMessage;
042    import flex.messaging.messages.Message;
043    
044    /**
045     * Asynchronous servlet support for WebLogic 9.1+ servers.
046     * <br /><br />
047     * Usage:
048     * <pre>
049     * &lt;servlet&gt;
050     *     &lt;servlet-name&gt;GravityServlet&lt;/servlet-name&gt;
051     *     &lt;servlet-class&gt;org.granite.gravity.weblogic.GravityWebLogicServlet&lt;/servlet-class&gt;
052     *     
053     *     (optional parameter, default is 40,000 milliseconds)
054     *     &lt;init-param&gt;
055     *         &lt;param-name&gt;scavangeInterval&lt;/param-name&gt;
056     *         &lt;param-value&gt;40000&lt;/param-value&gt;
057     *     &lt;/init-param&gt;
058     *     
059     * &lt;/servlet&gt;
060     * </pre>
061     * 
062     * @author Franck WOLFF
063     */
064    public class GravityWebLogicServlet extends AbstractAsyncServlet {
065    
066            private static final long serialVersionUID = 1L;
067            
068            private static final Logger log = Logger.getLogger(GravityWebLogicServlet.class);
069    
070            private static final String SCAVANGE_INTERVAL = "scavangeInterval";
071    
072            @Override
073            public void init(ServletConfig config) throws ServletException {
074                    super.init(config);
075                    
076                    GravityServletUtil.init(config);
077                    
078                    int scavangeInterval = ServletParams.get(
079                            config,
080                            SCAVANGE_INTERVAL,
081                            Integer.TYPE,
082                            AbstractAsyncServlet.DEFAULT_SCAVANGE_INTERVAL
083                    );
084                    
085                    log.info("Using scavange interval of: %s", scavangeInterval);
086                    AbstractAsyncServlet.setScavangeInterval(scavangeInterval);
087            }
088    
089            @Override
090            protected boolean doRequest(RequestResponseKey key) throws IOException, ServletException {
091    
092                    HttpServletRequest request = key.getRequest();
093                    HttpServletResponse response = key.getResponse();
094    
095            GravityServletUtil.rejectJMFContentType(request);
096    
097            Gravity gravity = GravityManager.getGravity(getServletContext());
098            WebLogicChannelFactory channelFactory = new WebLogicChannelFactory(gravity);
099    
100            try {
101                GravityServletUtil.initializeRequest(getServletConfig(), gravity, request, response);
102    
103                Message[] amf3Requests = GravityServletUtil.deserialize(gravity, request);
104    
105                log.debug(">> [AMF3 REQUESTS] %s", (Object)amf3Requests);
106    
107                Message[] amf3Responses = null;
108                
109                boolean accessed = false;
110                for (int i = 0; i < amf3Requests.length; i++) {
111                    Message amf3Request = amf3Requests[i];
112    
113                    // Ask gravity to create a specific response (will be null for connect request from tunnel).
114                    Message amf3Response = gravity.handleMessage(channelFactory, amf3Request);
115                    String channelId = (String)amf3Request.getClientId();
116                    
117                    // Mark current channel (if any) as accessed.
118                    if (!accessed)
119                            accessed = gravity.access(channelId);
120                    
121                    // (Re)Connect message from tunnel...
122                    if (amf3Response == null) {
123                        if (amf3Requests.length > 1)
124                            throw new IllegalArgumentException("Only one connect request is allowed on tunnel.");
125    
126                        WebLogicChannel channel = gravity.getChannel(channelFactory, channelId);
127                        if (channel == null)
128                                    throw new NullPointerException("No channel on tunnel connect");
129                        
130                        // Try to send pending messages if any (using current container thread).
131                        if (channel.runReceived(new AsyncHttpContext(request, response, amf3Request)))
132                            return false;
133    
134                        // No pending messages, wait for new ones or timeout.
135                            GravityServletUtil.setConnectMessage(request, amf3Request);
136                            key.setTimeout((int)GravityServletUtil.getLongPollingTimeout(getServletContext()));
137                            channel.setRequestResponseKey(key);
138                            return true;
139                    }
140    
141                    if (amf3Responses == null)
142                            amf3Responses = new Message[amf3Requests.length];
143                    amf3Responses[i] = amf3Response;
144                }
145    
146                log.debug("<< [AMF3 RESPONSES] %s", (Object)amf3Responses);
147    
148                GravityServletUtil.serialize(gravity, response, amf3Responses);
149            }
150            catch (IOException e) {
151                log.error(e, "Gravity message error");
152                throw e;
153            }
154            catch (Exception e) {
155                log.error(e, "Gravity message error");
156                throw new ServletException(e);
157            }
158            finally {
159                    GravityServletUtil.cleanupRequest(request);
160            }
161                    return false;
162            }
163    
164            @Override
165            protected void doResponse(RequestResponseKey key, Object context) throws IOException, ServletException {
166                    WebLogicChannel channel = (WebLogicChannel)context;
167            HttpServletRequest request = key.getRequest();
168            HttpServletResponse response = key.getResponse();
169            Message requestMessage = AbstractGravityServlet.getConnectMessage(request);
170                    
171                    channel.runReceived(new AsyncHttpContext(request, response, requestMessage));
172            }
173    
174            @Override
175            protected void doTimeout(RequestResponseKey key) throws IOException, ServletException {
176                    Gravity gravity = GravityManager.getGravity(getServletContext());
177                    WebLogicChannelFactory channelFactory = new WebLogicChannelFactory(gravity);
178                    
179                    CommandMessage amf3Request = GravityServletUtil.getConnectMessage(key.getRequest());
180                    String channelId = (String)amf3Request.getClientId();
181                    WebLogicChannel channel = gravity.getChannel(channelFactory, channelId);
182                    channel.setRequestResponseKey(null);
183            }
184    }