org.rifidi.edge.api

Interface CommandManagerService

All Known Implementing Classes:

CommandManagerServiceImpl

public interface CommandManagerService

This is the interface for a stub that allows clients to interact with commands on the edge server.

Author:

Kyle Neumeier - kyle@pramari.com

Method Summary

Modifier and Type	Method and Description
java.lang.String	createCommand(java.lang.String commandType, javax.management.AttributeList properties) Create a new Command.
void	deleteCommand(java.lang.String commandID) Delete a command configuration.
java.util.Set<CommandConfigFactoryDTO>	getCommandConfigFactories() This method gets the available command types on the edge server and the ID of the ReaderFactory that the command type works with.
java.util.Set<CommandConfigFactoryDTO>	getCommandConfigFactoriesByReaderID(java.lang.String readerFactoryID) Get all the CommandConfigFactoryID associated with a readerFactoryID.
CommandConfigFactoryDTO	getCommandConfigFactory(java.lang.String commandFactoryID) Get the CommandConfigurationFactory
CommandConfigurationDTO	getCommandConfiguration(java.lang.String commandConfigurationID) Gets the DTO for a given Command Configuration.
javax.management.MBeanInfo	getCommandDescription(java.lang.String commandType) Gets the meta information necessary to construct a new Command.
java.util.Set<CommandConfigurationDTO>	getCommands() Gets the DTOs for configured commands.
void	setCommandProperties(java.lang.String commandID, javax.management.AttributeList properties) Sets the properties of a Command.

Method Detail

getCommandConfigFactories

java.util.Set<CommandConfigFactoryDTO> getCommandConfigFactories()

This method gets the available command types on the edge server and the ID of the ReaderFactory that the command type works with.

Returns:

A set of CommandConfigPluginDTOs

getCommandConfigFactoriesByReaderID

java.util.Set<CommandConfigFactoryDTO> getCommandConfigFactoriesByReaderID(java.lang.String readerFactoryID)

Get all the CommandConfigFactoryID associated with a readerFactoryID.

Parameters:

readerFactoryID -

Returns:

getCommandConfigFactory

CommandConfigFactoryDTO getCommandConfigFactory(java.lang.String commandFactoryID)

Get the CommandConfigurationFactory

Parameters:

commandFactoryID -

Returns:

getCommands

java.util.Set<CommandConfigurationDTO> getCommands()

Gets the DTOs for configured commands.

Returns:

a set of configured commands

getCommandConfiguration

CommandConfigurationDTO getCommandConfiguration(java.lang.String commandConfigurationID)

Gets the DTO for a given Command Configuration.

Parameters:

commandConfigurationID - The ID of the commandConfiguration to get

Returns:

A DTO for the configured command, or null if no command configuration is available for the given ID

getCommandDescription

javax.management.MBeanInfo getCommandDescription(java.lang.String commandType)

Gets the meta information necessary to construct a new Command.

Parameters:

commandType - the type of command to make

Returns:

an MBeanInfo object that describes how to make a new command

createCommand

java.lang.String createCommand(java.lang.String commandType,
                               javax.management.AttributeList properties)

Create a new Command.

Parameters:

commandType - The type of the Command to make

properties - the properties of a Command

Returns:

the id of new created command

setCommandProperties

void setCommandProperties(java.lang.String commandID,
                          javax.management.AttributeList properties)

Sets the properties of a Command.

Parameters:

commandID - the ID of the command to set

properties - the new properties of the command

deleteCommand

void deleteCommand(java.lang.String commandID)

Delete a command configuration.

Parameters:

commandConfigurationID - the ID of the commandConfiguration to delete