GetDeltaResponse.java

/*
 * Copyright 2014-2016 CyberVision, Inc.
 *
 * 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.
 */

package org.kaaproject.kaa.server.operations.pojo;

import org.kaaproject.kaa.server.common.core.algorithms.delta.RawBinaryDelta;

/**
 * The Class for modeling of delta response. It is used to communicate with
 * {@link org.kaaproject.kaa.server.operations.service.delta.DeltaService
 * DeltaService}
 *
 * @author ashvayka
 */

public class GetDeltaResponse {

  /**
   * The response type.
   */
  private final GetDeltaResponseType responseType;
  /**
   * The delta.
   */
  private final RawBinaryDelta delta;
  /**
   * The conf schema.
   */
  private String confSchema;

  /**
   * Instantiates a new delta response.
   *
   * @param responseType the response type
   */
  public GetDeltaResponse(GetDeltaResponseType responseType) {
    this(responseType, null);
  }

  /**
   * Instantiates a new delta response.
   *
   * @param responseType the response type
   * @param delta        the delta
   */
  public GetDeltaResponse(GetDeltaResponseType responseType, RawBinaryDelta delta) {
    super();
    this.responseType = responseType;
    this.delta = delta;
  }

  /**
   * Gets the response type.
   *
   * @return the response type
   */
  public GetDeltaResponseType getResponseType() {
    return responseType;
  }

  /**
   * Gets the delta.
   *
   * @return the delta
   */
  public RawBinaryDelta getDelta() {
    return delta;
  }

  /**
   * Gets the conf schema.
   *
   * @return the conf schema
   */
  public String getConfSchema() {
    return confSchema;
  }

  /**
   * Sets the conf schema.
   *
   * @param confSchema the new conf schema
   */
  public void setConfSchema(String confSchema) {
    this.confSchema = confSchema;
  }

  @Override
  public String toString() {
    StringBuilder builder = new StringBuilder();
    builder.append("GetDeltaResponse [responseType=");
    builder.append(responseType);
    builder.append(", delta=");
    builder.append(delta);
    builder.append(", confSchema=");
    builder.append(confSchema);
    ;
    builder.append("]");
    return builder.toString();
  }

  /**
   * The Enum GetDeltaResponseType.
   */
  public static enum GetDeltaResponseType {
    /**
     * The delta.
     */
    DELTA,
    /**
     * The no delta.
     */
    NO_DELTA,
    /**
     * The conf resync.
     */
    CONF_RESYNC
  }
}