com.helger.as2lib.message.IMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of as2-lib Show documentation
Open AS2 fork - library part
There is a newer version: 3.1.0
/**
 * The FreeBSD Copyright
 * Copyright 1994-2008 The FreeBSD Project. All rights reserved.
 * Copyright (C) 2013-2016 Philip Helger philip[at]helger[dot]com
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *    1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE FREEBSD PROJECT ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FREEBSD PROJECT OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation
 * are those of the authors and should not be interpreted as representing
 * official policies, either expressed or implied, of the FreeBSD Project.
 */
package com.helger.as2lib.message;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.mail.internet.MimeBodyPart;

import com.helger.commons.annotation.Nonempty;

/**
 * Base interface for an AS2 Message
 *
 * @author Philip Helger
 */
public interface IMessage extends IBaseMessage
{
  /**
   * Shortcut for getHeader (CAS2Header.HEADER_AS2_FROM)
   *
   * @return Sender ID
   */
  @Nullable
  String getAS2From ();

  /**
   * Shortcut for getHeader (CAS2Header.HEADER_AS2_TO)
   *
   * @return Receiver ID
   */
  @Nullable
  String getAS2To ();

  @Nullable
  String getContentType ();

  void setContentType (@Nullable String sContentType);

  @Nullable
  String getContentDisposition ();

  void setContentDisposition (@Nullable String sContentDisposition);

  @Nullable
  String getSubject ();

  void setSubject (@Nullable String sSubject);

  @Nullable
  MimeBodyPart getData ();

  void setData (@Nonnull MimeBodyPart aData);

  @Nullable
  IMessageMDN getMDN ();

  void setMDN (@Nullable IMessageMDN aMDN);

  @Nonnull
  @Nonempty
  String getLoggingText ();

  String getProtocol ();

  boolean isRequestingMDN ();

  boolean isRequestingAsynchMDN ();
}