Coverage Report - org.seasar.cubby.filter.RequestRoutingFilter
 
Classes in this File Line Coverage Branch Coverage Complexity
RequestRoutingFilter
0%
0/30
0%
0/8
0
 
 1  
 /*
 2  
  * Copyright 2004-2008 the Seasar Foundation and the Others.
 3  
  *
 4  
  * Licensed under the Apache License, Version 2.0 (the "License");
 5  
  * you may not use this file except in compliance with the License.
 6  
  * You may obtain a copy of the License at
 7  
  *
 8  
  *     http://www.apache.org/licenses/LICENSE-2.0
 9  
  *
 10  
  * Unless required by applicable law or agreed to in writing, software
 11  
  * distributed under the License is distributed on an "AS IS" BASIS,
 12  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 13  
  * either express or implied. See the License for the specific language
 14  
  * governing permissions and limitations under the License.
 15  
  */
 16  
 package org.seasar.cubby.filter;
 17  
 
 18  
 import static org.seasar.cubby.CubbyConstants.ATTR_ROUTINGS;
 19  
 
 20  
 import java.io.IOException;
 21  
 import java.util.ArrayList;
 22  
 import java.util.List;
 23  
 import java.util.Map;
 24  
 import java.util.StringTokenizer;
 25  
 import java.util.regex.Pattern;
 26  
 
 27  
 import javax.servlet.Filter;
 28  
 import javax.servlet.FilterChain;
 29  
 import javax.servlet.FilterConfig;
 30  
 import javax.servlet.RequestDispatcher;
 31  
 import javax.servlet.ServletException;
 32  
 import javax.servlet.ServletRequest;
 33  
 import javax.servlet.ServletResponse;
 34  
 import javax.servlet.http.HttpServletRequest;
 35  
 import javax.servlet.http.HttpServletResponse;
 36  
 
 37  
 import org.seasar.cubby.routing.InternalForwardInfo;
 38  
 import org.seasar.cubby.routing.Router;
 39  
 import org.seasar.cubby.routing.Routing;
 40  
 import org.seasar.framework.container.S2Container;
 41  
 import org.seasar.framework.container.factory.SingletonS2ContainerFactory;
 42  
 import org.seasar.framework.log.Logger;
 43  
 import org.seasar.framework.util.StringUtil;
 44  
 
 45  
 /**
 46  
  * リクエストされたURLを適切なアクションに振り分けるフィルタ。
 47  
  * <p>
 48  
  * {@link Router} によって {@link InternalForwardInfo} を抽出し、そこに保持された情報をもとにフォワードします。
 49  
  * </p>
 50  
  * 
 51  
  * @author baba
 52  
  * @since 1.0.0
 53  
  */
 54  0
 public class RequestRoutingFilter implements Filter {
 55  
 
 56  
         /** ロガー。 */
 57  0
         private static final Logger logger = Logger
 58  
                         .getLogger(RequestRoutingFilter.class);
 59  
 
 60  
         /** ルーティングの対象外とするパスの初期パラメータ名。 */
 61  
         public static final String IGNORE_PATH_PATTERN = "ignorePathPattern";
 62  
 
 63  
         /** ルーティングの対象外とするパスの正規表現パターンのリスト。 */
 64  0
         private final List<Pattern> ignorePathPatterns = new ArrayList<Pattern>();
 65  
 
 66  
         /**
 67  
          * このフィルタを初期化します。
 68  
          * <p>
 69  
          * 使用可能な初期化パラメータ <table> <thead>
 70  
          * <th> 初期化パラメータ名 </th>
 71  
          * <th> 初期化パラメータの値 </th>
 72  
          * <th> 例 </th>
 73  
          * </thead> <thead>
 74  
          * <tr>
 75  
          * <td>{@link #IGNORE_PATH_PATTERN}</td>
 76  
          * <td>ルーティングの対象外とするパスの正規表現をカンマ区切りで指定します。 HotDeploy
 77  
          * 時のパフォーマンスにも影響するので、画像やスクリプトを特定のディレクトリに
 78  
          * 格納していてアクションを実行するパスと明確に区別できる場合はできる限り指定するようにしてください。</td>
 79  
          * <td>
 80  
          * 
 81  
          * <pre>
 82  
          * &lt;param-name&gt;ignorePathPattern&amp;lt/param-name&gt;
 83  
          * &lt;param-value&gt;/img/.*,/js/.*&lt;param-name&gt;
 84  
          * </pre>
 85  
          * 
 86  
          * この例では /img と /js 以下のパスをルーティングの対象外にします。 </td>
 87  
          * </tr>
 88  
          * </thead>
 89  
          * </p>
 90  
          * 
 91  
          * @param config
 92  
          *            Filter 設定のためのオブジェクト
 93  
          * @exception ServletException
 94  
          *                初期化処理で例外が発生した場合
 95  
          */
 96  
         public void init(final FilterConfig config) throws ServletException {
 97  0
                 final String ignorePathPatternString = config
 98  
                                 .getInitParameter(IGNORE_PATH_PATTERN);
 99  0
                 if (!StringUtil.isEmpty(ignorePathPatternString)) {
 100  
 
 101  0
                         for (final StringTokenizer tokenizer = new StringTokenizer(
 102  0
                                         ignorePathPatternString, ","); tokenizer.hasMoreTokens();) {
 103  0
                                 final String token = tokenizer.nextToken();
 104  0
                                 final Pattern pattern = Pattern.compile(token);
 105  0
                                 ignorePathPatterns.add(pattern);
 106  0
                         }
 107  
                 }
 108  0
         }
 109  
 
 110  
         /**
 111  
          * {@inheritDoc}
 112  
          */
 113  
         public void destroy() {
 114  0
         }
 115  
 
 116  
         /**
 117  
          * フィルタリングを行います。
 118  
          * <p>
 119  
          * リクエストされた URI に対応する内部フォワード情報が {@link Router} から取得できた場合は、そこに設定されている
 120  
          * {@link InternalForwardInfo#getOnSubmitRoutings()} をリクエストに設定し、
 121  
          * {@link InternalForwardInfo#getInternalForwardPath()} へフォワードします。 フォワード先は
 122  
          * {@link CubbyFilter} が処理することを期待します。 URI
 123  
          * に対応する内部フォワード情報が取得できなかった場合はフィルタチェインで次のフィルタに処理を移譲します。
 124  
          * </p>
 125  
          * 
 126  
          * @param req
 127  
          *            リクエスト
 128  
          * @param res
 129  
          *            レスポンス
 130  
          * @param chain
 131  
          *            フィルタチェイン
 132  
          * @throws IOException
 133  
          *             リクエストディスパッチャやフィルタチェインで例外が発生した場合
 134  
          * @throws ServletException
 135  
          *             リクエストディスパッチャやフィルタチェインで例外が発生した場合
 136  
          * @see Router#routing(HttpServletRequest, HttpServletResponse, List)
 137  
          * @see CubbyFilter
 138  
          */
 139  
         public void doFilter(final ServletRequest req, final ServletResponse res,
 140  
                         final FilterChain chain) throws IOException, ServletException {
 141  0
                 final HttpServletRequest request = (HttpServletRequest) req;
 142  0
                 final HttpServletResponse response = (HttpServletResponse) res;
 143  
 
 144  0
                 final S2Container container = SingletonS2ContainerFactory
 145  
                                 .getContainer();
 146  0
                 final Router router = (Router) container.getComponent(Router.class);
 147  
 
 148  0
                 final InternalForwardInfo internalForwardInfo = router.routing(request,
 149  
                                 response, ignorePathPatterns);
 150  0
                 if (internalForwardInfo != null) {
 151  0
                         final String internalForwardPath = internalForwardInfo
 152  
                                         .getInternalForwardPath();
 153  0
                         final Map<String, Routing> onSubmitRoutings = internalForwardInfo
 154  
                                         .getOnSubmitRoutings();
 155  0
                         if (logger.isDebugEnabled()) {
 156  0
                                 logger.log("DCUB0001", new Object[] { internalForwardPath,
 157  
                                                 onSubmitRoutings });
 158  0
                                 logger.log("DCUB0015", new Object[] { onSubmitRoutings });
 159  
                         }
 160  0
                         request.setAttribute(ATTR_ROUTINGS, onSubmitRoutings);
 161  0
                         final RequestDispatcher requestDispatcher = request
 162  
                                         .getRequestDispatcher(internalForwardPath);
 163  0
                         requestDispatcher.forward(request, response);
 164  0
                 } else {
 165  0
                         chain.doFilter(request, response);
 166  
                 }
 167  0
         }
 168  
 
 169  
 }