com.gemstone.gemfire.cache.util.GatewayEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
TIBCO ComputeDB 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.cache.util;

import com.gemstone.gemfire.cache.Operation;
import com.gemstone.gemfire.cache.Region;

/**
 * Interface GatewayEvent represents Cache events
 * delivered to Gateways.
 *
 * @author Barry Oglesby
 * @since 5.1
 */
public interface GatewayEvent {

  /**
   * Returns the Region name associated with this
   * GatewayEvent.
   * 
   * @return the Region name associated with this
   *         GatewayEvent
   */
  public String getRegionName();

  /**
   * Returns the Region associated with this GatewayEvent.
   * @return the Region associated with this GatewayEvent
   */
  public Region getRegion();

  /**
   * Returns the Operation that triggered this event.
   * @return the Operation that triggered this event
   */
  public Operation getOperation();

  /**
   * Returns the callbackArgument associated with this event.
   * @return the callbackArgument associated with this event
   */
  public Object getCallbackArgument();

  /**
   * Returns the key associated with this event.
   * @return the key associated with this event
   */
  public Object getKey();

  /**
   * Returns the deserialized value associated with this event.
   * @return the deserialized value associated with this event
   */
  public Object getDeserializedValue();

  /**
   * Returns the serialized form of the value associated with this event.
   * @return the serialized form of the value associated with this event
   */
  public byte[] getSerializedValue();

  /**
   * Sets whether this event is a possible duplicate.
   * @param possibleDuplicate whether this event is a possible duplicate
   */
  public void setPossibleDuplicate(boolean possibleDuplicate);

  /**
   * Returns whether this event is a possible duplicate.
   * @return whether this event is a possible duplicate
   */
  public boolean getPossibleDuplicate();
  
  /**
   * Returns the creation timestamp in milliseconds.
   * @return the creation timestamp in milliseconds
   * 
   * @since 6.0
   */
  public long getCreationTime();
}