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 */
022package org.granite.gravity.weblogic;
023
024import java.io.IOException;
025
026import javax.servlet.ServletConfig;
027import javax.servlet.ServletException;
028import javax.servlet.http.HttpServletRequest;
029import javax.servlet.http.HttpServletResponse;
030
031import org.granite.gravity.AbstractGravityServlet;
032import org.granite.gravity.AsyncHttpContext;
033import org.granite.gravity.Gravity;
034import org.granite.gravity.GravityManager;
035import org.granite.gravity.GravityServletUtil;
036import org.granite.logging.Logger;
037import org.granite.util.ServletParams;
038
039import weblogic.servlet.http.AbstractAsyncServlet;
040import weblogic.servlet.http.RequestResponseKey;
041import flex.messaging.messages.CommandMessage;
042import 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 */
064public 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                Gravity gravity = GravityManager.getGravity(getServletContext());
092                WebLogicChannelFactory channelFactory = new WebLogicChannelFactory(gravity);
093        
094                HttpServletRequest request = key.getRequest();
095                HttpServletResponse response = key.getResponse();
096                
097                try {
098            GravityServletUtil.initializeRequest(getServletConfig(), gravity, request, response);
099
100            Message[] amf3Requests = GravityServletUtil.deserialize(gravity, request);
101
102            log.debug(">> [AMF3 REQUESTS] %s", (Object)amf3Requests);
103
104            Message[] amf3Responses = null;
105            
106            boolean accessed = false;
107            for (int i = 0; i < amf3Requests.length; i++) {
108                Message amf3Request = amf3Requests[i];
109
110                // Ask gravity to create a specific response (will be null for connect request from tunnel).
111                Message amf3Response = gravity.handleMessage(channelFactory, amf3Request);
112                String channelId = (String)amf3Request.getClientId();
113                
114                // Mark current channel (if any) as accessed.
115                if (!accessed)
116                        accessed = gravity.access(channelId);
117                
118                // (Re)Connect message from tunnel...
119                if (amf3Response == null) {
120                    if (amf3Requests.length > 1)
121                        throw new IllegalArgumentException("Only one connect request is allowed on tunnel.");
122
123                    WebLogicChannel channel = gravity.getChannel(channelFactory, channelId);
124                    if (channel == null)
125                                throw new NullPointerException("No channel on tunnel connect");
126                    
127                    // Try to send pending messages if any (using current container thread).
128                    if (channel.runReceived(new AsyncHttpContext(request, response, amf3Request)))
129                        return false;
130
131                    // No pending messages, wait for new ones or timeout.
132                        GravityServletUtil.setConnectMessage(request, amf3Request);
133                        key.setTimeout((int)GravityServletUtil.getLongPollingTimeout(getServletContext()));
134                        channel.setRequestResponseKey(key);
135                        return true;
136                }
137
138                if (amf3Responses == null)
139                        amf3Responses = new Message[amf3Requests.length];
140                amf3Responses[i] = amf3Response;
141            }
142
143            log.debug("<< [AMF3 RESPONSES] %s", (Object)amf3Responses);
144
145            GravityServletUtil.serialize(gravity, response, amf3Responses);
146        }
147        catch (IOException e) {
148            log.error(e, "Gravity message error");
149            throw e;
150        }
151        catch (Exception e) {
152            log.error(e, "Gravity message error");
153            throw new ServletException(e);
154        }
155        finally {
156                GravityServletUtil.cleanupRequest(request);
157        }
158                return false;
159        }
160
161        @Override
162        protected void doResponse(RequestResponseKey key, Object context) throws IOException, ServletException {
163                WebLogicChannel channel = (WebLogicChannel)context;
164        HttpServletRequest request = key.getRequest();
165        HttpServletResponse response = key.getResponse();
166        Message requestMessage = AbstractGravityServlet.getConnectMessage(request);
167                
168                channel.runReceived(new AsyncHttpContext(request, response, requestMessage));
169        }
170
171        @Override
172        protected void doTimeout(RequestResponseKey key) throws IOException, ServletException {
173                Gravity gravity = GravityManager.getGravity(getServletContext());
174                WebLogicChannelFactory channelFactory = new WebLogicChannelFactory(gravity);
175                
176                CommandMessage amf3Request = GravityServletUtil.getConnectMessage(key.getRequest());
177                String channelId = (String)amf3Request.getClientId();
178                WebLogicChannel channel = gravity.getChannel(channelFactory, channelId);
179                channel.setRequestResponseKey(null);
180        }
181}