View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  
22  package org.opencastproject.elasticsearch.index.rebuild;
23  
24  import org.opencastproject.security.api.Organization;
25  
26  /**
27   * An exception which indicates an error when rebuilding an ElasticSearch index.
28   */
29  public class IndexRebuildException extends Exception {
30  
31    private static final long serialVersionUID = -3312895786363366343L;
32  
33    /**
34     * Constructor without Cause.
35     *
36     * @param message
37     *           The error message.
38     *
39     */
40    public IndexRebuildException(String message) {
41      super(message);
42    }
43  
44    /**
45     * Full fledged constructor.
46     *
47     * @param message
48     *           The error message.
49     * @param cause
50     *           The cause.
51     */
52    public IndexRebuildException(String message, Throwable cause) {
53      super(message, cause);
54    }
55  
56    /**
57     * Constructor that builds an error message.
58     *
59     * @param service
60     *           The service that's adding to the index.
61     * @param cause
62     *           The cause.
63     */
64    public IndexRebuildException(IndexRebuildService.Service service, Throwable cause) {
65      super(String.format("Error updating the index for service %s", service.name()), cause);
66    }
67  
68    /**
69     * Constructor that builds an error message.
70     *
71     * @param service
72     *           The service that's adding to the index.
73     * @param org
74     *           The organization.
75     * @param cause
76     *           The cause.
77     */
78    public IndexRebuildException(IndexRebuildService.Service service, Organization org,
79            Throwable cause) {
80      super(String.format("Error updating the index for service %s and organization %s", service.name(),
81              org.getId()), cause);
82    }
83  }