com.phloc.web.smtp.impl.EmailAttachment Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * 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 com.phloc.web.smtp.impl;

import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.nio.charset.Charset;

import javax.activation.FileTypeMap;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.equals.EqualsUtils;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.io.IInputStreamProvider;
import com.phloc.commons.io.streamprovider.ByteArrayInputStreamProvider;
import com.phloc.commons.serialize.convert.SerializationConverter;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.web.smtp.EEmailAttachmentDisposition;
import com.phloc.web.smtp.IEmailAttachment;

/**
 * Base implementation for interface {@link IEmailAttachment}.
 * 
 * @author Philip Helger
 */
public class EmailAttachment implements IEmailAttachment
{
  public static final EEmailAttachmentDisposition DEFAULT_DISPOSITION = EEmailAttachmentDisposition.ATTACHMENT;

  private String m_sFilename;
  private IInputStreamProvider m_aInputStreamProvider;
  private Charset m_aCharset;
  private String m_sContentType;
  private EEmailAttachmentDisposition m_eDisposition;

  public EmailAttachment (@Nonnull @Nonempty final String sFilename, @Nonnull final byte [] aContent)
  {
    this (sFilename, aContent, (Charset) null);
  }

  public EmailAttachment (@Nonnull @Nonempty final String sFilename,
                          @Nonnull final byte [] aContent,
                          @Nullable final Charset aCharset)
  {
    this (sFilename, aContent, aCharset, DEFAULT_DISPOSITION);
  }

  public EmailAttachment (@Nonnull @Nonempty final String sFilename,
                          @Nonnull final byte [] aContent,
                          @Nullable final Charset aCharset,
                          @Nonnull final EEmailAttachmentDisposition eDisposition)
  {
    this (sFilename, new ByteArrayInputStreamProvider (aContent), aCharset, eDisposition);
  }

  public  EmailAttachment (@Nonnull @Nonempty final String sFilename,
                                                                            @Nonnull final ISP aInputStreamProvider)
  {
    this (sFilename, aInputStreamProvider, (Charset) null);
  }

  public  EmailAttachment (@Nonnull @Nonempty final String sFilename,
                                                                            @Nonnull final ISP aInputStreamProvider,
                                                                            @Nullable final Charset aCharset)
  {
    this (sFilename, aInputStreamProvider, aCharset, DEFAULT_DISPOSITION);
  }

  public  EmailAttachment (@Nonnull @Nonempty final String sFilename,
                                                                            @Nonnull final ISP aInputStreamProvider,
                                                                            @Nullable final Charset aCharset,
                                                                            @Nonnull final EEmailAttachmentDisposition eDisposition)
  {
    m_sFilename = ValueEnforcer.notEmpty (sFilename, "Filename");
    m_aInputStreamProvider = ValueEnforcer.notNull (aInputStreamProvider, "InputStreamProvider");
    m_aCharset = aCharset;
    m_sContentType = FileTypeMap.getDefaultFileTypeMap ().getContentType (sFilename);
    m_eDisposition = ValueEnforcer.notNull (eDisposition, "Disposition");
  }

  private void writeObject (@Nonnull final ObjectOutputStream aOOS) throws IOException
  {
    aOOS.writeUTF (m_sFilename);
    aOOS.writeObject (m_aInputStreamProvider);
    SerializationConverter.writeConvertedObject (m_aCharset, aOOS);
    aOOS.writeUTF (m_sContentType);
    aOOS.writeObject (m_eDisposition);
  }

  private void readObject (@Nonnull final ObjectInputStream aOIS) throws IOException, ClassNotFoundException
  {
    m_sFilename = aOIS.readUTF ();
    m_aInputStreamProvider = (IInputStreamProvider) aOIS.readObject ();
    m_aCharset = SerializationConverter.readConvertedObject (aOIS, Charset.class);
    m_sContentType = aOIS.readUTF ();
    m_eDisposition = (EEmailAttachmentDisposition) aOIS.readObject ();
  }

  @Nonnull
  @Nonempty
  public String getFilename ()
  {
    return m_sFilename;
  }

  @Nonnull
  public IInputStreamProvider getInputStreamProvider ()
  {
    return m_aInputStreamProvider;
  }

  @Nonnull
  public InputStream getInputStream ()
  {
    return m_aInputStreamProvider.getInputStream ();
  }

  @Nullable
  public Charset getCharset ()
  {
    return m_aCharset;
  }

  @Nullable
  public String getContentType ()
  {
    return m_sContentType;
  }

  @Nonnull
  public EEmailAttachmentDisposition getDisposition ()
  {
    return m_eDisposition;
  }

  @Nonnull
  public EmailAttachmentDataSource getAsDataSource ()
  {
    return new EmailAttachmentDataSource (m_aInputStreamProvider, m_sFilename, m_sContentType, m_eDisposition);
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;
    final EmailAttachment rhs = (EmailAttachment) o;
    return m_sFilename.equals (rhs.m_sFilename) &&
    // Does not necessarily implement equals!
    // m_aInputStreamProvider.equals (rhs.m_aInputStreamProvider) &&
           EqualsUtils.equals (m_aCharset, rhs.m_aCharset) &&
           EqualsUtils.equals (m_sContentType, rhs.m_sContentType) &&
           m_eDisposition.equals (rhs.m_eDisposition);
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_sFilename)
    // Does not necessarily implement hashCode!
    // .append (m_aInputStreamProvider)
                                       .append (m_aCharset)
                                       .append (m_sContentType)
                                       .append (m_eDisposition)
                                       .getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("filename", m_sFilename)
                                       .append ("inputStreamProvider", m_aInputStreamProvider)
                                       .appendIfNotNull ("charset", m_aCharset)
                                       .append ("contentType", m_sContentType)
                                       .append ("disposition", m_eDisposition)
                                       .toString ();
  }
}