SimpleTestConnector.java

// Copyright 2006-2009 Google Inc.  All Rights Reserved.
//
// Licensed 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 com.google.enterprise.connector.instantiator;

import com.google.enterprise.connector.spi.AuthenticationIdentity;
import com.google.enterprise.connector.spi.AuthenticationManager;
import com.google.enterprise.connector.spi.AuthenticationResponse;
import com.google.enterprise.connector.spi.AuthorizationManager;
import com.google.enterprise.connector.spi.AuthorizationResponse;
import com.google.enterprise.connector.spi.Connector;
import com.google.enterprise.connector.spi.ConnectorPersistentStore;
import com.google.enterprise.connector.spi.ConnectorPersistentStoreAware;
import com.google.enterprise.connector.spi.ConnectorShutdownAware;
import com.google.enterprise.connector.spi.DocumentList;
import com.google.enterprise.connector.spi.Session;
import com.google.enterprise.connector.spi.SimpleDocument;
import com.google.enterprise.connector.spi.SimpleDocumentList;
import com.google.enterprise.connector.spi.TraversalManager;
import com.google.enterprise.connector.test.ConnectorTestUtils;

import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

/**
 * Simple test connector that can be used with <code>SimpleConnectorType</code>
 * to test storage of some specific properties.
 */
public class SimpleTestConnector implements Connector, ConnectorShutdownAware,
                                            ConnectorPersistentStoreAware {
  private String color;
  private String repositoryFileName;
  private String username;
  private String workDirName;
  private boolean isShutdown = false;
  private boolean isDeleted = false;
  private ConnectorPersistentStore databaseAccess;

  public String getColor() {
    return color;
  }

  public void setColor(String color) {
    this.color = color;
  }

  public String getRepositoryFileName() {
    return repositoryFileName;
  }

  public void setRepositoryFileName(String repositoryFileName) {
    this.repositoryFileName = repositoryFileName;
  }

  public String getUsername() {
    return username;
  }

  public void setUsername(String username) {
    this.username = username;
  }

  public String getWorkDirName() {
    return workDirName;
  }

  public void setWorkDirName(String workDirName) {
    this.workDirName = workDirName;
  }

  public void shutdown() {
    this.isShutdown = true;
  }

  public boolean isShutdown() {
    return isShutdown;
  }

  public void delete() {
    this.isDeleted = true;
  }

  public boolean isDeleted() {
    return isDeleted;
  }

  public void setDatabaseAccess(ConnectorPersistentStore databaseAccess) {
    this.databaseAccess = databaseAccess;
  }

  public ConnectorPersistentStore getDatabaseAccess() {
    return databaseAccess;
  }

  public Session login() {
    return new SimpleTestSession();
  }

  public static class SimpleTestSession implements Session {
    public AuthenticationManager getAuthenticationManager() {
      return new SimpleAuthenticationManager();
    }

    public AuthorizationManager getAuthorizationManager() {
      return new SimpleAuthorizationManager();
    }

    public TraversalManager getTraversalManager() {
      return new SimpleTraversalManager();
    }
  }

  public static class SimpleAuthenticationManager implements AuthenticationManager {
    public AuthenticationResponse authenticate(AuthenticationIdentity id) {
      return new AuthenticationResponse(true, "admin");
    }
  }

  public static class SimpleAuthorizationManager implements AuthorizationManager {
    public Collection<AuthorizationResponse> authorizeDocids(
        Collection<String> col, AuthenticationIdentity id) {
      List<AuthorizationResponse> l = new ArrayList<AuthorizationResponse>();
      for (String docId : col) {
        l.add(new AuthorizationResponse(Boolean.TRUE, docId));
      }
      return l;
    }
  }

  public static class SimpleTraversalManager implements TraversalManager {
    private boolean documentServed = false;

    public void setBatchHint(int hint) {
    }

    public DocumentList startTraversal() {
      if (!documentServed) {
        return traverse();
      } else {
        return null;
      }
    }

    public DocumentList resumeTraversal(String checkpoint) {
      if (!documentServed) {
        return traverse();
      } else {
        return null;
      }
    }

    /**
     * Utility method to produce a <code>DocumentList</code> containing one
     * <code>Document</code>.  It also sets the <code>documentServed</code>
     * state so that is the only <code>Document</code> traversed for this
     * <code>Connector</code>.
     */
    private DocumentList traverse() {
      SimpleDocument document = ConnectorTestUtils.createSimpleDocument("1");
      List<SimpleDocument> docList = new LinkedList<SimpleDocument>();
      docList.add(document);
      documentServed = true;
      return new SimpleDocumentList(docList);
    }
  }
}