rfid.api

Class RFIDReader

java.lang.Object

rfid.api.RFIDReader

public class RFIDReader
extends java.lang.Object

Provides the RFIDReader object.

Field Summary

Fields

Modifier and Type	Field and Description
Actions	Actions Instance of Actions Class for all Actions related Operation like Inventory,Access.
Config	Config Instance of Config Class for all Config related Operations
EventsAbstract	Events Instance of Event Class for all Event related Operations
ReaderCapabilities	ReaderCapabilities Access the Reader Capabilities
SecureConnectionInfo	SecureConnectionInfo

Constructor Summary

Constructors

Constructor and Description
RFIDReader() The constructor
RFIDReader(java.lang.String hostName, int port)
RFIDReader(java.lang.String comPort, int baudrate, int timeoutMilliseconds) Constructor takes host name or IP address, port and timeout as parameter
RFIDReader(java.lang.String hostName, int port, int timeoutMilliseconds, RFIDAPIType rfidApiType)
RFIDReader(java.lang.String comPort, SUPPORTED_BAUDRATE baudrate, int timeoutMilliseconds) Constructor takes host name or IP address, port and timeout as parameter

Method Summary

Modifier and Type	Method and Description
void	AcceptConnection(long readerSocket)
void	connect() Connects to the reader
void	disconnect() Disconnect from the reader
void	Dispose() Disposes the RFIDReader
java.util.List<java.lang.String>	GetAvailableCOMPorts(int baudRate)
static java.util.List<java.lang.String>	GetAvailableCOMPorts(SUPPORTED_BAUDRATE baudRate)
java.lang.String	getHostName() Gets the host name or IP Address of the reader
int	getPort() Gets the port number which is used for establishing connection with the reader
ReaderCapabilities	getReaderCapabilities()
int	getTimeout() Gets the timeout of the reader connection
void	initRFID()
boolean	isConnected() Returns the current reader connection status
boolean	IsNullOrEmpty(java.lang.String param)
void	reconnect() Reconnects to the reader, if the connection is lost.
void	setHostName(java.lang.String hostName) Sets the host name or IP Address of the reader
void	setPort(int port) Sets the port number which is used for establishing connection with the reader.
void	setTimeout(int timeout) Sets the Time out for the response from the Reader, if specified zero(0), the default time out 5000 (5sec) will be used.
VersionInfo	versionInfo() Gets the RFID class library version information

Methods inherited from class java.lang.Object

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

Field Detail

SecureConnectionInfo

public SecureConnectionInfo SecureConnectionInfo

Config

public Config Config

Instance of Config Class for all Config related Operations

Actions

public Actions Actions

Instance of Actions Class for all Actions related Operation like Inventory,Access.

Events

public EventsAbstract Events

Instance of Event Class for all Event related Operations

ReaderCapabilities

public ReaderCapabilities ReaderCapabilities

Access the Reader Capabilities

Constructor Detail

RFIDReader

public RFIDReader()

The constructor

RFIDReader

public RFIDReader(java.lang.String hostName,
                  int port)

RFIDReader

public RFIDReader(java.lang.String hostName,
                  int port,
                  int timeoutMilliseconds,
                  RFIDAPIType rfidApiType)

RFIDReader

public RFIDReader(java.lang.String comPort,
                  int baudrate,
                  int timeoutMilliseconds)

Constructor takes host name or IP address, port and timeout as parameter

Parameters:

comPort - String containing the reader's Host name or IP Address of the Reader.

baudrate - Reader Port number, if specified as Zero (0), the default port 5084 will be used

timeoutMilliseconds - Time out for the response from the Reader, if specified zero(0), the default time out 5000 (5sec) will be used. The lowest possible value could be 2sec. This value also translates to keep-alive timeout. If the connection to the reader was inactive (no keep-alive message from the Reader) for a time greater than 10 times the timeout, DISCONNECTION_EVENT will be triggered to the application, if the application has registered for the same.

RFIDReader

public RFIDReader(java.lang.String comPort,
                  SUPPORTED_BAUDRATE baudrate,
                  int timeoutMilliseconds)

Constructor takes host name or IP address, port and timeout as parameter

Parameters:

comPort - String containing the reader's Host name or IP Address of the Reader.

baudrate - Reader Port number, if specified as Zero (0), the default port 5084 will be used

timeoutMilliseconds - Time out for the response from the Reader, if specified zero(0), the default time out 5000 (5sec) will be used. The lowest possible value could be 2sec. This value also translates to keep-alive timeout. If the connection to the reader was inactive (no keep-alive message from the Reader) for a time greater than 10 times the timeout, DISCONNECTION_EVENT will be triggered to the application, if the application has registered for the same.

Method Detail

initRFID

public void initRFID()

IsNullOrEmpty

public boolean IsNullOrEmpty(java.lang.String param)

Dispose

public void Dispose()
             throws java.lang.Exception

Disposes the RFIDReader

Throws:

java.lang.Exception

getReaderCapabilities

public ReaderCapabilities getReaderCapabilities()

getPort

public int getPort()

Gets the port number which is used for establishing connection with the reader

setPort

public void setPort(int port)

Sets the port number which is used for establishing connection with the reader. If Zero(0) specified, the default port 5084 will be used

getTimeout

public int getTimeout()

Gets the timeout of the reader connection

setTimeout

public void setTimeout(int timeout)

Sets the Time out for the response from the Reader, if specified zero(0), the default time out 5000 (5sec) will be used. The lowest possible value could be 2sec. This value also translates to keep-alive timeout. If the connection to the reader was inactive (no keep-alive message from the Reader) for a time greater than 10 times the timeout, DISCONNECTION_EVENT will be triggered to the application, if the application has registered for the same.

getHostName

public java.lang.String getHostName()

Gets the host name or IP Address of the reader

setHostName

public void setHostName(java.lang.String hostName)

Sets the host name or IP Address of the reader

isConnected

public boolean isConnected()

Returns the current reader connection status

versionInfo

public VersionInfo versionInfo()
                        throws InvalidUsageException

Gets the RFID class library version information

Returns:

Throws:

InvalidUsageException

connect

public void connect()
             throws InvalidUsageException,
                    OperationFailureException

Connects to the reader

Throws:

InvalidUsageException

OperationFailureException

AcceptConnection

public void AcceptConnection(long readerSocket)
                      throws InvalidUsageException,
                             OperationFailureException

Throws:

InvalidUsageException

OperationFailureException

reconnect

public void reconnect()
               throws InvalidUsageException,
                      OperationFailureException

Reconnects to the reader, if the connection is lost.

Throws:

InvalidUsageException

OperationFailureException

disconnect

public void disconnect()
                throws InvalidUsageException,
                       OperationFailureException

Disconnect from the reader

Throws:

InvalidUsageException

OperationFailureException

GetAvailableCOMPorts

public java.util.List<java.lang.String> GetAvailableCOMPorts(int baudRate)

GetAvailableCOMPorts

public static java.util.List<java.lang.String> GetAvailableCOMPorts(SUPPORTED_BAUDRATE baudRate)