001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019
020package org.apache.reef.runtime.common.driver.evaluator.pojos;
021
022import org.apache.reef.annotations.audience.DriverSide;
023import org.apache.reef.annotations.audience.Private;
024import org.apache.reef.io.Numberable;
025import org.apache.reef.proto.ReefServiceProtos;
026
027/**
028 *  DriverSide representation of ContextMessageProto.
029 */
030@DriverSide
031@Private
032public final class ContextMessagePOJO implements Numberable {
033
034  private final byte[] message;
035  private final String sourceId;
036  private final long sequenceNumber;
037
038
039  ContextMessagePOJO(final ReefServiceProtos.ContextStatusProto.ContextMessageProto proto, final long sequenceNumber){
040    message = proto.getMessage().toByteArray();
041    sourceId = proto.getSourceId();
042    this.sequenceNumber = sequenceNumber;
043  }
044
045  /**
046   * @return the serialized message from a context.
047   */
048  public byte[] getMessage(){
049    return message;
050  }
051
052  /**
053   * @return the ID of the ContextMessageSource that sent the message.
054   */
055  public String getSourceId(){
056    return sourceId;
057  }
058
059  /**
060   * @return the sequence number of a message
061   *
062   * {@see ContextMessage#getSequenceNumber()}
063   */
064  @Override
065  public long getSequenceNumber(){
066    return this.sequenceNumber;
067  }
068}