CiphertextTuple.java

  1. /**
  2.  *
  3.  * Copyright 2017 Paul Schaub
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.jivesoftware.smackx.omemo.internal;

  18. import static org.jivesoftware.smackx.omemo.element.OmemoElement.TYPE_OMEMO_PREKEY_MESSAGE;

  19. /**
  20.  * Bundles a decrypted ciphertext together with information about the message type.
  21.  *
  22.  * @author Paul Schaub
  23.  */
  24. public class CiphertextTuple {
  25.     private final byte[] ciphertext;
  26.     private final int messageType;

  27.     /**
  28.      * Create a new CiphertextTuple.
  29.      *
  30.      * @param ciphertext ciphertext
  31.      * @param type type
  32.      */
  33.     public CiphertextTuple(byte[] ciphertext, int type) {
  34.         this.ciphertext = ciphertext;
  35.         this.messageType = type;
  36.     }

  37.     /**
  38.      * Return the ciphertext.
  39.      *
  40.      * @return ciphertext part of the tuple
  41.      */
  42.     public byte[] getCiphertext() {
  43.         return ciphertext;
  44.     }

  45.     /**
  46.      * Return the messageType.
  47.      *
  48.      * @return type of the message
  49.      */
  50.     public int getMessageType() {
  51.         return this.messageType;
  52.     }

  53.     /**
  54.      * Returns true if this is a preKeyMessage.
  55.      *
  56.      * @return preKeyMessage?
  57.      */
  58.     public boolean isPreKeyMessage() {
  59.         return getMessageType() == TYPE_OMEMO_PREKEY_MESSAGE;
  60.     }
  61. }