PCSC4Java  0.2
Library PCSC for Java language.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
fr.redbilled.pcscforjava.TerminalFactory Class Reference

List of all members.

Classes

class  NoneCardTerminals
class  NoneFactorySpi
class  NoneProvider

Public Member Functions

void releaseContext ()
Provider getProvider ()
String getType ()
CardTerminals terminals ()
String toString ()

Static Public Member Functions

static void setPnPCallback (CardTerminalsEvent cardTerminalsEvent)
static void removePnPCallback (CardTerminalsEvent cardTerminalsEvent)
static List getPnPCallbacks ()
static String getDefaultType ()
static TerminalFactory getDefault ()
static TerminalFactory getInstance (String type, Object params) throws NoSuchAlgorithmException
static TerminalFactory getInstance (String type, Object params, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
static TerminalFactory getInstance (String type, Object params, Provider provider) throws NoSuchAlgorithmException

Detailed Description

A factory for CardTerminal objects.

It allows an application to

Each TerminalFactory has a type indicating how it was implemented. It must be specified when the implementation is obtained using a getInstance getInstance()} method and can be retrieved via the getType} method.

The following standard type names have been defined:

PC/SC
an implementation that calls into the PC/SC Smart Card stack of the host platform. Implementations do not require parameters and accept "null" as argument in the getInstance() calls.
None
an implementation that does not supply any CardTerminals. On platforms that do not support other implementations, getDefaultType} returns None and getDefault} returns an instance of a None TerminalFactory. Factories of this type cannot be obtained by calling the getInstance() methods.

Additional standard types may be defined in the future.

Note: Provider implementations that accept initialization parameters via the getInstance() methods are strongly encouraged to use a java.util.Properties} object as the representation for String name-value pair based parameters whenever possible. This allows applications to more easily interoperate with multiple providers than if each provider used different provider specific class as parameters.

TerminalFactory utilizes an extensible service provider framework. Service providers that wish to add a new implementation should see the TerminalFactorySpi} class for more information.

See also:
CardTerminals
Provider
Since:
1.6
Author:
Andreas Sterbenz
JSR 268 Expert Group

Definition at line 92 of file TerminalFactory.java.


Member Function Documentation

Returns the default TerminalFactory instance. See getDefaultType} for more information.

A default TerminalFactory is always available. However, depending on the implementation, it may not offer any terminals.

Returns:
the default TerminalFactory

Definition at line 262 of file TerminalFactory.java.

Here is the caller graph for this function:

Get the default TerminalFactory type.

It is determined as follows:

when this class is initialized, the system property javax.smartcardio.TerminalFactory.DefaultType is examined. If it is set, a TerminalFactory of this type is instantiated by calling the getInstance getInstance(String,Object)} method passing null as the value for params. If the call succeeds, the type becomes the default type and the factory becomes the getDefault default} factory.

If the system property is not set or the getInstance() call fails for any reason, the system defaults to an implementation specific default type and TerminalFactory.

Returns:
the default TerminalFactory type

Definition at line 249 of file TerminalFactory.java.

static TerminalFactory fr.redbilled.pcscforjava.TerminalFactory.getInstance ( String  type,
Object  params 
) throws NoSuchAlgorithmException [static]

Returns a TerminalFactory of the specified type that is initialized with the specified parameters.

This method traverses the list of registered security Providers, starting with the most preferred Provider. A new TerminalFactory object encapsulating the TerminalFactorySpi implementation from the first Provider that supports the specified type is returned.

Note that the list of registered providers may be retrieved via the Security::getProviders() Security.getProviders()} method.

The TerminalFactory is initialized with the specified parameters Object. The type of parameters needed may vary between different types of TerminalFactorys.

Parameters:
typethe type of the requested TerminalFactory
paramsthe parameters to pass to the TerminalFactorySpi implementation, or null if no parameters are needed
Returns:
a TerminalFactory of the specified type
Exceptions:
NullPointerExceptionif type is null
NoSuchAlgorithmExceptionif no Provider supports a TerminalFactorySpi of the specified type

Definition at line 292 of file TerminalFactory.java.

Here is the call graph for this function:

Here is the caller graph for this function:

static TerminalFactory fr.redbilled.pcscforjava.TerminalFactory.getInstance ( String  type,
Object  params,
String  provider 
) throws NoSuchAlgorithmException, NoSuchProviderException [static]

Returns a TerminalFactory of the specified type that is initialized with the specified parameters.

A new TerminalFactory object encapsulating the TerminalFactorySpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.

Note that the list of registered providers may be retrieved via the Security::getProviders() Security.getProviders()} method.

The TerminalFactory is initialized with the specified parameters Object. The type of parameters needed may vary between different types of TerminalFactorys.

Parameters:
typethe type of the requested TerminalFactory
paramsthe parameters to pass to the TerminalFactorySpi implementation, or null if no parameters are needed
providerthe name of the provider
Returns:
a TerminalFactory of the specified type
Exceptions:
NullPointerExceptionif type is null
IllegalArgumentExceptionif provider is null or the empty String
NoSuchAlgorithmExceptionif a TerminalFactorySpi implementation of the specified type is not available from the specified provider
NoSuchAlgorithmExceptionif no TerminalFactory of the specified type could be found
NoSuchProviderExceptionif the specified provider could not be found

Definition at line 332 of file TerminalFactory.java.

Here is the call graph for this function:

static TerminalFactory fr.redbilled.pcscforjava.TerminalFactory.getInstance ( String  type,
Object  params,
Provider  provider 
) throws NoSuchAlgorithmException [static]

Returns a TerminalFactory of the specified type that is initialized with the specified parameters.

A new TerminalFactory object encapsulating the TerminalFactorySpi implementation from the specified provider object is returned. Note that the specified provider object does not have to be registered in the provider list.

The TerminalFactory is initialized with the specified parameters Object. The type of parameters needed may vary between different types of TerminalFactorys.

Parameters:
typethe type of the requested TerminalFactory
paramsthe parameters to pass to the TerminalFactorySpi implementation, or null if no parameters are needed
providerthe provider
Returns:
a TerminalFactory of the specified type
Exceptions:
NullPointerExceptionif type is null
IllegalArgumentExceptionif provider is null
NoSuchAlgorithmExceptionif a TerminalFactorySpi implementation of the specified type is not available from the specified Provider

Definition at line 364 of file TerminalFactory.java.

Here is the call graph for this function:

Definition at line 150 of file TerminalFactory.java.

Returns the provider of this TerminalFactory.

Returns:
the provider of this TerminalFactory.

Definition at line 377 of file TerminalFactory.java.

Returns the type of this TerminalFactory. This is the value that was specified in the getInstance() method that returned this object.

Returns:
the type of this TerminalFactory

Definition at line 387 of file TerminalFactory.java.

Definition at line 155 of file TerminalFactory.java.

Here is the call graph for this function:

Definition at line 138 of file TerminalFactory.java.

Definition at line 133 of file TerminalFactory.java.

Returns a new CardTerminals object encapsulating the terminals supported by this factory. See the class comment of the CardTerminals} class regarding how the returned objects can be shared and reused.

Returns:
a new CardTerminals object encapsulating the terminals supported by this factory.

Definition at line 400 of file TerminalFactory.java.

Here is the call graph for this function:

Here is the caller graph for this function:

Returns a string representation of this TerminalFactory.

Returns:
a string representation of this TerminalFactory.

Definition at line 409 of file TerminalFactory.java.


The documentation for this class was generated from the following file: