net.sf.crypton.scard.pcscwrapper

Class PcscliteWrapper

java.lang.Object

net.sf.crypton.scard.pcscwrapper.PcscliteWrapper

public class PcscliteWrapper
extends Object

Wrapper of the PcscliteLibrary that provides convenience access methods, hide all the JNA dirty details, and includes some parsing of the results. TODO: see this tutorial and implement remaining methods http://ludovicrousseau.blogspot.fr/2011/11/pcsc-api-spy-third-try.html For developers: please do not move or rename this class since it's referenced by reflection in ReaderUtils.java

See Also:

PcscliteLibrary

Field Summary

Fields

Modifier and Type	Field and Description
protected PcscliteLibrary	instance
protected String	nativeLocation

Constructor Summary

Constructors

Constructor and Description
PcscliteWrapper()
PcscliteWrapper(String nativeLocation)

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose()
protected String	getNativeLocation()
CardHandle	sCardConnect(long hContext, String readerName, CardShareMode shareMode, SCardProtocol... preferredProtocols) The sCardConnect function establishes a connection (using a specific resource manager context) between the calling application and a smart card contained by a specific reader.
void	sCardDisconnect(CardHandle hCard, int dwDisposition) The SCardDisconnect function terminates a connection previously opened between the calling application and a smart card in the target reader.
long	sCardEstablishContext(int scope)
PcscReaderState[]	sCardGetStatusChange(long hContext, int timeout, PcscReaderState[] rState) Blocks execution until the current availability of the cards in a specific set of readers changes.
boolean	sCardisValidContext(long hContext)
String[]	sCardListReaderGroups(long hContext)
String[]	sCardListReaders(long hContext)
void	sCardReleaseContext(long hContext)
void	sCardSetTimeout(long hContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nativeLocation

protected final String nativeLocation

instance

protected PcscliteLibrary instance

Constructor Detail

PcscliteWrapper

public PcscliteWrapper()
                throws IOException

Throws:

IOException

PcscliteWrapper

public PcscliteWrapper(String nativeLocation)
                throws IOException

Throws:

IOException

Method Detail

getNativeLocation

protected String getNativeLocation()

dispose

public void dispose()

sCardEstablishContext

public long sCardEstablishContext(int scope)
                           throws PcscException

Throws:

PcscException

sCardGetStatusChange

public PcscReaderState[] sCardGetStatusChange(long hContext,
                                     int timeout,
                                     PcscReaderState[] rState)
                                       throws PcscException

Blocks execution until the current availability of the cards in a specific set of readers changes.

This function receives a structure or list of structures containing reader names. It then blocks waiting for a change in state to occur for a maximum blocking time of dwTimeout or forever if INFINITE is used.

Sample usage:

 PcscLiteWrapper pcscw=...
 		long hContext= pcscw.sCardEstablishContext(PcscLiteConstants.SCARD_SCOPE_USER);
  	String[] terminals = pcscw.sCardListReaders(context);
  	final PcscReaderState[] rstates = new PcscReaderState[terminals.length];
 		for (int i = 0; i < terminals.length; i++) {
 			final String tname = terminals[i];
 			rstates[i] = new PcscReaderState(null,
 				PcscLiteConstants.SCARD_STATE_UNAWARE, 0, tname, null);
 		}
 		// set the timeout to 5 second 		
  	final PcscReaderState[] result = pcscw.sCardGetStatusChange(
 				context, 5000, rstates);
 
 		for (int i = 0; i < result.length; i++) {
 			final PcscReaderState state = result[i];
 			final int eventState = state.getEventState();
 			if (((eventState & PcscLiteConstants.SCARD_STATE_PRESENT) != 0)
 				&& (state.getATR() != null) && (state.getATR().length > 0)) {
 				if ((eventState & (PcscLiteConstants.SCARD_STATE_MUTE | PcscLiteConstants.SCARD_STATE_UNAVAILABLE)) == 0) {
 					System.out.println(StringUtilsCN.toHexString(state
 							.getATR());
 				}
 			}
 		}
 
 

Parameters:

hContext - Active pc/sc context as returned by sCardEstablishContext(int)

timeout - timeout of the request in milliseconds.

rState - Array of reader state.

Returns:

Throws:

PcscException - Thrown when there is an error in PC/SC. Use PcscException.getErrorCode() to get the error code.

See Also:

PcscliteLibrary#SCardGetStatusChange(NativeLong, int, SCARD_READERSTATE_A, int)}

sCardListReaders

public String[] sCardListReaders(long hContext)
                          throws PcscException

Throws:

PcscException

sCardListReaderGroups

public String[] sCardListReaderGroups(long hContext)
                               throws PcscException

Parameters:

hContext - Active pc/sc context as returned by sCardEstablishContext(int)

Returns:

Throws:

PcscException

See Also:

SCardListReaderGroups

sCardReleaseContext

public void sCardReleaseContext(long hContext)
                         throws PcscException

Throws:

PcscException

sCardisValidContext

public boolean sCardisValidContext(long hContext)

Parameters:

hContext - Active pc/sc context as returned by sCardEstablishContext(int)

Returns:

See Also:

PcscliteLibrary.SCardIsValidContext(com.sun.jna.NativeLong)

sCardSetTimeout

public void sCardSetTimeout(long hContext)
                     throws PcscException

Throws:

PcscException

sCardConnect

public CardHandle sCardConnect(long hContext,
                      String readerName,
                      CardShareMode shareMode,
                      SCardProtocol... preferredProtocols)
                        throws PcscException

The sCardConnect function establishes a connection (using a specific resource manager context) between the calling application and a smart card contained by a specific reader. If no card exists in the specified reader, an error is returned.

Parameters:

hContext - Active pc/sc context as returned by sCardEstablishContext(int)

readerName -

shareMode - flag that indicates whether other applications may form connections to the card. CardShareMode

preferredProtocols -

Throws:

PcscException

sCardDisconnect

public void sCardDisconnect(CardHandle hCard,
                   int dwDisposition)
                     throws PcscException

The SCardDisconnect function terminates a connection previously opened between the calling application and a smart card in the target reader.

Parameters:

hCard - Reference value obtained from a previous call to sCardConnect(long, String, CardShareMode, SCardProtocol...) .

dwDisposition - Action to take on the card in the connected reader on close.

Throws:

PcscException

See Also:

PcscliteWrapper#sCardConnect(long, String, CardShareMode, SCardProtocol...)}