AS2Message.java

/**
 * The FreeBSD Copyright
 * Copyright 1994-2008 The FreeBSD Project. All rights reserved.
 * Copyright (C) 2013-2017 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 com.helger.as2lib.CAS2Info;
import com.helger.as2lib.params.CompositeParameters;
import com.helger.as2lib.params.DateParameters;
import com.helger.as2lib.params.InvalidParameterException;
import com.helger.as2lib.params.MessageParameters;
import com.helger.as2lib.params.RandomParameters;
import com.helger.as2lib.partner.Partnership;
import com.helger.as2lib.util.CAS2Header;
import com.helger.commons.annotation.Nonempty;

public class AS2Message extends AbstractMessage
{
  /** Indicator whether the message was received (or created) */
  public static final String ATTRIBUTE_RECEIVED = "as2msg.received";
  public static final String ATTRIBUTE_RECEIVED_ENCRYPTED = "as2msg.received.encrypted";
  public static final String ATTRIBUTE_RECEIVED_SIGNED = "as2msg.received.signed";
  public static final String ATTRIBUTE_RECEIVED_COMPRESSED = "as2msg.received.compressed";

  public static final String PROTOCOL_AS2 = "as2";
  public static final String DEFAULT_ID_FORMAT = CAS2Info.NAME +
                                                 "-$date.ddMMyyyyHHmmssZ$-$rand.1234$@$msg.sender.as2_id$_$msg.receiver.as2_id$";

  public AS2Message ()
  {}

  @Nonnull
  @Nonempty
  public final String getProtocol ()
  {
    return PROTOCOL_AS2;
  }

  @Override
  @Nonnull
  @Nonempty
  public String generateMessageID ()
  {
    final CompositeParameters aParams = new CompositeParameters (false).add ("date", new DateParameters ())
                                                                       .add ("msg", new MessageParameters (this))
                                                                       .add ("rand", new RandomParameters ());

    final String sIDFormat = getPartnership ().getMessageIDFormat (DEFAULT_ID_FORMAT);

    final StringBuilder aSB = new StringBuilder ();
    aSB.append ('<');
    try
    {
      aSB.append (aParams.format (sIDFormat));
    }
    catch (final InvalidParameterException ex)
    {
      // useless, but what to do?
      aSB.append (sIDFormat);
    }
    aSB.append ('>');
    return aSB.toString ();
  }

  public boolean isRequestingMDN ()
  {
    // Requesting by partnership?
    final Partnership aPartnership = getPartnership ();
    final boolean bRequesting = aPartnership.getAS2MDNTo () != null || aPartnership.getAS2MDNOptions () != null;
    if (bRequesting)
      return true;

    // Requesting by request?
    final boolean bRequested = getHeader (CAS2Header.HEADER_DISPOSITION_NOTIFICATION_TO) != null ||
                               getHeader (CAS2Header.HEADER_DISPOSITION_NOTIFICATION_OPTIONS) != null;
    return bRequested;
  }

  public boolean isRequestingAsynchMDN ()
  {
    // Requesting by partnership?
    final Partnership aPartnership = getPartnership ();
    // Same as regular MDN + PA_AS2_RECEIPT_OPTION
    final boolean bRequesting = (aPartnership.getAS2MDNTo () != null || aPartnership.getAS2MDNOptions () != null) &&
                                aPartnership.getAS2ReceiptOption () != null;
    if (bRequesting)
      return true;

    // Requesting by request?
    // Same as regular MDN + HEADER_RECEIPT_DELIVERY_OPTION
    final boolean bRequested = (getHeader (CAS2Header.HEADER_DISPOSITION_NOTIFICATION_TO) != null ||
                                getHeader (CAS2Header.HEADER_DISPOSITION_NOTIFICATION_OPTIONS) != null) &&
                               getHeader (CAS2Header.HEADER_RECEIPT_DELIVERY_OPTION) != null;
    return bRequested;
  }

  @Nullable
  public String getAsyncMDNurl ()
  {
    return getHeader (CAS2Header.HEADER_RECEIPT_DELIVERY_OPTION);
  }
}