ICacheHandle.java

/* $Id: ICacheHandle.java 988245 2010-08-23 18:39:35Z kwright $ */

/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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.apache.manifoldcf.core.interfaces;

/** This is a handle created by the cache manager, which describes the current status of a cache
* operation.
*/
public interface ICacheHandle
{
  public static final String _rcsid = "@(#)$Id: ICacheHandle.java 988245 2010-08-23 18:39:35Z kwright $";

  /** Get the read lock strings.
  *@return read lock string array.
  */
  public String[] getReadLockStrings();

  /** Get the write lock strings.
  *@return write lock string array.
  */
  public String[] getWriteLockStrings();

  /** Get the set of object descriptions.
  *@return the object descriptions.
  */
  public ICacheDescription[] getObjectDescriptions();

  /** Get the invalidation keys.
  *@return the invalidation key set.
  */
  public StringSet getInvalidationKeys();

  /** Get the transaction ID.
  *@return the transaction ID.
  */
  public String getTransactionID();

}