com.phloc.web.smtp.impl.ReadonlySMTPSettings 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.nio.charset.Charset;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import com.phloc.commons.ValueEnforcer;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.web.smtp.EmailGlobalSettings;
import com.phloc.web.smtp.ISMTPSettings;

/**
 * Read-only implementation of the {@link ISMTPSettings} interface. It is
 * implemented by using a writable version and only accessing the read-methods.
 * THis is done to avoid code duplication.
 * 
 * @author Philip Helger
 */
@Immutable
public final class ReadonlySMTPSettings implements ISMTPSettings
{
  private static final long serialVersionUID = -7425491209978875323L;
  private final SMTPSettings m_aSettings;

  /**
   * Constructor for internal deserialization only
   * 
   * @param aOther
   *        The settings to use. May not be null.
   */
  ReadonlySMTPSettings (@Nonnull final SMTPSettings aOther)
  {
    this.m_aSettings = ValueEnforcer.notNull (aOther, "Other"); //$NON-NLS-1$
  }

  /**
   * Constructor which copies settings from another object
   * 
   * @param aOther
   *        The settings to use. May not be null.
   */
  public ReadonlySMTPSettings (@Nonnull final ISMTPSettings aOther)
  {
    this (aOther.getHostName (),
          aOther.getPort (),
          aOther.getUserName (),
          aOther.getPassword (),
          aOther.getCharset (),
          aOther.isSSLEnabled (),
          aOther.isSTARTTLSEnabled (),
          aOther.getConnectionTimeoutMilliSecs (),
          aOther.getTimeoutMilliSecs ());
  }

  /**
   * Constructor with default port, and no authentication
   * 
   * @param sHostName
   *        SMTP server name or IP address. May neither be null nor
   *        empty.
   */
  public ReadonlySMTPSettings (@Nonnull final String sHostName)
  {
    this (sHostName, -1, null, null, null, EmailGlobalSettings.isUseSSL ());
  }

  /**
   * Constructor
   * 
   * @param sHostName
   *        SMTP server name or IP address. May neither be null nor
   *        empty.
   * @param nPort
   *        Port to use. May be -1 for the default port.
   * @param sUserName
   *        The username to use. May be null.
   * @param sPassword
   *        The password to use. May be null.
   * @param sCharset
   *        The charset to use. May be null.
   * @param bSSLEnabled
   *        true to enable SSL communications
   */
  public ReadonlySMTPSettings (@Nonnull final String sHostName,
                               final int nPort,
                               @Nullable final String sUserName,
                               @Nullable final String sPassword,
                               @Nullable final String sCharset,
                               final boolean bSSLEnabled)
  {
    this (sHostName,
          nPort,
          sUserName,
          sPassword,
          sCharset,
          bSSLEnabled,
          EmailGlobalSettings.isUseSTARTTLS (),
          EmailGlobalSettings.getConnectionTimeoutMilliSecs (),
          EmailGlobalSettings.getTimeoutMilliSecs ());
  }

  /**
   * Constructor
   * 
   * @param sHostName
   *        SMTP server name or IP address. May neither be null nor
   *        empty.
   * @param nPort
   *        Port to use. May be -1 for the default port.
   * @param sUserName
   *        The username to use. May be null.
   * @param sPassword
   *        The password to use. May be null.
   * @param sCharset
   *        The charset to use. May be null.
   * @param bSSLEnabled
   *        true to enable SSL communications
   * @param bSTARTTLSEnabled
   *        true to enable STARTTLS communications
   * @param nConnectTimeoutMilliSecs
   *        the connection timeout in milliseconds.
   * @param nTimeoutMilliSecs
   *        the socket timeout in milliseconds.
   */
  public ReadonlySMTPSettings (@Nonnull final String sHostName,
                               final int nPort,
                               @Nullable final String sUserName,
                               @Nullable final String sPassword,
                               @Nullable final String sCharset,
                               final boolean bSSLEnabled,
                               final boolean bSTARTTLSEnabled,
                               final long nConnectTimeoutMilliSecs,
                               final long nTimeoutMilliSecs)
  {
    this.m_aSettings = new SMTPSettings (sHostName,
                                         nPort,
                                         sUserName,
                                         sPassword,
                                         sCharset,
                                         bSSLEnabled,
                                         bSTARTTLSEnabled,
                                         nConnectTimeoutMilliSecs,
                                         nTimeoutMilliSecs);
  }

  @Override
  @Nonnull
  public String getHostName ()
  {
    return this.m_aSettings.getHostName ();
  }

  @Override
  public int getPort ()
  {
    return this.m_aSettings.getPort ();
  }

  @Override
  @Nullable
  public String getUserName ()
  {
    return this.m_aSettings.getUserName ();
  }

  @Override
  @Nullable
  public String getPassword ()
  {
    return this.m_aSettings.getPassword ();
  }

  @Override
  @Nonnull
  public String getCharset ()
  {
    return this.m_aSettings.getCharset ();
  }

  @Override
  @Nonnull
  public Charset getCharsetObj ()
  {
    return this.m_aSettings.getCharsetObj ();
  }

  @Override
  public boolean isSSLEnabled ()
  {
    return this.m_aSettings.isSSLEnabled ();
  }

  @Override
  public boolean isSTARTTLSEnabled ()
  {
    return this.m_aSettings.isSTARTTLSEnabled ();
  }

  @Override
  public long getConnectionTimeoutMilliSecs ()
  {
    return this.m_aSettings.getConnectionTimeoutMilliSecs ();
  }

  @Override
  public long getTimeoutMilliSecs ()
  {
    return this.m_aSettings.getTimeoutMilliSecs ();
  }

  @Override
  public boolean areRequiredFieldsSet ()
  {
    return this.m_aSettings.areRequiredFieldsSet ();
  }

  @Override
  public boolean equals (final Object o)
  {
    if (this == o)
      return true;
    if (!(o instanceof ReadonlySMTPSettings))
      return false;
    final ReadonlySMTPSettings rhs = (ReadonlySMTPSettings) o;
    return this.m_aSettings.equals (rhs.m_aSettings);
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (this.m_aSettings).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("settings", this.m_aSettings).toString (); //$NON-NLS-1$
  }
}