com.embeddedunveiled.serial.mapper

Class SerialComPortMapper

java.lang.Object

com.embeddedunveiled.serial.mapper.SerialComPortMapper

public final class SerialComPortMapper
extends Object

Provides methods to create and remove alias for serial ports is system.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComPortMapper(SerialComPortMapperJNIBridge mSerialComPortMapperJNIBridge) Construct and allocates a new SerialComPortMapper object with given details.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	listCreatedAliases() Provides caller with a read-only Map view of the aliases created using SCM library.
boolean	mapAliasToExistingComPort(String alias, String comPort) Creates a alias to the given existing serial port.
boolean	startMappingService() Start the service which may run with elevated privileges in system.
boolean	stopMappingService() Stops the serial port mapping service when no more required.
boolean	unmapAliasToExistingComPort(String alias) Removes a previously created alias to the given existing serial port.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialComPortMapper

public SerialComPortMapper(SerialComPortMapperJNIBridge mSerialComPortMapperJNIBridge)

Construct and allocates a new SerialComPortMapper object with given details.

Parameters:

mSerialComPortMapperJNIBridge - interface class to native library for calling platform specific routines.

Throws:

SerialComException - if the object can not be constructed.

Method Detail

startMappingService

public boolean startMappingService()
                            throws SerialComException

Start the service which may run with elevated privileges in system.

Returns:

true if the service was started successfully.

Throws:

SerialComException - if an error occurs.

stopMappingService

public boolean stopMappingService()
                           throws SerialComException

Stops the serial port mapping service when no more required. This increase the security if this library is running on servers.

Returns:

true if the service was started successfully.

Throws:

SerialComException - if an error occurs.

mapAliasToExistingComPort

public boolean mapAliasToExistingComPort(String alias,
                                String comPort)
                                  throws SerialComException

Creates a alias to the given existing serial port.

Parameters:

alias - created name that maps to existing serial port.

comPort - actual existing serial port which is mapped.

Returns:

true on success.

Throws:

SerialComException - if alias can not be created or an I/O error occurs.

unmapAliasToExistingComPort

public boolean unmapAliasToExistingComPort(String alias)
                                    throws SerialComException

Removes a previously created alias to the given existing serial port.

Parameters:

alias - created name that maps to existing serial port.

Returns:

true on success.

Throws:

SerialComException - if given alias is unknown to this library, or if given alias can not be removed or an I/O error occurs.

listCreatedAliases

public Map<String,String> listCreatedAliases()

Provides caller with a read-only Map view of the aliases created using SCM library.

Returns:

Map view of the aliases created using SCM library.