de::gsi::bel::valueserver::ValueServer

de::gsi::bel::valueserver::ValueServer Interface Reference

Inheritance diagram for de::gsi::bel::valueserver::ValueServer:


Public Member Functions
abstract void	setOnline (boolean enableFlag)
abstract boolean	getOnline ()
abstract XferServer	getXferServer ()
abstract Queue_t	findQueue (String filePath)
abstract Folder_t	findFolder (String filePath)
abstract Mount_t	findMount (String filePath)
abstract Folder_t	getRoot ()
abstract File_t	getRootFile ()
abstract File_t	newFile (File_t parentFile, String fileName, String description, int fileMode, Object value, ValueSetListener listener) throws ValueException
abstract void	setListener (File_t file, ValueSetListener listener)
abstract File_t	newFolder (File_t parentFile, String folderName, String description, int fileMode, String mive, int major, int minor, ValueSetListener listener) throws ValueException
abstract File_t	newEventQueue (File_t parentFile, String queueName, String description, int fileMode, String mive, int major, int minor, ValueSetListener listener) throws ValueException
abstract void	queuePush (File_t queueFile, File_t file) throws ValueException
abstract File_t	newMount (File_t parentFile, String mountName, String description, int fileMode, String service) throws ValueException
abstract File_t	newMount (File_t parentFile, String mountName, String description, int fileMode, String host, int port) throws ValueException
abstract void	addFile (File_t parentFile, File_t file) throws ValueException
abstract void	addFile (String filePath, File_t file) throws ValueException
abstract void	rmFile (File_t parentFile, String fileName) throws ValueException
abstract void	rmFile (String filePath) throws ValueException
abstract void	setFileValue (File_t file, Object value) throws ValueException
abstract void	setFileValue (String filePath, Object value) throws ValueException

Detailed Description

Defines the interface implemented by a ValueServerImpl object, which is constructed by the ValueServerFactory. The ValueServer object is used to create a value tree which is accessible by UV-clients. Modifications of values (tree-leaves) or change of the tree structure initiated by the ValueServer are internally processed and notifications are sent to all subscribed UV-clients. Subscriptions and other requests of clients are completely processed internally. You may be informed about client write-requests by adding a ValueSetListener to the ValueServer object.

Author:: huhmann

Member Function Documentation

abstract void de::gsi::bel::valueserver::ValueServer::addFile	(	String	filePath,
		File_t	file
	)			throws ValueException `[pure virtual]`

Add a file to a parent (must be folder node), a structure change notification will be sent to all subscribers of the parent node

Parameters:

	filePath	The path of the parent node the file is added
	file	The file to add to the parent

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract void de::gsi::bel::valueserver::ValueServer::addFile	(	File_t	parentFile,
		File_t	file
	)			throws ValueException `[pure virtual]`

Add a file to a parent file (must be folder node), a structure change notification will be sent to all subscribers of the parent node

Parameters:

	parentFile	The parent node the file is added
	file	The file to add to the parent

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract Folder_t de::gsi::bel::valueserver::ValueServer::findFolder ( String filePath ) [pure virtual]

Find a Folder object by its absolute path

Parameters:

filePath

Path of the folder

Returns:: Found folder object or null

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract Mount_t de::gsi::bel::valueserver::ValueServer::findMount ( String filePath ) [pure virtual]

Find a Mount object by its absolute path

Parameters:

filePath

Path of the mount object

Returns:: Found mount object or null

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract Queue_t de::gsi::bel::valueserver::ValueServer::findQueue ( String filePath ) [pure virtual]

Find a Queue file by its absolute path

Parameters:

filePath

The path of the queue

Returns:: found queue object or null

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract boolean de::gsi::bel::valueserver::ValueServer::getOnline ( ) [pure virtual]

Returns Online status of this server

Returns:: Online status

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract Folder_t de::gsi::bel::valueserver::ValueServer::getRoot ( ) [pure virtual]

Get the root folder of value server

Returns:: Root folder

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract File_t de::gsi::bel::valueserver::ValueServer::getRootFile ( ) [pure virtual]

Get the root file of the value server

Returns:: Root file

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract XferServer de::gsi::bel::valueserver::ValueServer::getXferServer ( ) [pure virtual]

Retrieves the Xferserver object of the underlying TCP/IP listener

Returns:

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract File_t de::gsi::bel::valueserver::ValueServer::newEventQueue	(	File_t	parentFile,
		String	queueName,
		String	description,
		int	fileMode,
		String	mive,
		int	major,
		int	minor,
		ValueSetListener	listener
	)			throws ValueException `[pure virtual]`

Create a new event-queue node

Parameters:

	parentFile	Parent file node of the new event-queue node
	queueName	Name of the event-queue node
	description	Description of the new event-queue file node
	fileMode	Mode of the new event-queue node
	mive	The UV Multi-purpose Internet Value Extension type of this event-queue
	major	The major version number
	minor	The minor version number
	listener	The listener for this new event-queue node

Returns:: The new event-queue node

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract File_t de::gsi::bel::valueserver::ValueServer::newFile	(	File_t	parentFile,
		String	fileName,
		String	description,
		int	fileMode,
		Object	value,
		ValueSetListener	listener
	)			throws ValueException `[pure virtual]`

Create a new file node in the value tree. To create folder, event-queue or mount node please use the corresponding creation methods.

Parameters:

	parentFile	Parent file node of the new file node
	fileName	Name of the new file node
	description	Description of the new file node
	fileMode	Mode of the new file node
	value	Value of the new file node. The values type may be primitive value or arrays of primitive value (see xvalue.jar)
	listener	The listeners object valueOnSet method is called when the value is changed externally by UV-clients

Returns:: The created file node

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract File_t de::gsi::bel::valueserver::ValueServer::newFolder	(	File_t	parentFile,
		String	folderName,
		String	description,
		int	fileMode,
		String	mive,
		int	major,
		int	minor,
		ValueSetListener	listener
	)			throws ValueException `[pure virtual]`

Create a folder node.

Parameters:

	parentFile	Parent file node of the new folder node
	folderName	The name of the new folder node
	description	Description of the new folder node
	fileMode	Mode of the new folder node
	mive	The UV Multi-purpose Internet Value Extension type of this folder
	major	The major version number
	minor	The minor version number
	listener	The listener for this new folder node

Returns:: The new folder node

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract File_t de::gsi::bel::valueserver::ValueServer::newMount	(	File_t	parentFile,
		String	mountName,
		String	description,
		int	fileMode,
		String	host,
		int	port
	)			throws ValueException `[pure virtual]`

Create a new node with mount info of another UV server given as IP adress and port.

Parameters:

	parentFile	Parent file of the new mount node
	mountName	Name of the mount node.
	description	Description of the mount node
	fileMode	Mode of the mount node
	host	TCP/IP host info of the UV-server as IP-adress (or host name)
	port	TCP/IP port info of UV-server

Returns:: Created mount node

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract File_t de::gsi::bel::valueserver::ValueServer::newMount	(	File_t	parentFile,
		String	mountName,
		String	description,
		int	fileMode,
		String	service
	)			throws ValueException `[pure virtual]`

Create a new node with mount info of another UV server given as name.

Parameters:

	parentFile	Parent file of the new mount node
	mountName	Name of the mount node.
	description	Description of the mount node
	fileMode	Mode of the mount node
	service	The UV server as name.

Returns:: Created mount node

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract void de::gsi::bel::valueserver::ValueServer::queuePush	(	File_t	queueFile,
		File_t	file
	)			throws ValueException `[pure virtual]`

Push an event (i.e. a file which may be a subtree) to an event-queue, the event (file-structure) will be sent to all subscribers of the event-queue

Parameters:

	queueFile	The event-queue node to push an event to.
	file	The event to push.

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract void de::gsi::bel::valueserver::ValueServer::rmFile ( String filePath ) throws ValueException [pure virtual]

Remove a file node from the tree

Parameters:

filePath

The absolute path of the node to be removed

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract void de::gsi::bel::valueserver::ValueServer::rmFile	(	File_t	parentFile,
		String	fileName
	)			throws ValueException `[pure virtual]`

Remove a file from a parent (must be folder node), a structure change notification will be sent to all subscribers of the parent node

Parameters:

	parentFile	The parent node of the file which should be removed
	fileName	The name of the file which should be removed from the parent

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract void de::gsi::bel::valueserver::ValueServer::setFileValue	(	String	filePath,
		Object	value
	)			throws ValueException `[pure virtual]`

Set a new value of a file node given by name, value changes will be sent to all subscribers of this node

Parameters:

	filePath	Absolute path to file node
	value	The value to be set

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract void de::gsi::bel::valueserver::ValueServer::setFileValue	(	File_t	file,
		Object	value
	)			throws ValueException `[pure virtual]`

Set a new value of a file node, value changes will be sent to all subscribers of this node

Parameters:

	file	Set a new value on file
	value	The value to be set

Exceptions:

ValueException

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract void de::gsi::bel::valueserver::ValueServer::setListener	(	File_t	file,
		ValueSetListener	listener
	)			`[pure virtual]`

Set a value listener for a file, only one listener is possible. The listener method valueOnSet is called when the file's value is set by a client request

Parameters:

	file	Set listener to file
	listener	The listener of a file's value

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

abstract void de::gsi::bel::valueserver::ValueServer::setOnline ( boolean enableFlag ) [pure virtual]

Enable/Disable processing of Client request: if disabled client requests are queued but not processed. This may cause losing requests.

Parameters:

enableFlag

true: enable, false: disable processing of requests

Implemented in de::gsi::bel::valueserver::ValueServerImpl.

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

/common/home/bel/bella/lnx/exports/build/current/all/sys-tools/uv-java-server/java/de/gsi/bel/valueserver/ValueServer.java

Generated on 4 Mar 2014 for valueserver by

1.4.7

de::gsi::bel::valueserver::ValueServer Interface Reference

Public Member Functions

Detailed Description

Member Function Documentation