IAIK PKCS#11 Provider API Documentation
version 1.6

iaik.apps.util.passphrase
Interface PassphraseInterfacce

All Known Subinterfaces:
NewPassphrasePrompt, PassphrasePrompt
All Known Implementing Classes:
NewPassphraseConsoleDialog, NewPassphraseDialog, NewPassphraseFrameDialog, NewPassphraseHolder, PassphraseConsoleDialog, PassphraseDialog, PassphraseFrameDialog, PassphraseHolder

public interface PassphraseInterfacce

This is the base interface for prompting PINs and passphrases from the user.


Method Summary
 boolean isCancelAllowed()
          True, if this prompt can be canceled by the user; i.e. the user need not enter a passphrase.
 void setCancelAllowed(boolean allowCancel)
          Set this prompt object to allow cancelling or not.
 void setMessage(java.lang.Object promptMessageObject)
          Set the prompt object that should be presented to the user as information what passphrase is required.
 void setProtectedResourceInfo(java.lang.Object protectedResourceInfo)
          Set the object that specifies the protectd resource; i.e. the resource to which the user needs to authenticate; e.g. the name of the smart card for which a PIN is required.
 

Method Detail

isCancelAllowed

boolean isCancelAllowed()
True, if this prompt can be canceled by the user; i.e. the user need not enter a passphrase.

Returns:
True, if this prompt can be canceled without entering a passphrase.
Postconditions
((result == false) implies (promptPassphrase() <> null))

setCancelAllowed

void setCancelAllowed(boolean allowCancel)
Set this prompt object to allow cancelling or not.

Parameters:
allowCancel - If true, canceling the prompt is allowed.
Postconditions
(allowedCancel == false) implies (promptPassphrase() <> null)

setMessage

void setMessage(java.lang.Object promptMessageObject)
Set the prompt object that should be presented to the user as information what passphrase is required. It is recommended that the toString() method of this object provides a telling output for the user. If the implementation knows the concrete class of the object it may use different means to create a message from the given object.

Parameters:
promptMessageObject - The object from which the implementation can get a human readable string that gives information what passphrase the user should enter.

setProtectedResourceInfo

void setProtectedResourceInfo(java.lang.Object protectedResourceInfo)
Set the object that specifies the protectd resource; i.e. the resource to which the user needs to authenticate; e.g. the name of the smart card for which a PIN is required. The PKCS#11 provider may provide a TokenInfo object.

Parameters:
protectedResourceInfo - The object that specifies the protected resource in more detail; e.g. the smart card. The PKCS#11 provider may provide a TokenInfo object.

IAIK PKCS#11 Provider API Documentation
version 1.6

IAIK JavaSecurity Website http://jce.iaik.tugraz.at/

IAIK at Graz University of Technology, Austria, Europe
Copyright 2001-2004, IAIK, Graz University of Technology, Inffeldgasse 16a, 8010 Graz, Austria. All Rights Reserved.
version 1.6