View Javadoc
1   /*
2    * Copyright 2012-2025 CodeLibs Project 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.codelibs.fess.app.web.osdd;
17  
18  import org.codelibs.fess.app.web.base.FessSearchAction;
19  import org.lastaflute.web.Execute;
20  import org.lastaflute.web.response.ActionResponse;
21  
22  /**
23   * OSDD (OpenSearch Description Document) action.
24   */
25  public class OsddAction extends FessSearchAction {
26  
27      /**
28       * Default constructor.
29       */
30      public OsddAction() {
31          super();
32      }
33  
34      // ===================================================================================
35      //                                                                            Constant
36      //
37  
38      // ===================================================================================
39      //                                                                           Attribute
40      //
41  
42      // ===================================================================================
43      //                                                                               Hook
44      //                                                                              ======
45  
46      // ===================================================================================
47      //                                                                      Search Execute
48      //                                                                      ==============
49  
50      /**
51       * Returns the OSDD document.
52       *
53       * @return the OSDD document as a stream response
54       */
55      @Execute
56      public ActionResponse index() {
57          if (isLoginRequired()) {
58              return redirectToLogin();
59          }
60          return osddHelper.asStream();
61      }
62  
63  }