Ice::PropertiesAdmin Interface Reference

The PropertiesAdmin interface provides remote access to the properties of a communicator. More...

defined in <Ice/PropertiesAdmin.ice>

interface PropertiesAdmin { ... }

Operations
PropertyDict	getPropertiesForPrefix (string prefix)
	Get all properties whose keys begin with prefix. More...
string	getProperty (string key)
	Get a property by key. More...
void	setProperties (PropertyDict newProperties)
	Update the communicator's properties with the given property set. More...

Detailed Description

The PropertiesAdmin interface provides remote access to the properties of a communicator.

Operation Documentation

getPropertiesForPrefix()

["java:type:java.util.TreeMap<String, String>"]

PropertyDict getPropertiesForPrefix

(

string

prefix

)

Get all properties whose keys begin with prefix.

If prefix is an empty string then all properties are returned.

Parameters

prefix

The prefix to search for (empty string if none).

Returns

The matching property set.

getProperty()

string getProperty

(

string

key

)

Get a property by key.

If the property is not set, an empty string is returned.

Parameters

key	The property key.

Returns

The property value.

setProperties()

void setProperties

(

PropertyDict

newProperties

)

Update the communicator's properties with the given property set.

Parameters

newProperties

Properties to be added, changed, or removed. If an entry in newProperties matches the name of an existing property, that property's value is replaced with the new value. If the new value is an empty string, the property is removed. Any existing properties that are not modified or removed by the entries in newProperties are retained with their original values.

---

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

• Ice/PropertiesAdmin.ice