Ice

Interface _PropertiesAdminOperations

All Known Subinterfaces:

PropertiesAdmin

All Known Implementing Classes:

_PropertiesAdminDisp

public interface _PropertiesAdminOperations

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

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getPropertiesForPrefix(java.lang.String prefix, Current __current) Get all properties whose keys begin with prefix.
java.lang.String	getProperty(java.lang.String key, Current __current) Get a property by key.
void	setProperties_async(AMD_PropertiesAdmin_setProperties __cb, java.util.Map<java.lang.String,java.lang.String> newProperties, Current __current) Update the communicator's properties with the given property set.

Method Detail

getProperty

java.lang.String getProperty(java.lang.String key,
                             Current __current)

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

java.util.Map<java.lang.String,java.lang.String> getPropertiesForPrefix(java.lang.String prefix,
                                                                        Current __current)

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_async

void setProperties_async(AMD_PropertiesAdmin_setProperties __cb,
                         java.util.Map<java.lang.String,java.lang.String> newProperties,
                         Current __current)

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

Parameters:

__cb - The callback object for the operation.

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.