iaik.pkcs.pkcs11.DefaultInitializeArgs Maven / Gradle / Ivy

// Copyright (c) 2002 Graz University of Technology. All rights reserved.
//
// 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.
//
// 3. The end-user documentation included with the redistribution, if any, must
//    include the following acknowledgment:
//
//    "This product includes software developed by IAIK of Graz University of
//     Technology."
//
//    Alternately, this acknowledgment may appear in the software itself, if and
//    wherever such third-party acknowledgments normally appear.
//
// 4. The names "Graz University of Technology" and "IAIK of Graz University of
//    Technology" must not be used to endorse or promote products derived from
//    this software without prior written permission.
//
// 5. Products derived from this software may not be called "IAIK PKCS Wrapper",
//    nor may "IAIK" appear in their name, without prior written permission of
//    Graz University of Technology.
//
// THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED 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 LICENSOR 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.

package iaik.pkcs.pkcs11;

/**
 * This class is a simple implementation of InitializeArgs.
 *
 * @author Karl Scheibelhofer
 * @version 1.0
 */
public class DefaultInitializeArgs implements InitializeArgs {

  /**
   * The mutex-handler of this object.
   */
  private MutexHandler mutexHandler;

  /**
   * Indicates that application threads which are executing calls to the
   * library may not use native operating system calls to spawn new threads.
   */
  private boolean libraryCantCreateOsThreads;

  /**
   * Indicates that the library may use mechanisms of the operating-system
   * to do thread-locking.
   */
  private boolean osLockingOk;

  /**
   * The reserved parameter in the initialization arguments.
   */
  private Object reserved;

  /**
   * Default constructor.
   */
  public DefaultInitializeArgs() {
    mutexHandler = null;
    libraryCantCreateOsThreads = false;
    osLockingOk = true;
    reserved = null;
  }

  /**
   * Constructor, taking a mutex-handler, the libraryCantCreateOsThreads flag
   * and the osLockingOk flag.
   *
   * @param mutexHandler
   *          The PKCS#11 module should use this mutex-handler.
   * @param libraryCantCreateOsThreads
   *          Indicates that application threads which are executing calls to
   *          the library may not use native operating system calls to spawn
   *          new threads .
   * @param osLockingOk
   *          Indicates that the library may use mechanisms of the
   *          operating-system to do thread-locking.
   */
  public DefaultInitializeArgs(MutexHandler mutexHandler,
      boolean libraryCantCreateOsThreads, boolean osLockingOk) {
    this.mutexHandler = mutexHandler;
    this.libraryCantCreateOsThreads = libraryCantCreateOsThreads;
    this.osLockingOk = osLockingOk;
    this.reserved = null;
  }

  /**
   * Returns the object that implements the functionality for
   * handling mutexes. It returns null, if no handler is set. If this method
   * returns null, the wrapper does not pass any callback functions to the
   * underlying module; i.e. is passes null-pointer for the functions.
   *
   * @return The handler object for mutex functionality, or null, if there is
   *         no handler for mutexes.
   */
  @Override
  public MutexHandler getMutexHandler() {
    return mutexHandler;
  }

  /**
   * Check, if application threads which are executing calls to the library
   * may not use native operating system calls to spawn new threads.
   *
   * @return True, if application threads which are executing calls to the
   *         library may not use native operating system calls to spawn new
   *         threads. False, if they may.
   */
  @Override
  public boolean isLibraryCantCreateOsThreads() {
    return libraryCantCreateOsThreads;
  }

  /**
   * Check, if the library can use the native operation system threading model
   * for locking.
   *
   * @return True, if the library can use the native operation system
   *         threading model for locking. False, otherwise.
   */
  @Override
  public boolean isOsLockingOk() {
    return osLockingOk;
  }

  /**
   * Reserved parameter.
   *
   * @return Should be null in this version.
   */
  public Object getReserved() {
    return reserved;
  }

  /**
   * This method sets the object that implements the functionality for
   * handling mutexes. It should be null to set no handler.
   *
   * @param mutexHandler
   *          The handler object for mutex functionality, or null to use no
   *          handler.
   */
  public void setMutexHandler(MutexHandler mutexHandler) {
    this.mutexHandler = mutexHandler;
  }

  /**
   * Set, if application threads which are executing calls to the library may
   * not use native operating system calls to spawn new threads.
   *
   * @param libraryCantCreateOsThreads
   *          True, if application threads which are executing calls to the
   *          library may not use native operating system calls to spawn new
   *          threads. False, if they may.
   */
  public void setLibraryCantCreateOsThreads(
      boolean libraryCantCreateOsThreads) {
    this.libraryCantCreateOsThreads = libraryCantCreateOsThreads;
  }

  /**
   * set, if the library can use the native operation system threading model
   * for locking.
   *
   * @param osLockingOk
   *          True, if the library can use the native operation system
   *          threading model for locking. False, otherwise.
   */
  public void setOsLockingOk(boolean osLockingOk) {
    this.osLockingOk = osLockingOk;
  }

  /**
   * Set the reserved parameter.
   *
   * @param reserved
   *          Should be null in this version.
   */
  public void setReserved(Object reserved) {
    this.reserved = reserved;
  }

  /**
   * Returns the string representation of this object.
   *
   * @return The string representation of object
   */
  @Override
  public String toString() {
    return Util.concatObjects(
      "Mutex Handler: ", ((mutexHandler != null) ? "present" : "not present"),
      "\nLibrary can't create OS-Threads: ", libraryCantCreateOsThreads,
      "\nOS-Locking OK: ", osLockingOk,
      "\nThe reserved parameter is: ",
      ((reserved != null) ? reserved : "null"));
  }

}