svn commit: r1547826 - in /manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler: interfaces/ repositoryconnectorpool/

[kw...@apache.org]

Author: kwright
Date: Wed Dec  4 15:42:25 2013
New Revision: 1547826

URL: http://svn.apache.org/r1547826
Log:
Add thread-local repository connector pool object

Added:
    manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnectorPool.java   (with props)
    manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorPoolFactory.java   (with props)
    manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/repositoryconnectorpool/
    manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/repositoryconnectorpool/RepositoryConnectorPool.java   (with props)
Modified:
    manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorFactory.java

Added: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnectorPool.java
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnectorPool.java?rev=1547826&view=auto
==============================================================================
--- manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnectorPool.java (added)
+++ manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnectorPool.java Wed Dec  4 15:42:25 2013
@@ -0,0 +1,79 @@
+/* $Id$ */
+
+/**
+* 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.crawler.interfaces;
+
+import org.apache.manifoldcf.core.interfaces.*;
+
+import java.util.*;
+import java.io.*;
+
+/** An object implementing this interface functions as a pool of repository connectors.
+* Coordination and allocation among cluster members is managed within. 
+* These objects are thread-local, so do not share them among threads.
+*/
+public interface IRepositoryConnectorPool
+{
+  public static final String _rcsid = "@(#)$Id$";
+
+  /** Get multiple repository connectors, all at once.  Do this in a particular order
+  * so that any connector exhaustion will not cause a deadlock.
+  *@param orderingKeys are the keys which determine in what order the connectors are obtained.
+  *@param repositoryConnections are the connections to use the build the connector instances.
+  */
+  public IRepositoryConnector[] grabMultiple(String[] orderingKeys, IRepositoryConnection[] authorityConnections)
+    throws ManifoldCFException;
+
+  /** Get a repository connector.
+  * The connector is specified by a repository connection object.
+  *@param repositoryConnection is the authority connection to base the connector instance on.
+  */
+  public IRepositoryConnector grab(IRepositoryConnection repositoryConnection)
+    throws ManifoldCFException;
+
+  /** Release multiple repository connectors.
+  *@param connectors are the connector instances to release.
+  */
+  public void releaseMultiple(IRepositoryConnector[] connectors)
+    throws ManifoldCFException;
+
+  /** Release a repository connector.
+  *@param connector is the connector to release.
+  */
+  public void release(IRepositoryConnector connector)
+    throws ManifoldCFException;
+
+  /** Idle notification for inactive repository connector handles.
+  * This method polls all inactive handles.
+  */
+  public void pollAllConnectors()
+    throws ManifoldCFException;
+
+  /** Flush only those connector handles that are currently unused.
+  */
+  public void flushUnusedConnectors()
+    throws ManifoldCFException;
+
+  /** Clean up all open repository connector handles.
+  * This method is called when the connector pool needs to be flushed,
+  * to free resources.
+  */
+  public void closeAllConnectors()
+    throws ManifoldCFException;
+
+}

Propchange: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnectorPool.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnectorPool.java
------------------------------------------------------------------------------
    svn:keywords = Id

Modified: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorFactory.java
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorFactory.java?rev=1547826&r1=1547825&r2=1547826&view=diff
==============================================================================
--- manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorFactory.java (original)
+++ manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorFactory.java Wed Dec  4 15:42:25 2013
@@ -231,6 +231,12 @@ public class RepositoryConnectorFactory 
     thisFactory.pollThisAllConnectors(threadContext);
   }
 
+  public static void flushUnusedConnectors(IThreadContext threadContext)
+    throws ManifoldCFException
+  {
+    thisFactory.flushThisUnusedConnectors(threadContext);
+  }
+
   /** Clean up all open repository connector handles.
   * This method is called when the connector pool needs to be flushed,
   * to free resources.

Added: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorPoolFactory.java
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorPoolFactory.java?rev=1547826&view=auto
==============================================================================
--- manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorPoolFactory.java (added)
+++ manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorPoolFactory.java Wed Dec  4 15:42:25 2013
@@ -0,0 +1,54 @@
+/* $Id$ */
+
+/**
+* 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.crawler.interfaces;
+
+import org.apache.manifoldcf.core.interfaces.*;
+
+import java.util.*;
+
+/** Repository connector pool manager factory.
+*/
+public class RepositoryConnectorPoolFactory
+{
+  public static final String _rcsid = "@(#)$Id$";
+
+  // name to use in thread context pool of objects
+  private final static String objectName = "_RepositoryConnectorPoolMgr_";
+
+  private RepositoryConnectorPoolFactory()
+  {
+  }
+
+  /** Make a repository connector pool handle.
+  *@param tc is the thread context.
+  *@return the handle.
+  */
+  public static IRepositoryConnectorPool make(IThreadContext tc)
+    throws ManifoldCFException
+  {
+    Object o = tc.get(objectName);
+    if (o == null || !(o instanceof IRepositoryConnectorPool))
+    {
+      o = new org.apache.manifoldcf.crawler.repositoryconnectorpool.RepositoryConnectorPool(tc);
+      tc.save(objectName,o);
+    }
+    return (IRepositoryConnectorPool)o;
+  }
+
+}

Propchange: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorPoolFactory.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/interfaces/RepositoryConnectorPoolFactory.java
------------------------------------------------------------------------------
    svn:keywords = Id

Added: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/repositoryconnectorpool/RepositoryConnectorPool.java
URL: http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/repositoryconnectorpool/RepositoryConnectorPool.java?rev=1547826&view=auto
==============================================================================
--- manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/repositoryconnectorpool/RepositoryConnectorPool.java (added)
+++ manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/repositoryconnectorpool/RepositoryConnectorPool.java Wed Dec  4 15:42:25 2013
@@ -0,0 +1,135 @@
+/* $Id$ */
+
+/**
+* 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.crawler.repositoryconnectorpool;
+
+import org.apache.manifoldcf.core.interfaces.*;
+import org.apache.manifoldcf.crawler.interfaces.*;
+
+import java.util.*;
+import java.io.*;
+
+/** An implementation of IRepositoryConnectorPool.
+* Coordination and allocation among cluster members is managed within. 
+* These objects are thread-local, so do not share them among threads.
+*/
+public class RepositoryConnectorPool implements IRepositoryConnectorPool
+{
+  public static final String _rcsid = "@(#)$Id$";
+
+  // This implementation is a place-holder for the real one, which will likely fold in the pooling code
+  // as we strip it out of RepositoryConnectorFactory.
+
+  /** Thread context */
+  protected final IThreadContext threadContext;
+  
+  /** Constructor */
+  public RepositoryConnectorPool(IThreadContext threadContext)
+    throws ManifoldCFException
+  {
+    this.threadContext = threadContext;
+  }
+  
+  /** Get multiple repository connectors, all at once.  Do this in a particular order
+  * so that any connector exhaustion will not cause a deadlock.
+  *@param orderingKeys are the keys which determine in what order the connectors are obtained.
+  *@param repositoryConnections are the connections to use the build the connector instances.
+  */
+  @Override
+  public IRepositoryConnector[] grabMultiple(String[] orderingKeys, IRepositoryConnection[] repositoryConnections)
+    throws ManifoldCFException
+  {
+    // For now, use the RepositoryConnectorFactory method.  This will require us to extract info
+    // from each repository connection, however.
+    String[] classNames = new String[repositoryConnections.length];
+    ConfigParams[] configInfos = new ConfigParams[repositoryConnections.length];
+    int[] maxPoolSizes = new int[repositoryConnections.length];
+    
+    for (int i = 0; i < repositoryConnections.length; i++)
+    {
+      classNames[i] = repositoryConnections[i].getClassName();
+      configInfos[i] = repositoryConnections[i].getConfigParams();
+      maxPoolSizes[i] = repositoryConnections[i].getMaxConnections();
+    }
+    return RepositoryConnectorFactory.grabMultiple(threadContext,
+      orderingKeys, classNames, configInfos, maxPoolSizes);
+  }
+
+  /** Get a repository connector.
+  * The connector is specified by a repository connection object.
+  *@param authorityConnection is the repository connection to base the connector instance on.
+  */
+  @Override
+  public IRepositoryConnector grab(IRepositoryConnection repositoryConnection)
+    throws ManifoldCFException
+  {
+    return RepositoryConnectorFactory.grab(threadContext, repositoryConnection.getClassName(),
+      repositoryConnection.getConfigParams(), repositoryConnection.getMaxConnections());
+  }
+
+  /** Release multiple repository connectors.
+  *@param connectors are the connector instances to release.
+  */
+  @Override
+  public void releaseMultiple(IRepositoryConnector[] connectors)
+    throws ManifoldCFException
+  {
+    RepositoryConnectorFactory.releaseMultiple(connectors);
+  }
+
+  /** Release a repository connector.
+  *@param connector is the connector to release.
+  */
+  @Override
+  public void release(IRepositoryConnector connector)
+    throws ManifoldCFException
+  {
+    RepositoryConnectorFactory.release(connector);
+  }
+
+  /** Idle notification for inactive repository connector handles.
+  * This method polls all inactive handles.
+  */
+  @Override
+  public void pollAllConnectors()
+    throws ManifoldCFException
+  {
+    RepositoryConnectorFactory.pollAllConnectors(threadContext);
+  }
+
+  /** Flush only those connector handles that are currently unused.
+  */
+  @Override
+  public void flushUnusedConnectors()
+    throws ManifoldCFException
+  {
+    RepositoryConnectorFactory.flushUnusedConnectors(threadContext);
+  }
+
+  /** Clean up all open repository connector handles.
+  * This method is called when the connector pool needs to be flushed,
+  * to free resources.
+  */
+  @Override
+  public void closeAllConnectors()
+    throws ManifoldCFException
+  {
+    RepositoryConnectorFactory.closeAllConnectors(threadContext);
+  }
+
+}

Propchange: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/repositoryconnectorpool/RepositoryConnectorPool.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: manifoldcf/branches/CONNECTORS-781/framework/pull-agent/src/main/java/org/apache/manifoldcf/crawler/repositoryconnectorpool/RepositoryConnectorPool.java
------------------------------------------------------------------------------
    svn:keywords = Id