net.sf.mmm.crypto.io.CryptoResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-crypto-jce Show documentation

Library for simple and more secure usage of cryptography (JCA and JCE).

The newest version!

package net.sf.mmm.crypto.io;

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

/**
 * Interface for a resource such as a {@link java.io.File}.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public interface CryptoResource {

  /**
   * @return the URI of this resource.
   */
  String getUri();

  /**
   * @return {@code true} if this resource already exists, {@code false} otherwise.
   */
  boolean exists();

  /**
   * @return a new {@link InputStream} to read this resource.
   * @throws IllegalStateException if this resource does not {@link #exists() exist}.
   */
  InputStream openInputStream();

  /**
   * @return a new {@link OutputStream} to write to this resource. If the resource already {@link #exists() exists} the
   *         data written to the {@link OutputStream} will overwrite all existing data. Otherwise (if not yet
   *         {@link #exists() exists}) it will be created.
   */
  OutputStream openOutputStream();

}