Message.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.transport.message;

import org.kaaproject.kaa.server.transport.channel.ChannelAware;
import org.kaaproject.kaa.server.transport.platform.PlatformAware;

/**
 * Represents a channel and platform aware message that is produced by transport
 * channels.
 *
 * @author Andrew Shvayka
 */
public interface Message extends ChannelAware, PlatformAware {

  /**
   * Returns the message builder.
   *
   * @return the message builder
   */
  MessageBuilder getMessageBuilder();

  /**
   * Returns the error builder.
   *
   * @return the error builder
   */
  ErrorBuilder getErrorBuilder();

  /**
   * Indicates that the message is encrypted.
   *
   * @return true if the message is encrypted, false otherwise.
   */
  boolean isEncrypted();

}