1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
// **********************************************************************
//
// Copyright (c) 2003-2017 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
[["ice-prefix", "cpp:header-ext:h", "cpp:dll-export:ICE_API", "objc:header-dir:objc", "objc:dll-export:ICE_API", "js:ice-build", "python:pkgdir:Ice"]]
#include <Ice/BuiltinSequences.ice>
#ifndef __SLICE2JAVA_COMPAT__
[["java:package:com.zeroc"]]
#endif
["objc:prefix: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.
*
**/
void setProperties(PropertyDict newProperties);
}
}
|
