org.rifidi.edge.api

Interface SensorManagerService

All Known Implementing Classes:

SensorManagerServiceImpl

public interface SensorManagerService

This is the interface for a stub that allows users to interact with readers on the edge server

Author:

Kyle Neumeier - kyle@pramari.com

Method Summary

Modifier and Type	Method and Description
java.lang.String	createReader(java.lang.String readerFactoryID, javax.management.AttributeList readerProperties) Creates a new Reader for the supplied configuration.
java.lang.String	createReader(java.lang.String readerFactoryID, javax.management.AttributeList readerProperties, java.lang.String serviceID) Creates a new Reader for the supplied configuration.
java.util.Set<SessionDTO>	createSession(java.lang.String readerID) Create a new session on the reader.
void	deleteReader(java.lang.String readerID) Remove a Reader from the Edge Server
void	deleteSession(java.lang.String readerID, java.lang.String sessionID) Delete a reader session
ReaderDTO	getReader(java.lang.String readerID) This method returns the DTO for a particular reader
javax.management.MBeanInfo	getReaderDescription(java.lang.String readerFactoryID) Gets a description of a Reader.
java.util.Set<ReaderFactoryDTO>	getReaderFactories() These are the ReaderFactories that are available on the server
ReaderFactoryDTO	getReaderFactory(java.lang.String readerFactoryID) This returns the ReaderFactoryDTO for the given readerFactoryID
java.util.Set<ReaderDTO>	getReaders() This method gets the readers that are currently available on the server
SessionDTO	getSession(java.lang.String readerID, java.lang.String sessionID) Get a session with the given IDs
void	killCommand(java.lang.String readerID, java.lang.String sessionID, java.lang.Integer processID) Stop a repeated command.
void	setReaderProperties(java.lang.String readerID, javax.management.AttributeList readerProperties) This method is used to update the properties of a Reader.
void	startSession(java.lang.String readerID, java.lang.String sessionID) Starts a session on the reader
void	stopSession(java.lang.String readerID, java.lang.String sessionID) Stops a session
void	submitCommand(java.lang.String readerID, java.lang.String sessionID, java.lang.String commandID, java.lang.Long repeatInterval, java.util.concurrent.TimeUnit timeUnit) Submit a command for execution on the reader.

Method Detail

getReaderFactories

java.util.Set<ReaderFactoryDTO> getReaderFactories()

These are the ReaderFactories that are available on the server

Returns:

a list of IDs of ReaderFactories that are currently available

getReaderFactory

ReaderFactoryDTO getReaderFactory(java.lang.String readerFactoryID)

This returns the ReaderFactoryDTO for the given readerFactoryID

Parameters:

readerFactoryID - The ReaderFactoryID to return

Returns:

The DTO for the readerFactory

Throws:

java.rmi.RemoteException

getReaders

java.util.Set<ReaderDTO> getReaders()

This method gets the readers that are currently available on the server

Returns:

a Data Transfer Object that contains all the information about a reader for all the currently available readers

Throws:

java.rmi.RemoteException

getReaderDescription

javax.management.MBeanInfo getReaderDescription(java.lang.String readerFactoryID)

Gets a description of a Reader. This will contain the information necessary to construct a new instance of the reader.

Parameters:

readerFactoryID - the ID of the ReaderFactory

Returns:

an MBeanInfo object whose attributes describe how to create a Reader

Throws:

java.rmi.RemoteException

createReader

java.lang.String createReader(java.lang.String readerFactoryID,
                              javax.management.AttributeList readerProperties)

Creates a new Reader for the supplied configuration.

Parameters:

readerFactoryID - the ID of the ReaderRactory

readerProperties - all the properties to set on the new Reader

Returns:

the id of created reader

Throws:

java.rmi.RemoteException

createReader

java.lang.String createReader(java.lang.String readerFactoryID,
                              javax.management.AttributeList readerProperties,
                              java.lang.String serviceID)
                       throws java.lang.Exception

Creates a new Reader for the supplied configuration.

Parameters:

readerFactoryID - the ID of the ReaderRactory

readerProperties - all the properties to set on the new Reader

serviceID - the required service id to be set on reader

Returns:

the id of created reader

Throws:

java.rmi.RemoteException

java.lang.Exception

getReader

ReaderDTO getReader(java.lang.String readerID)

This method returns the DTO for a particular reader

Parameters:

readerID - The ID of the Reader to get

Returns:

The DTO for a reader

Throws:

java.rmi.RemoteException

setReaderProperties

void setReaderProperties(java.lang.String readerID,
                         javax.management.AttributeList readerProperties)

This method is used to update the properties of a Reader. It may contain only the properties that you intend to change, but may contain values that will stay the same

Parameters:

readerID - the ID of the Reader to update

readerProperties - the new properties to set

deleteReader

void deleteReader(java.lang.String readerID)

Remove a Reader from the Edge Server

Parameters:

readerID - the ID of the Reader

Throws:

java.rmi.RemoteException

getSession

SessionDTO getSession(java.lang.String readerID,
                      java.lang.String sessionID)

Get a session with the given IDs

Parameters:

readerID - The ID of the reader that contains the session

sessionID - The ID of the session

Returns:

The DTO of the Session

Throws:

java.rmi.RemoteException

createSession

java.util.Set<SessionDTO> createSession(java.lang.String readerID)

Create a new session on the reader.

Parameters:

The - list of sessions currently on this reader

Throws:

java.rmi.RemoteException

deleteSession

void deleteSession(java.lang.String readerID,
                   java.lang.String sessionID)

Delete a reader session

Parameters:

readerID - The ID of the reader which has the session

sessionID - The session to delete

Throws:

java.rmi.RemoteException

startSession

void startSession(java.lang.String readerID,
                  java.lang.String sessionID)

Starts a session on the reader

Parameters:

readerID - The reader to use

sessionID - The session to start

Throws:

java.rmi.RemoteException

stopSession

void stopSession(java.lang.String readerID,
                 java.lang.String sessionID)

Stops a session

Parameters:

readerID - The reader to use

sessionID - The session to stop

Throws:

java.rmi.RemoteException

submitCommand

void submitCommand(java.lang.String readerID,
                   java.lang.String sessionID,
                   java.lang.String commandID,
                   java.lang.Long repeatInterval,
                   java.util.concurrent.TimeUnit timeUnit)
            throws CommandSubmissionException

Submit a command for execution on the reader. If the repeatInterval is < 0, this command will execute only once.

Parameters:

readerID - The reader to use

sessionID - The session to use

commandID - The command to use

repeatInterval - How often the command should be repeated. If 0, this command will only be executed once

timeUnit - Which time unit to use for the repeatInterval. Ignored if repeatInterval is set to 0

Throws:

CommandSubmissionException

killCommand

void killCommand(java.lang.String readerID,
                 java.lang.String sessionID,
                 java.lang.Integer processID)

Stop a repeated command. The is removed from the executor and will not be repeatedly executed

Parameters:

readerID - The reader to use

sessionID - The session to use

processID - The command to kill