Package com.zeroc.Ice
Interface PropertiesAdminPrx
- All Superinterfaces:
ObjectPrx
The PropertiesAdmin interface provides remote access to the properties
of a communicator.
-
Field Summary
Fields inherited from interface com.zeroc.Ice.ObjectPrx
ice_staticId, noExplicitContext
-
Method Summary
Modifier and TypeMethodDescriptionstatic PropertiesAdminPrx
checkedCast
(ObjectPrx obj) Contacts the remote server to verify that the object implements this type.static PropertiesAdminPrx
checkedCast
(ObjectPrx obj, String facet) Contacts the remote server to verify that a facet of the object implements this type.static PropertiesAdminPrx
Contacts the remote server to verify that a facet of the object implements this type.static PropertiesAdminPrx
checkedCast
(ObjectPrx obj, Map<String, String> context) Contacts the remote server to verify that the object implements this type.getPropertiesForPrefix
(String prefix) Get all properties whose keys begin with prefix.getPropertiesForPrefix
(String prefix, Map<String, String> context) Get all properties whose keys begin with prefix.default CompletableFuture<Map<String,
String>> getPropertiesForPrefixAsync
(String prefix) Get all properties whose keys begin with prefix.default CompletableFuture<Map<String,
String>> getPropertiesForPrefixAsync
(String prefix, Map<String, String> context) Get all properties whose keys begin with prefix.default String
getProperty
(String key) Get a property by key.default String
getProperty
(String key, Map<String, String> context) Get a property by key.default CompletableFuture<String>
getPropertyAsync
(String key) Get a property by key.default CompletableFuture<String>
getPropertyAsync
(String key, Map<String, String> context) Get a property by key.default PropertiesAdminPrx
ice_adapterId
(String newAdapterId) Returns a proxy that is identical to this proxy, except for the adapter ID.default PropertiesAdminPrx
Returns a proxy that is identical to this proxy, but uses batch datagram invocations.default PropertiesAdminPrx
Returns a proxy that is identical to this proxy, but uses batch oneway invocations.default PropertiesAdminPrx
ice_collocationOptimized
(boolean b) Returns a proxy that is identical to this proxy, except for collocation optimization.default PropertiesAdminPrx
ice_compress
(boolean co) Returns a proxy that is identical to this proxy, except for compression.default PropertiesAdminPrx
ice_connectionCached
(boolean newCache) Returns a proxy that is identical to this proxy, except for connection caching.default PropertiesAdminPrx
ice_connectionId
(String connectionId) Returns a proxy that is identical to this proxy, except for its connection ID.default PropertiesAdminPrx
ice_context
(Map<String, String> newContext) Returns a proxy that is identical to this proxy, except for the per-proxy context.default PropertiesAdminPrx
Returns a proxy that is identical to this proxy, but uses datagram invocations.default PropertiesAdminPrx
Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.default PropertiesAdminPrx
ice_endpoints
(Endpoint[] newEndpoints) Returns a proxy that is identical to this proxy, except for the endpoints.default PropertiesAdminPrx
Returns a proxy that is identical to this proxy, except for the endpoint selection policy.default PropertiesAdminPrx
ice_fixed
(Connection connection) Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection.default PropertiesAdminPrx
ice_invocationTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the invocation timeout.default PropertiesAdminPrx
ice_locator
(LocatorPrx locator) Returns a proxy that is identical to this proxy, except for the locator.default PropertiesAdminPrx
ice_locatorCacheTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the locator cache timeout.default PropertiesAdminPrx
Returns a proxy that is identical to this proxy, but uses oneway invocations.default PropertiesAdminPrx
ice_preferSecure
(boolean b) Returns a proxy that is identical to this proxy, except for its endpoint selection policy.default PropertiesAdminPrx
ice_router
(RouterPrx router) Returns a proxy that is identical to this proxy, except for the router.default PropertiesAdminPrx
ice_secure
(boolean b) Returns a proxy that is identical to this proxy, except for how it selects endpoints.static String
Returns the Slice type ID associated with this type.default PropertiesAdminPrx
ice_timeout
(int t) Returns a proxy that is identical to this proxy, except for its connection timeout setting.default PropertiesAdminPrx
Returns a proxy that is identical to this proxy, but uses twoway invocations.default void
setProperties
(Map<String, String> newProperties) Update the communicator's properties with the given property set.default void
Update the communicator's properties with the given property set.default CompletableFuture<Void>
setPropertiesAsync
(Map<String, String> newProperties) Update the communicator's properties with the given property set.default CompletableFuture<Void>
Update the communicator's properties with the given property set.static PropertiesAdminPrx
uncheckedCast
(ObjectPrx obj) Downcasts the given proxy to this type without contacting the remote server.static PropertiesAdminPrx
uncheckedCast
(ObjectPrx obj, String facet) Downcasts the given proxy to this type without contacting the remote server.Methods inherited from interface com.zeroc.Ice.ObjectPrx
equals, ice_executor, ice_facet, ice_flushBatchRequests, ice_flushBatchRequestsAsync, ice_getAdapterId, ice_getCachedConnection, ice_getCommunicator, ice_getCompress, ice_getConnection, ice_getConnectionAsync, ice_getConnectionId, ice_getContext, ice_getEncodingVersion, ice_getEndpoints, ice_getEndpointSelection, ice_getFacet, ice_getIdentity, ice_getInvocationTimeout, ice_getLocator, ice_getLocatorCacheTimeout, ice_getRouter, ice_getTimeout, ice_id, ice_id, ice_idAsync, ice_idAsync, ice_identity, ice_ids, ice_ids, ice_idsAsync, ice_idsAsync, ice_invoke, ice_invoke, ice_invokeAsync, ice_invokeAsync, ice_isA, ice_isA, ice_isAAsync, ice_isAAsync, ice_isBatchDatagram, ice_isBatchOneway, ice_isCollocationOptimized, ice_isConnectionCached, ice_isDatagram, ice_isFixed, ice_isOneway, ice_isPreferSecure, ice_isSecure, ice_isTwoway, ice_ping, ice_ping, ice_pingAsync, ice_pingAsync
-
Method Details
-
getProperty
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.
-
getProperty
Get a property by key. If the property is not set, an empty string is returned.- Parameters:
key
- The property key.context
- The Context map to send with the invocation.- Returns:
- The property value.
-
getPropertyAsync
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.
-
getPropertyAsync
Get a property by key. If the property is not set, an empty string is returned.- Parameters:
key
- The property key.context
- The Context map to send with 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).- Returns:
- The matching property set.
-
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).context
- The Context map to send with the invocation.- Returns:
- The matching property set.
-
getPropertiesForPrefixAsync
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.
-
getPropertiesForPrefixAsync
default CompletableFuture<Map<String,String>> getPropertiesForPrefixAsync(String prefix, Map<String, String> context) 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).context
- The Context map to send with 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.
-
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.context
- The Context map to send with the invocation.
-
setPropertiesAsync
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.- Returns:
- A future that will be completed when the invocation completes.
-
setPropertiesAsync
default CompletableFuture<Void> setPropertiesAsync(Map<String, String> newProperties, Map<String, String> context) 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.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
checkedCast
Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Contacts the remote server to verify that the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.context
- The Context map to send with the invocation.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Contacts the remote server to verify that a facet of the object implements this type. Raises a local exception if a communication error occurs.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.context
- The Context map to send with the invocation.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
uncheckedCast
Downcasts the given proxy to this type without contacting the remote server.- Parameters:
obj
- The untyped proxy.- Returns:
- A proxy for this type.
-
uncheckedCast
Downcasts the given proxy to this type without contacting the remote server.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.- Returns:
- A proxy for this type.
-
ice_context
Returns a proxy that is identical to this proxy, except for the per-proxy context.- Specified by:
ice_context
in interfaceObjectPrx
- Parameters:
newContext
- The context for the new proxy.- Returns:
- A proxy with the specified per-proxy context.
-
ice_adapterId
Returns a proxy that is identical to this proxy, except for the adapter ID.- Specified by:
ice_adapterId
in interfaceObjectPrx
- Parameters:
newAdapterId
- The adapter ID for the new proxy.- Returns:
- A proxy with the specified adapter ID.
-
ice_endpoints
Returns a proxy that is identical to this proxy, except for the endpoints.- Specified by:
ice_endpoints
in interfaceObjectPrx
- Parameters:
newEndpoints
- The endpoints for the new proxy.- Returns:
- A proxy with the specified endpoints.
-
ice_locatorCacheTimeout
Returns a proxy that is identical to this proxy, except for the locator cache timeout.- Specified by:
ice_locatorCacheTimeout
in interfaceObjectPrx
- Parameters:
newTimeout
- The new locator cache timeout (in seconds).- Returns:
- A proxy with the specified locator cache timeout.
- See Also:
-
ice_invocationTimeout
Returns a proxy that is identical to this proxy, except for the invocation timeout.- Specified by:
ice_invocationTimeout
in interfaceObjectPrx
- Parameters:
newTimeout
- The new invocation timeout (in seconds).- Returns:
- A proxy with the specified invocation timeout.
-
ice_connectionCached
Returns a proxy that is identical to this proxy, except for connection caching.- Specified by:
ice_connectionCached
in interfaceObjectPrx
- Parameters:
newCache
-true
if the new proxy should cache connections;false
otherwise.- Returns:
- A proxy with the specified caching policy.
-
ice_endpointSelection
Returns a proxy that is identical to this proxy, except for the endpoint selection policy.- Specified by:
ice_endpointSelection
in interfaceObjectPrx
- Parameters:
newType
- The new endpoint selection policy.- Returns:
- A proxy with the specified endpoint selection policy.
- See Also:
-
ice_secure
Returns a proxy that is identical to this proxy, except for how it selects endpoints.- Specified by:
ice_secure
in interfaceObjectPrx
- Parameters:
b
- Ifb
istrue
, only endpoints that use a secure transport are used by the new proxy. Ifb
is false, the returned proxy uses both secure and insecure endpoints.- Returns:
- A proxy with the specified selection policy.
-
ice_encodingVersion
Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.- Specified by:
ice_encodingVersion
in interfaceObjectPrx
- Parameters:
e
- The encoding version to use to marshal request parameters.- Returns:
- A proxy with the specified encoding version.
-
ice_preferSecure
Returns a proxy that is identical to this proxy, except for its endpoint selection policy.- Specified by:
ice_preferSecure
in interfaceObjectPrx
- Parameters:
b
- Ifb
istrue
, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. Ifb
isfalse
, the proxy prefers insecure endpoints to secure ones.- Returns:
- A proxy with the specified selection policy.
-
ice_router
Returns a proxy that is identical to this proxy, except for the router.- Specified by:
ice_router
in interfaceObjectPrx
- Parameters:
router
- The router for the new proxy.- Returns:
- A proxy with the specified router.
-
ice_locator
Returns a proxy that is identical to this proxy, except for the locator.- Specified by:
ice_locator
in interfaceObjectPrx
- Parameters:
locator
- The locator for the new proxy.- Returns:
- A proxy with the specified locator.
-
ice_collocationOptimized
Returns a proxy that is identical to this proxy, except for collocation optimization.- Specified by:
ice_collocationOptimized
in interfaceObjectPrx
- Parameters:
b
-true
if the new proxy enables collocation optimization;false
otherwise.- Returns:
- A proxy with the specified collocation optimization.
-
ice_twoway
Returns a proxy that is identical to this proxy, but uses twoway invocations.- Specified by:
ice_twoway
in interfaceObjectPrx
- Returns:
- A proxy that uses twoway invocations.
-
ice_oneway
Returns a proxy that is identical to this proxy, but uses oneway invocations.- Specified by:
ice_oneway
in interfaceObjectPrx
- Returns:
- A proxy that uses oneway invocations.
-
ice_batchOneway
Returns a proxy that is identical to this proxy, but uses batch oneway invocations.- Specified by:
ice_batchOneway
in interfaceObjectPrx
- Returns:
- A proxy that uses batch oneway invocations.
-
ice_datagram
Returns a proxy that is identical to this proxy, but uses datagram invocations.- Specified by:
ice_datagram
in interfaceObjectPrx
- Returns:
- A proxy that uses datagram invocations.
-
ice_batchDatagram
Returns a proxy that is identical to this proxy, but uses batch datagram invocations.- Specified by:
ice_batchDatagram
in interfaceObjectPrx
- Returns:
- A proxy that uses batch datagram invocations.
-
ice_compress
Returns a proxy that is identical to this proxy, except for compression.- Specified by:
ice_compress
in interfaceObjectPrx
- Parameters:
co
-true
enables compression for the new proxy;false
disables compression.- Returns:
- A proxy with the specified compression setting.
-
ice_timeout
Returns a proxy that is identical to this proxy, except for its connection timeout setting.- Specified by:
ice_timeout
in interfaceObjectPrx
- Parameters:
t
- The connection timeout for the proxy in milliseconds.- Returns:
- A proxy with the specified timeout.
-
ice_connectionId
Returns a proxy that is identical to this proxy, except for its connection ID.- Specified by:
ice_connectionId
in interfaceObjectPrx
- Parameters:
connectionId
- The connection ID for the new proxy. An empty string removes the connection ID.- Returns:
- A proxy with the specified connection ID.
-
ice_fixed
Returns a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.@param connection The fixed proxy connection. -
ice_staticId
Description copied from interface:ObjectPrx
Returns the Slice type ID associated with this type.- Returns:
- The Slice type ID.
-