EVOLUTION-MANAGER
Edit File: PropertiesAdmin.ice
// ********************************************************************** // // Copyright (c) 2003-2013 ZeroC, Inc. All rights reserved. // // This copy of Ice is licensed to you under the terms described in the // ICE_LICENSE file included in this distribution. // // ********************************************************************** #pragma once [["cpp:header-ext:h"]] #include <Ice/BuiltinSequences.ice> module Ice { /** * * A simple collection of properties, represented as a dictionary of * key/value pairs. Both key and value are strings. * * @see Properties#getPropertiesForPrefix * **/ dictionary<string, string> PropertyDict; /** * * The PropertiesAdmin interface provides remote access to the properties * of a communicator. * **/ interface PropertiesAdmin { /** * * Get a property by key. If the property is not set, an empty * string is returned. * * @param key The property key. * * @return The property value. * **/ string getProperty(string key); /** * * Get all properties whose keys begin with <em>prefix</em>. If * <em>prefix</em> is an empty string then all properties are returned. * * @param prefix The prefix to search for (empty string if none). * @return The matching property set. * **/ ["java:type:java.util.TreeMap<String, String>"] PropertyDict getPropertiesForPrefix(string prefix); /** * * Update the communicator's properties with the given property set. * * @param newProperties Properties to be added, changed, or removed. * If an entry in <em>newProperties</em> 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. * **/ ["amd"] void setProperties(PropertyDict newProperties); }; };