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.job;
17  
18  import org.apache.logging.log4j.LogManager;
19  import org.apache.logging.log4j.Logger;
20  import org.codelibs.fess.helper.SearchLogHelper;
21  import org.codelibs.fess.util.ComponentUtil;
22  
23  /**
24   * Job for aggregating and storing search logs.
25   * This job processes search logs and stores them in the search log repository.
26   */
27  public class AggregateLogJob {
28  
29      private static final Logger logger = LogManager.getLogger(AggregateLogJob.class);
30  
31      /**
32       * Default constructor.
33       */
34      public AggregateLogJob() {
35          // Default constructor
36      }
37  
38      /**
39       * Executes the search log aggregation job.
40       * Stores search logs using the SearchLogHelper and returns execution results.
41       *
42       * @return execution result message, empty if successful or error message if failed
43       */
44      public String execute() {
45          final SearchLogHelper searchLogHelper = ComponentUtil.getSearchLogHelper();
46  
47          final StringBuilder resultBuf = new StringBuilder();
48  
49          try {
50              searchLogHelper.storeSearchLog();
51          } catch (final Exception e) {
52              logger.error("Failed to store a search log.", e);
53              resultBuf.append(e.getMessage()).append("\n");
54          }
55  
56          return resultBuf.toString();
57      }
58  
59  }