/**
 * 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.cert;

import java.io.InputStream;
import java.io.OutputStream;

import javax.annotation.Nonnull;

import com.helger.as2lib.exception.OpenAS2Exception;
import com.helger.as2lib.params.InvalidParameterException;

/**
 * Base interface for a certificate factory that can store to a file.
 *
 * @author Philip Helger
 */
public interface IStorableCertificateFactory extends ICertificateFactory
{
  boolean DEFAULT_SAVE_CHANGES_TO_FILE = true;

  void setFilename (String sFilename);

  String getFilename () throws InvalidParameterException;

  void setPassword (@Nonnull char [] aPassword);

  char [] getPassword () throws InvalidParameterException;

  /**
   * Change the behavior if all changes should trigger a saving to the original
   * file. The default value is {@link #DEFAULT_SAVE_CHANGES_TO_FILE}.
   *
   * @param bSaveChangesToFile
   *        <code>true</code> to enable auto-saving, <code>false</code> to
   *        disable it.
   */
  void setSaveChangesToFile (boolean bSaveChangesToFile);

  /**
   * @return <code>true</code> if changes to the key store should be persisted
   *         back to the original file, <code>false</code> if not. The default
   *         value is {@link #DEFAULT_SAVE_CHANGES_TO_FILE}.
   */
  boolean isSaveChangesToFile ();

  /**
   * Shortcut for <code>load (getFilename (), getPassword ());</code>
   *
   * @throws OpenAS2Exception
   *         In case of an internal error
   */
  void load () throws OpenAS2Exception;

  void load (@Nonnull String sFilename, @Nonnull char [] aPassword) throws OpenAS2Exception;

  void load (@Nonnull InputStream aIS, @Nonnull char [] aPassword) throws OpenAS2Exception;

  /**
   * Shortcut for <code>save (getFilename (), getPassword ());</code>
   *
   * @throws OpenAS2Exception
   *         In case of an internal error
   */
  void save () throws OpenAS2Exception;

  void save (@Nonnull String sFilename, @Nonnull char [] aPassword) throws OpenAS2Exception;

  void save (@Nonnull OutputStream aOS, @Nonnull char [] aPassword) throws OpenAS2Exception;
}