View Javadoc

1   /*
2    * $Id: ControllerClasspathPackageProvider.java 651946 2008-04-27 13:41:38Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  package org.apache.struts2.rest;
23  
24  import org.apache.struts2.config.ClasspathPackageProvider;
25  
26  import com.opensymphony.xwork2.inject.Inject;
27  import com.opensymphony.xwork2.util.ResolverUtil.ClassTest;
28  
29  /***
30   * Checks for actions ending in Controller indicating a Rest controller
31   */
32  public class ControllerClasspathPackageProvider extends ClasspathPackageProvider {
33      
34      /***
35       * A setting to disable action scanning.
36       */
37      protected static final String DISABLE_REST_CONTROLLER_SCANNING = "struts.configuration.rest.disableControllerScanning";
38      
39      @Override
40      protected ClassTest createActionClassTest() {
41          return new ClassTest() {
42              // Match Action implementations and classes ending with "Controller"
43              public boolean matches(Class type) {
44                  return (type.getSimpleName().endsWith("Controller"));
45              }
46          };
47      }
48      
49      @Override
50      protected String getClassSuffix() {
51          return "Controller";
52      }
53      
54      /***
55       * Ignore setting to disable action scanning from the codebehind plugin.
56       *
57       * @param disableActionScanning True to disable
58       */
59      @Override
60      @Inject(value=DISABLE_ACTION_SCANNING, required=false)
61      public void setDisableActionScanning(String disableActionScanning) {
62          // do nothing
63      }
64      
65      /***
66       * Disables controller scanning.
67       *
68       * @param disableActionScanning True to disable
69       */
70      @Inject(value=DISABLE_REST_CONTROLLER_SCANNING, required=false)
71      public void setDisableRestControllerScanning(String disableActionScanning) {
72          super.setDisableActionScanning(disableActionScanning);
73      }
74  
75  }