com.gemstone.gemfire.cache.wan.GatewayQueueEvent Maven / Gradle / Ivy

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
The newest version!
/*
 * 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.wan;

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

/**
 * Represents Cache events going through 
 * GatewaySenders.
 * 
 * @author Suranjan Kumar
 * @author Yogesh Mahajan
 * @author Pushkar Deole
 * 
 * @since 7.0
 */
public interface GatewayQueueEvent {
  /**
   * Returns the Region associated with this AsyncEvent
   * 
   * @return the Region associated with this AsyncEvent
   *         OR null if Region not found (e.g. this can happen 
   *         if it is destroyed).
   */
  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 K getKey();

  /**
   * Returns the deserialized value associated with this event.
   * 
   * @return the deserialized value associated with this event
   * 
   * @throws IllegalStateException may be thrown if the event's value was stored off-heap
   * and {@link AsyncEventListener#processEvents(java.util.List)} has already returned.
   */
  public V getDeserializedValue();

  /**
   * Returns the serialized form of the value associated with this event.
   * 
   * @return the serialized form of the value associated with this event
   * 
   * @throws IllegalStateException may be thrown if the event's value was stored off-heap
   * and {@link AsyncEventListener#processEvents(java.util.List)} has already returned.
   */
  public byte[] getSerializedValue();
}