javax.microedition.jcrmi
Interface JavaCardRMIConnection

All Superinterfaces:
Connection

public interface JavaCardRMIConnection
extends Connection

This interface defines the Java Card RMI connection which can be used by J2ME applications to communicate with applications on a smart card using Java Card RMI protocol.

Since:
JDE 4.2.1

Field Summary
static short PINENTRY_CANCELLED
          This status is returned to the calling J2ME application if the operation for PIN verification/change/disable/ enable/unblock was not successful because the user cancelled the PIN entry request.
 
Method Summary
 short changePin(int pinID)
          A call to changePin method pops up a UI that requests the user for an old or existing PIN value and the new PIN value to change the value of the PIN.
 short disablePin(int pinID)
          A call to disablePin method pops up a UI that requests the user to enter the value for the PIN that is to be disabled.
 short enablePin(int pinID)
          A call to enablePin method pops up a UI that requests the user to enter the value for the PIN that is to be enabled.
 short enterPin(int pinID)
          A call to enterPin method pops up a UI that requests the PIN from the user.
 Remote getInitialReference()
          Returns the stub object for an initial remote reference.
 short unblockPin(int blockedPinID, int unblockingPinID)
          This is a high-level method that lets the J2ME application ask the user to enter the value for an unblocking PIN, and the new value for the blocked PIN and send these to the card.
 
Methods inherited from interface javax.microedition.io.Connection
close
 

Field Detail

PINENTRY_CANCELLED

public static final short PINENTRY_CANCELLED
This status is returned to the calling J2ME application if the operation for PIN verification/change/disable/ enable/unblock was not successful because the user cancelled the PIN entry request.
Since:
JDE 4.2.1
Method Detail

changePin

public short changePin(int pinID)
                throws RemoteException
A call to changePin method pops up a UI that requests the user for an old or existing PIN value and the new PIN value to change the value of the PIN. The pinID field indicates which PIN is to be changed. The user can either cancel the request or continue. If the user enters the PIN values and chooses to continue the implementation is responsible for presenting the old and new values of the PIN to the card. If padding is required for the PIN, the implementation is responsible for providing appropriate padding.
Parameters:
pinID - the type of PIN the implementation is suppose to prompt the user to change.
Returns:
PINENTRY_CANCELLED if the user cancelled the PIN entry request or the value returned by the remote method.
Throws:
RemoteException - - is thrown if the PIN could not be communicated to the card or an exception is thrown by the card in response to the PIN entry.
SecurityException - - is thrown if the J2ME application does not have appropriate rights to ask for changing the PIN value.
UnsupportedOperationException - - is thrown if the implementation does not support this method.
Since:
JDE 4.2.1

disablePin

public short disablePin(int pinID)
                 throws RemoteException
A call to disablePin method pops up a UI that requests the user to enter the value for the PIN that is to be disabled. The pinID field indicates which PIN is to be disabled. The user can either cancel the request or continue. If the user enters the PIN and chooses to continue the implementation is responsible for presenting the PIN value to the card to disable PIN. If padding is required for the PIN, the implementation is responsible for providing appropriate padding.
Parameters:
pinID - the type of PIN the implementation is required to prompt the user to enter.
Returns:
PINENTRY_CANCELLED if the user cancelled the PIN entry request or the value returned by the remote method.
Throws:
RemoteException - - is thrown if the PIN could not be communicated to the card or an exception is thrown by the card in response to the PIN entry.
SecurityException - - is thrown if the J2ME application does not have appropriate rights to ask for disabling the PIN.
UnsupportedOperationException - - is thrown if the implementation does not support this method.
Since:
JDE 4.2.1

enablePin

public short enablePin(int pinID)
                throws RemoteException
A call to enablePin method pops up a UI that requests the user to enter the value for the PIN that is to be enabled. The pinID field indicates which PIN is to be enabled. The user can either cancel the request or continue. If the user enters the PIN and chooses to continue the implementation is responsible for presenting the PIN value to the card for enabling the PIN. If padding is required for the PIN, the implementation is responsible for providing appropriate padding.
Parameters:
pinID - the type of PIN the implementation is required to prompt the user to enter.
Returns:
PINENTRY_CANCELLED if the user cancelled the PIN entry request or the value returned by the remote method.
Throws:
RemoteException - - is thrown if the PIN could not be communicated to the card or an exception is thrown by the card in response to the PIN entry.
SecurityException - - is thrown if the J2ME application does not have appropriate rights to ask for enabling the PIN.
UnsupportedOperationException - - is thrown if the implementation does not support this method.
Since:
JDE 4.2.1

enterPin

public short enterPin(int pinID)
               throws RemoteException
A call to enterPin method pops up a UI that requests the PIN from the user. The pinID field indicates which PIN must be requested from the user. The user can either cancel the request or continue. If the user enters the PIN and chooses to continue, The implementation is responsible for presenting the PIN entered by the user to the card for verification. If padding is required for the PIN, the implementation is responsible for providing appropriate padding.
Parameters:
pinID - the type of PIN the implementation is suppose to prompt the user to enter.
Returns:
PINENTRY_CANCELLED if the user cancelled the PIN entry request or the value returned by the remote method.
Throws:
RemoteException - - is thrown if the PIN could not be communicated to the card or an exception is thrown by the card in response to the PIN entry.
SecurityException - - is thrown if the J2ME application does not have appropriate rights to ask for PIN verification.
UnsupportedOperationException - - is thrown if the implementation does not support this method.
Since:
JDE 4.2.1

getInitialReference

public Remote getInitialReference()
Returns the stub object for an initial remote reference.
Returns:
the initial remote reference
Since:
JDE 4.2.1

unblockPin

public short unblockPin(int blockedPinID,
                        int unblockingPinID)
                 throws RemoteException
This is a high-level method that lets the J2ME application ask the user to enter the value for an unblocking PIN, and the new value for the blocked PIN and send these to the card. A call to unblockPin method pops up a UI that requests the user to enter the value for the unblocking PIN and the new value for the blocked PIN. The unblockingPinID field indicates which unblocking PIN is to be used to unblock the blocked PIN which is indicated by the field blockedPinID. The user can either cancel the request or continue. If the user enters the PIN values and chooses to continue, the implementation is responsible for presenting the PIN values to the card for unblocking the blocked PIN. If padding is required for either of the PIN values, the implementation is responsible for providing appropriate padding.
Parameters:
blockedPinID - the ID of PIN that is to be unblocked.
unblockingPinID - the ID of unblocking PIN.
Returns:
PINENTRY_CANCELLED if the user cancelled the PIN entry request or the value returned by the remote method.
Throws:
RemoteException - - is thrown if the PIN could not be communicated to the card or an exception is thrown by the card in response to the PIN entry.
SecurityException - - is thrown if the J2ME application does not have appropriate rights to ask for unblocking the PIN.
UnsupportedOperationException - - is thrown if the implementation does not support this method.
Since:
JDE 4.2.1



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.