src/cppcache/include/gfcpp/PartitionResolver.hpp

#pragma once

#ifndef GEODE_GFCPP_PARTITIONRESOLVER_H_
#define GEODE_GFCPP_PARTITIONRESOLVER_H_

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

#include "SharedPtr.hpp"
#include "Cacheable.hpp"
#include <string>

namespace apache {
namespace geode {
namespace client {

class EntryEvent;

/**
* Implementers of interface <code>PartitionResolver</code> enable custom
* partitioning on the <code>PartitionedRegion</code>.
* 1. The Key class or callback arg can implement PartitionResolver interface to
* enable custom partitioning OR
* 2. Configure your own PartitionResolver class in partition attributes (For
* instance when the Key is a primitive type or String) Implement the
* appropriate equals - For all implementations, you need to be sure to code the
* class equals method so it properly verifies equality for the
* PartitionResolver implementation. This might mean verifying that class names
* are the same or that the returned routing objects are the same etc.. When you
* initiate the partitioned region on multiple nodes, GemFire uses the equals
* method to ensure you are using the same PartitionResolver implementation for
* all of the nodes for the region.
* GemFire uses the routing object's hashCode to determine where the data is
* being managed. Say, for example, you want to colocate all Trades by month and
* year.The key is implemented by TradeKey class which also implements the
* PartitionResolver interface.
* public class TradeKey implements PartitionResolver {<br>
* &nbsp &nbsp private String tradeID;<br>
* &nbsp &nbsp private Month month ;<br>
* &nbsp &nbsp private Year year ;<br>
*
* &nbsp &nbsp public TradingKey(){ } <br>
* &nbsp &nbsp public TradingKey(Month month, Year year){<br>
* &nbsp &nbsp &nbsp &nbsp this.month = month;<br>
* &nbsp &nbsp &nbsp &nbsp this.year = year;<br>
* &nbsp &nbsp } <br>
* &nbsp &nbsp public Serializable getRoutingObject(EntryOperation
* opDetails){<br>
* &nbsp &nbsp &nbsp &nbsp return this.month + this.year;<br>
* &nbsp &nbsp }<br> }<br>
*
* In the example above, all trade entries with the same month and year are
* guaranteed to be colocated.
*/
class CPPCACHE_EXPORT PartitionResolver : public SharedBase {
  /**
  * @brief public methods
  */

 public:
  /**
  * @brief destructor
  */
  virtual ~PartitionResolver();

  /**
  * Returns the name of the PartitionResolver
  * @return String name
  */
  virtual const char* getName();

  /**
  * @param opDetails the detail of the entry event
  * @throws RuntimeException - any exception thrown will terminate the operation
  * and the exception will be passed to the
  * calling thread.
  * @return object associated with entry event which allows the Partitioned
  * Region to store associated data together
  */
  virtual CacheableKeyPtr getRoutingObject(const EntryEvent& opDetails) = 0;

 protected:
  /**
  * @brief constructors
  */
  PartitionResolver();

 private:
  // never implemented.
  PartitionResolver(const PartitionResolver& other);
  void operator=(const PartitionResolver& other);
};
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif // GEODE_GFCPP_PARTITIONRESOLVER_H_