Package com.zeroc.Ice
Interface PropertiesAdmin
- All Superinterfaces:
Object
The PropertiesAdmin interface provides remote access to the properties
of a communicator.
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.zeroc.Ice.Object
Object.Ice_invokeResult
-
Method Summary
Modifier and TypeMethodDescriptiongetPropertiesForPrefix
(String prefix, Current current) Get all properties whose keys begin with prefix.getProperty
(String key, Current current) Get a property by key.default String
Returns the Slice type ID of the most-derived interface supported by this object.default String[]
Returns the Slice type IDs of the interfaces supported by this object.static String
Returns the Slice type ID of the interface supported by this object.void
setProperties
(Map<String, String> newProperties, Current current) Update the communicator's properties with the given property set.Methods inherited from interface com.zeroc.Ice.Object
ice_dispatch, ice_isA, ice_ping
-
Method Details
-
getProperty
Get a property by key. If the property is not set, an empty string is returned.- Parameters:
key
- The property key.current
- The Current object for the invocation.- Returns:
- The property value.
-
getPropertiesForPrefix
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).current
- The Current object for the invocation.- Returns:
- The matching property set.
-
setProperties
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.current
- The Current object for the invocation.
-
ice_ids
Description copied from interface:Object
Returns the Slice type IDs of the interfaces supported by this object. -
ice_id
Description copied from interface:Object
Returns the Slice type ID of the most-derived interface supported by this object. -
ice_staticId
Description copied from interface:Object
Returns the Slice type ID of the interface supported by this object.- Returns:
- The return value is always ::Ice::Object.
-