001    /*
002      GRANITE DATA SERVICES
003      Copyright (C) 2011 GRANITE DATA SERVICES S.A.S.
004    
005      This file is part of Granite Data Services.
006    
007      Granite Data Services is free software; you can redistribute it and/or modify
008      it under the terms of the GNU Library General Public License as published by
009      the Free Software Foundation; either version 2 of the License, or (at your
010      option) any later version.
011    
012      Granite Data Services is distributed in the hope that it will be useful, but
013      WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
014      FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License
015      for more details.
016    
017      You should have received a copy of the GNU Library General Public License
018      along with this library; if not, see <http://www.gnu.org/licenses/>.
019    */
020    
021    package org.granite.gravity.servlet3;
022    
023    import java.io.IOException;
024    import java.io.InputStream;
025    import java.io.OutputStream;
026    
027    import javax.servlet.AsyncContext;
028    import javax.servlet.ServletConfig;
029    import javax.servlet.ServletException;
030    import javax.servlet.http.HttpServletRequest;
031    import javax.servlet.http.HttpServletResponse;
032    
033    import org.granite.gravity.AbstractGravityServlet;
034    import org.granite.gravity.AsyncHttpContext;
035    import org.granite.gravity.Gravity;
036    import org.granite.gravity.GravityManager;
037    import org.granite.logging.Logger;
038    import org.granite.messaging.jmf.JMFDeserializer;
039    import org.granite.messaging.jmf.JMFSerializer;
040    import org.granite.messaging.jmf.JMFServletContextListener;
041    import org.granite.messaging.jmf.SharedContext;
042    import org.granite.util.ContentType;
043    import org.granite.util.UUIDUtil;
044    
045    import flex.messaging.messages.Message;
046    
047    /**
048     * @author Franck WOLFF
049     */
050    public class GravityAsyncServlet extends AbstractGravityServlet {
051    
052            private static final long serialVersionUID = 1L;
053    
054            private static final Logger log = Logger.getLogger(GravityAsyncServlet.class);
055        
056        protected SharedContext jmfSharedContext = null;
057        
058            @Override
059            public void init(ServletConfig config) throws ServletException {
060                    super.init(config);
061                    
062            jmfSharedContext = JMFServletContextListener.getSharedContext(config.getServletContext());
063            }
064    
065            @Override
066            protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
067                    
068                    if (!request.isAsyncSupported())
069                            throw new ServletException("Asynchronous requests are not supported with this servlet. Please check your web.xml");
070    
071                    if (request.isAsyncStarted())
072                            throw new ServletException("Gravity Servlet3 implementation doesn't support dispatch(...) mode");
073    
074                    Gravity gravity = GravityManager.getGravity(getServletContext());
075                    AsyncChannelFactory channelFactory = newAsyncChannelFactory(gravity, request.getContentType());
076            
077                    try {
078                initializeRequest(gravity, request, response);
079    
080                Message[] amf3Requests = deserialize(gravity, request);
081    
082                log.debug(">> [AMF3 REQUESTS] %s", (Object)amf3Requests);
083    
084                Message[] amf3Responses = null;
085                
086                boolean accessed = false;
087                for (int i = 0; i < amf3Requests.length; i++) {
088                    Message amf3Request = amf3Requests[i];
089    
090                    // Ask gravity to create a specific response (will be null for connect request from tunnel).
091                    Message amf3Response = gravity.handleMessage(channelFactory, amf3Request);
092                    String channelId = (String)amf3Request.getClientId();
093                    
094                    // Mark current channel (if any) as accessed.
095                    if (!accessed)
096                            accessed = gravity.access(channelId);
097                    
098                    // (Re)Connect message from tunnel...
099                    if (amf3Response == null) {
100                        if (amf3Requests.length > 1)
101                            throw new IllegalArgumentException("Only one connect request is allowed on tunnel.");
102    
103                        AsyncChannel channel = gravity.getChannel(channelFactory, channelId);
104                        if (channel == null)
105                                    throw new NullPointerException("No channel on tunnel connect");
106                        
107                        // Try to send pending messages if any (using current container thread).
108                        if (!channel.runReceived(new AsyncHttpContext(request, response, amf3Request))) {
109                                // No pending messages, wait for new ones or timeout.
110                                setConnectMessage(request, amf3Request);
111                                    AsyncContext asyncContext = request.startAsync();
112                                    asyncContext.setTimeout(getLongPollingTimeout());
113                                    try {
114                                            asyncContext.addListener(new AsyncRequestListener(channel));
115                                            channel.setAsyncContext(asyncContext);
116                                    }
117                                    catch (Exception e) {
118                                            log.error(e, "Error while setting async context. Closing context...");
119                                            asyncContext.complete();
120                                    }
121                        }
122                        return;
123                    }
124    
125                    if (amf3Responses == null)
126                            amf3Responses = new Message[amf3Requests.length];
127                    amf3Responses[i] = amf3Response;
128                }
129    
130                log.debug("<< [AMF3 RESPONSES] %s", (Object)amf3Responses);
131    
132                serialize(gravity, response, amf3Responses, request.getContentType());
133            }
134            catch (IOException e) {
135                log.error(e, "Gravity message error");
136                throw e;
137            }
138            catch (Exception e) {
139                log.error(e, "Gravity message error");
140                throw new ServletException(e);
141            }
142            finally {
143                    cleanupRequest(request);
144            }
145            }
146    
147    
148            @Override
149            public void destroy() {
150                    jmfSharedContext = null;
151    
152                    super.destroy();
153            }
154            
155            protected AsyncChannelFactory newAsyncChannelFactory(Gravity gravity, String contentType) throws ServletException {
156                    if (ContentType.JMF_AMF.mimeType().equals(contentType)) {
157                    if (jmfSharedContext == null)
158                            throw JMFServletContextListener.newSharedContextNotInitializedException();
159                            
160                    return new JMFAsyncChannelFactory(gravity, jmfSharedContext);
161                    }
162                    return new AsyncChannelFactory(gravity);
163            }
164    
165            @Override
166            protected Message[] deserialize(Gravity gravity, HttpServletRequest request) throws ClassNotFoundException, IOException, ServletException {
167                    if (ContentType.JMF_AMF.mimeType().equals(request.getContentType())) {
168                            InputStream is = request.getInputStream();
169                            try {
170                                    return deserializeJMFAMF(gravity, request, is);
171                            }
172                            finally {
173                                    is.close();
174                            }
175                    }
176                    return super.deserialize(gravity, request);
177            }
178    
179            @Override
180            protected Message[] deserialize(Gravity gravity, HttpServletRequest request, InputStream is) throws ClassNotFoundException, IOException, ServletException {
181                    if (ContentType.JMF_AMF.mimeType().equals(request.getContentType()))
182                            return deserializeJMFAMF(gravity, request, is);
183                    return super.deserialize(gravity, request, is);
184            }
185            
186            protected Message[] deserializeJMFAMF(Gravity gravity, HttpServletRequest request, InputStream is) throws ClassNotFoundException, IOException, ServletException {
187            if (jmfSharedContext == null)
188                    throw JMFServletContextListener.newSharedContextNotInitializedException();
189            
190            @SuppressWarnings("all") // JDK7 warning (Resource leak: 'deserializer' is never closed)...
191                    JMFDeserializer deserializer = new JMFDeserializer(is, jmfSharedContext);
192            return (Message[])deserializer.readObject();
193            }
194    
195            protected void serialize(Gravity gravity, HttpServletResponse response, Message[] messages, String contentType) throws IOException, ServletException {
196                    if (ContentType.JMF_AMF.mimeType().equals(contentType))
197                            serializeJMFAMF(gravity, response, messages);
198                    else
199                            super.serialize(gravity, response, messages);
200            }
201    
202            protected void serializeJMFAMF(Gravity gravity, HttpServletResponse response, Message[] messages) throws IOException, ServletException {
203            if (jmfSharedContext == null)
204                    throw JMFServletContextListener.newSharedContextNotInitializedException();
205            
206            OutputStream os = null;
207                    try {
208                // For SDK 2.0.1_Hotfix2+ (LCDS 2.5+).
209                            String dsId = null;
210                for (Message message : messages) {
211                        if ("nil".equals(message.getHeader(Message.DS_ID_HEADER))) {
212                            if (dsId == null)
213                                    dsId = UUIDUtil.randomUUID();
214                            message.getHeaders().put(Message.DS_ID_HEADER, dsId);
215                        }
216                }
217                            
218                    response.setStatus(HttpServletResponse.SC_OK);
219                    response.setContentType(ContentType.JMF_AMF.mimeType());
220                    response.setDateHeader("Expire", 0L);
221                    response.setHeader("Cache-Control", "no-store");
222                    
223                    os = response.getOutputStream();
224    
225                    @SuppressWarnings("all") // JDK7 warning (Resource leak: 'serializer' is never closed)...
226                JMFSerializer serializer = new JMFSerializer(os, jmfSharedContext);
227                serializer.writeObject(messages);
228                    
229                    os.flush();
230                    response.flushBuffer();
231                    }
232                    finally {
233                            if (os != null)
234                                    os.close();
235                    }
236            }
237    }