com.gemstone.gemfire.internal.datasource.ConnectionPoolCache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

There is a newer version: 2.0-BETA

/*
 * Copyright (c) 2010-2015 Pivotal Software, 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.internal.datasource;

/**
 * This interface outlines the behavior of a connection pool.
 * 
 * @author negi
 */
public interface ConnectionPoolCache {

  /**
   * This method is used to get the connection from the pool. The default
   * username and password are used for making the conections.
   * 
   * @return Object - connection from the pool.
   * @throws PoolException
   */
  public Object getPooledConnectionFromPool() throws PoolException;

  /**
   * This method will return the Pooled connection object back to the pool.
   * 
   * @param connectionObject - Connection object returned to the pool.
   */
  public void returnPooledConnectionToPool(Object connectionObject);

  /**
   * This method is used to set the time out for active connection so that it
   * can be collected by the cleaner thread Modified by Asif
   */
  public void expirePooledConnection(Object connectionObject);

  /**
   * Clean up the resources before restart of Cache
   */
  public void clearUp();
}