org.bedework.calfacade.configs.IndexProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bw-calendar-facade Show documentation
Common calendar classes and code for bedework
The newest version!
/* ********************************************************************
    Licensed to Jasig under one or more contributor license
    agreements. See the NOTICE file distributed with this work
    for additional information regarding copyright ownership.
    Jasig licenses this file to you under the Apache License,
    Version 2.0 (the "License"); you may not use this file
    except in compliance with the License. You may obtain a
    copy of the License at:

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on
    an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied. See the License for the
    specific language governing permissions and limitations
    under the License.
 */
package org.bedework.calfacade.configs;

import org.bedework.util.config.ConfInfo;
import org.bedework.util.jmx.MBeanInfo;
import org.bedework.util.indexing.IndexingProperties;

import java.util.List;

/** These are the properties that the indexer needs to know about.
 *
 * Annotated to allow use by mbeans
 *
 * @author douglm
 *
 */
@ConfInfo(elementName = "index-properties")
public interface IndexProperties extends IndexingProperties {
  /**
   *
   * @param val The indexer config location
   */
  void setIndexerConfig(String val);

  /** Get the indexer config location
   *
   * @return location
   */
  @MBeanInfo("indexer config location")
  String getIndexerConfig();

  /**
   *
   * @param val Account we run under
   */
  void setAccount(String val);

  /**
   * @return String account we use
   */
  @MBeanInfo("account indexer runs as")
  String getAccount();

  /**
   * @param val thread limit
   */
  void setMaxEntityThreads(final int val);

  /**
   * @return thread limit
   */
  @MBeanInfo("max number threads for entity reindexing")
  int getMaxEntityThreads();

  /**
   * @param val thread limit
   */
  void setMaxPrincipalThreads(final int val);

  /**
   * @return thread limit
   */
  @MBeanInfo("max number threads for principal reindexing")
  int getMaxPrincipalThreads();

  /**
   *
   * @param val True if we do public
   */
  void setIndexPublic(final boolean val);

  /**
   * @return true if we do public
   */
  @MBeanInfo("true if we reindex public information")
  boolean getIndexPublic();

  /**
   *
   * @param val True if we do users
   */
  void setIndexUsers(final boolean val);

  /**
   * @return true if we do users
   */
  @MBeanInfo("true if we reindex user information")
  boolean getIndexUsers();

  /**
   *
   * @param val True if we just discard messages.
   */
  void setDiscardMessages(final boolean val);

  /**
   * @return true if we just discard messages
   */
  @MBeanInfo("true if we discard indexer messages - false disablesindexing")
  boolean getDiscardMessages();

  /**
   *
   * @param val Paths to skip - ":" separated
   */
  void setSkipPaths(String val);

  /**
   * @return Paths to skip - ":" separated
   */
  @MBeanInfo("Paths to skip - \":\" separated")
  String getSkipPaths();

  /**
   *
   * @param val Wait time in millis
   */
  void setContextInfoDelay(long val);

  /**
   * @return Wait time in millis
   */
  @MBeanInfo("Wait time in millis")
  long getContextInfoDelay();

  /**
   *
   * @param val Paths to skip as a list
   */
  void setSkipPathsList(List val);

  /**
   * @return Paths to skip as a list
   */
  @MBeanInfo("Paths to skip - \":\" separated")
  @ConfInfo(dontSave = true)
  List getSkipPathsList();

  /**
   * @return copy of this
   */
  IndexProperties cloneIt();
}