PrincipalsProcessor.java

/* ********************************************************************
    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.indexer;

import org.bedework.calfacade.exc.CalFacadeException;
import org.bedework.indexer.IndexStats.StatType;

import java.util.List;

/** This implementation crawls the user subtree indexing user entries.
 *
 * @author douglm
 *
 */
public class PrincipalsProcessor extends Crawler {
  /** This is the constructor for handling the non-public principal indexing.
   *
   * Run a thread which reads the children of the root directory. Each child
   * is a home directory. We read a batch of these at a time and then start
   * up maxThreads processes to handle the user data.
   *
   * When we've finished the entire tree we stop.
   *
   * @param status
   * @param name
   * @param adminAccount
   * @param batchDelay
   * @param entityDelay
   * @param skipPaths - paths to skip
   * @param indexRootPath - where we build the index
   * @throws CalFacadeException
   */
  public PrincipalsProcessor(final CrawlStatus status,
                             final String name,
                             final String adminAccount,
                             final long batchDelay,
                             final long entityDelay,
                             final List<String> skipPaths,
                             final String indexRootPath) throws CalFacadeException {
    super(status,
          name, adminAccount, null, batchDelay, entityDelay,
          skipPaths, indexRootPath);
  }

  /* (non-Javadoc)
   * @see org.bedework.indexer.crawler.Processor#process(java.lang.String)
   */
  @Override
  public void process() throws CalFacadeException {
    /* We get batched lists of user principals and then start up indexer threads
     * to handle each principal
     */

    Refs refs = null;

    for (;;) {
      refs = getPrincipalHrefs(refs);

      if (refs == null) {
        if (debug) {
          debugMsg("Principals: No more");
        }

        break;
      }

      /* Here I should start up maxthread processors then as each one terminates
       * start up a new one until the batch is done
       */

      /* At the moment we can get a weird mix of names under /user.
       * If it's a normal account we get something like /user/fred so that home
       * would be "fred".
       *
       * We also get something like /user/principals/groups/mygroup so if we
       * get "principals" as the home then we need to start a principal processor
       * to handle those. Note we may have /user/principals/locations etc.
       *
       * We also need to check the options to determine if "principals" really is
       * the value to look for.
       */

      for (final String href: refs.refs) {
        if (debug) {
          debugMsg("Principals: Processing principal " + href);
        }

        getStatus().currentStatus = "Principals: Processing principal " + href;

        final ProcessorBase p = new PrincipalProcessor(status,
                                                       name + " " + principal,
                                                       adminAccount,
                                                       href,
                                                       batchDelay,
                                                       entityDelay,
                                                       getSkipPaths(), indexRootPath);

        /* This call should hang waiting for an available process */
        final IndexerThread it = getPrincipalThread(p);

        if (debug) {
          debugMsg("Principals: Got thread for " + href);
        }

        getStatus().stats.inc(StatType.principals);

        it.start();
      }
    }
  }
}