View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.myfaces.orchestra.frameworkAdapter.jsf;
21  
22  import org.apache.commons.logging.Log;
23  import org.apache.commons.logging.LogFactory;
24  
25  import javax.servlet.Filter;
26  import javax.servlet.FilterChain;
27  import javax.servlet.FilterConfig;
28  import javax.servlet.ServletException;
29  import javax.servlet.ServletRequest;
30  import javax.servlet.ServletResponse;
31  import java.io.IOException;
32  
33  /**
34   * Configures the JsfFrameworkAdapter.
35   * <p>
36   * Orchestra accesses information about the request, response, session, etc via a
37   * FrameworkAdapter so that it can be used with multiple web tier frameworks. This
38   * class selects and configures the JSF version of this adapter.
39   * <p>
40   * Note that the conversation.jsf.OrchestraServletFilter class executes this class
41   * as a "subfilter", so defining this filter is not required if that filter is
42   * already defined.
43   * <p>
44   * If filter config parameter "conversationMessagerClass" is set, then this is 
45   * passed to the BasicFrameworkAdapter, meaning that this can be either a 
46   * beanname defined in the dependency-injection framework, or an absolute
47   * classname of a type implementing ConversationMessager.
48   * <p>
49   * Note that this class is generally only needed in Orchestra 1.0. In later 
50   * releases the OrchestraFacesContextFactory configures the JsfFrameworkAdapter
51   * instead, requiring less configuration. However this class can be used if the
52   * OrchestraFacesContextFactory approach cannot be used for some reason.
53   */
54  public class JsfFrameworkAdapterFilter implements Filter
55  {
56      private final static String INIT_CONVERSATION_MESSAGER = "conversationMessagerClass";
57  
58      private final Log log = LogFactory.getLog(JsfFrameworkAdapterFilter.class);
59      private JsfFrameworkAdapter adapter;
60  
61      public void init(FilterConfig filterConfig) throws ServletException
62      {
63          String conversationMessager = filterConfig.getInitParameter(INIT_CONVERSATION_MESSAGER);
64  
65          adapter =  new JsfFrameworkAdapter(conversationMessager);
66      }
67  
68      public void doFilter(ServletRequest req, ServletResponse rsp, FilterChain filterChain)
69      throws IOException, ServletException
70      {
71          log.debug("doFilter");
72          try
73          {
74              adapter.beginRequest();
75              filterChain.doFilter(req, rsp);
76          }
77          finally
78          {
79              adapter.endRequest();
80          }
81      }
82  
83      public void destroy()
84      {
85      }
86  }