Module com.zeroc.ice

Package com.zeroc.Ice

Interface PropertiesAdminPrx

All Superinterfaces:

ObjectPrx

public interface PropertiesAdminPrx
extends ObjectPrx

Provides remote access to the properties of a communicator.

Remarks: The Slice compiler generated this proxy interface from Slice interface ::Ice::PropertiesAdmin.

Field Summary

Fields inherited from interface com.zeroc.Ice.ObjectPrx

ice_staticId, noExplicitContext

Method Summary

Modifier and Type	Method	Description
static PropertiesAdminPrx	checkedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static PropertiesAdminPrx	checkedCast(ObjectPrx obj, String facet)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static PropertiesAdminPrx	checkedCast(ObjectPrx obj, String facet, Map<String,String> context)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static PropertiesAdminPrx	checkedCast(ObjectPrx obj, Map<String,String> context)	Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.
static PropertiesAdminPrx	createProxy(Communicator communicator, String proxyString)	Creates a new proxy that implements PropertiesAdminPrx.
default Map<String,String>	getPropertiesForPrefix(String prefix)	Gets all properties whose keys begin with prefix.
default Map<String,String>	getPropertiesForPrefix(String prefix, Map<String,String> context)	Gets all properties whose keys begin with prefix.
default CompletableFuture<Map<String,String>>	getPropertiesForPrefixAsync(String prefix)	Gets all properties whose keys begin with prefix.
default CompletableFuture<Map<String,String>>	getPropertiesForPrefixAsync(String prefix, Map<String,String> context)	Gets all properties whose keys begin with prefix.
default String	getProperty(String key)	Gets a property by key.
default String	getProperty(String key, Map<String,String> context)	Gets a property by key.
default CompletableFuture<String>	getPropertyAsync(String key)	Gets a property by key.
default CompletableFuture<String>	getPropertyAsync(String key, Map<String,String> context)	Gets a property by key.
PropertiesAdminPrx	ice_adapterId(String newAdapterId)	Creates a proxy that is identical to this proxy, except for the adapter ID.
PropertiesAdminPrx	ice_batchDatagram()	Creates a proxy that is identical to this proxy, but uses batch datagram invocations.
PropertiesAdminPrx	ice_batchOneway()	Creates a proxy that is identical to this proxy, but uses batch oneway invocations.
PropertiesAdminPrx	ice_collocationOptimized(boolean b)	Creates a proxy that is identical to this proxy, except for collocation optimization.
PropertiesAdminPrx	ice_compress(boolean co)	Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
PropertiesAdminPrx	ice_connectionCached(boolean newCache)	Creates a proxy that is identical to this proxy, except for connection caching.
PropertiesAdminPrx	ice_connectionId(String connectionId)	Creates a proxy that is identical to this proxy, except for its connection ID.
PropertiesAdminPrx	ice_context(Map<String,String> newContext)	Creates a proxy that is identical to this proxy, except for the per-proxy context.
PropertiesAdminPrx	ice_datagram()	Creates a proxy that is identical to this proxy, but uses datagram invocations.
PropertiesAdminPrx	ice_encodingVersion(EncodingVersion e)	Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
PropertiesAdminPrx	ice_endpoints(Endpoint[] newEndpoints)	Creates a proxy that is identical to this proxy, except for the endpoints.
PropertiesAdminPrx	ice_endpointSelection(EndpointSelectionType newType)	Creates a proxy that is identical to this proxy, except for the endpoint selection policy.
PropertiesAdminPrx	ice_fixed(Connection connection)	Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.
PropertiesAdminPrx	ice_invocationTimeout(int newTimeout)	Creates a proxy that is identical to this proxy, except for the invocation timeout.
PropertiesAdminPrx	ice_invocationTimeout(Duration newTimeout)	Creates a proxy that is identical to this proxy, except for the invocation timeout.
PropertiesAdminPrx	ice_locator(LocatorPrx locator)	Creates a proxy that is identical to this proxy, except for the locator.
PropertiesAdminPrx	ice_locatorCacheTimeout(int newTimeout)	Creates a proxy that is identical to this proxy, except for the locator cache timeout.
PropertiesAdminPrx	ice_oneway()	Creates a proxy that is identical to this proxy, but uses oneway invocations.
PropertiesAdminPrx	ice_router(RouterPrx router)	Creates a proxy that is identical to this proxy, except for the router.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.
PropertiesAdminPrx	ice_twoway()	Creates a proxy that is identical to this proxy, but uses twoway invocations.
default void	setProperties(Map<String,String> newProperties)	Updates the communicator's properties with the given property set.
default void	setProperties(Map<String,String> newProperties, Map<String,String> context)	Updates the communicator's properties with the given property set.
default CompletableFuture<Void>	setPropertiesAsync(Map<String,String> newProperties)	Updates the communicator's properties with the given property set.
default CompletableFuture<Void>	setPropertiesAsync(Map<String,String> newProperties, Map<String,String> context)	Updates the communicator's properties with the given property set.
static PropertiesAdminPrx	uncheckedCast(ObjectPrx obj)	Creates a new proxy from an existing proxy.
static PropertiesAdminPrx	uncheckedCast(ObjectPrx obj, String facet)	Creates a new proxy from an existing proxy.

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_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_isTwoway, ice_locatorCacheTimeout, ice_ping, ice_ping, ice_pingAsync, ice_pingAsync

Method Details

getProperty

default String getProperty(String key)

Gets a property by key.

Parameters:

key - The property key.

Returns:

The property value. This value is empty if the property is not set.

getProperty

default String getProperty(String key,
 Map<String,String> context)

Gets a property by key.

Parameters:

key - The property key.

context - the Context map to send with the invocation

Returns:

The property value. This value is empty if the property is not set.

getPropertyAsync

default CompletableFuture<String> getPropertyAsync(String key)

Gets a property by key.

Parameters:

key - The property key.

Returns:

The property value. This value is empty if the property is not set.

getPropertyAsync

default CompletableFuture<String> getPropertyAsync(String key,
 Map<String,String> context)

Gets a property by key.

Parameters:

key - The property key.

context - the Context map to send with the invocation

Returns:

The property value. This value is empty if the property is not set.

getPropertiesForPrefix

default Map<String,String> getPropertiesForPrefix(String prefix)

Gets all properties whose keys begin with prefix. If prefix is the empty string then all properties are returned.

Parameters:

prefix - The prefix to search for. May be empty.

Returns:

The matching property set.

getPropertiesForPrefix

default Map<String,String> getPropertiesForPrefix(String prefix,
 Map<String,String> context)

Gets all properties whose keys begin with prefix. If prefix is the empty string then all properties are returned.

Parameters:

prefix - The prefix to search for. May be empty.

context - the Context map to send with the invocation

Returns:

The matching property set.

getPropertiesForPrefixAsync

default CompletableFuture<Map<String,String>> getPropertiesForPrefixAsync(String prefix)

Gets all properties whose keys begin with prefix. If prefix is the empty string then all properties are returned.

Parameters:

prefix - The prefix to search for. May be empty.

Returns:

The matching property set.

getPropertiesForPrefixAsync

default CompletableFuture<Map<String,String>> getPropertiesForPrefixAsync(String prefix,
 Map<String,String> context)

Gets all properties whose keys begin with prefix. If prefix is the empty string then all properties are returned.

Parameters:

prefix - The prefix to search for. May be empty.

context - the Context map to send with the invocation

Returns:

The matching property set.

setProperties

default void setProperties(Map<String,String> newProperties)

Updates the communicator's properties with the given property set. 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 the empty string, the property is removed. Existing properties that are not modified or removed by the entries in newProperties are not affected by this update.

Parameters:

newProperties - Properties to add, change, or remove.

setProperties

default void setProperties(Map<String,String> newProperties,
 Map<String,String> context)

Updates the communicator's properties with the given property set. 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 the empty string, the property is removed. Existing properties that are not modified or removed by the entries in newProperties are not affected by this update.

Parameters:

newProperties - Properties to add, change, or remove.

context - the Context map to send with the invocation

setPropertiesAsync

default CompletableFuture<Void> setPropertiesAsync(Map<String,String> newProperties)

Updates the communicator's properties with the given property set. 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 the empty string, the property is removed. Existing properties that are not modified or removed by the entries in newProperties are not affected by this update.

Parameters:

newProperties - Properties to add, change, or remove.

Returns:

a future that will be completed when the invocation completes

setPropertiesAsync

default CompletableFuture<Void> setPropertiesAsync(Map<String,String> newProperties,
 Map<String,String> context)

Updates the communicator's properties with the given property set. 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 the empty string, the property is removed. Existing properties that are not modified or removed by the entries in newProperties are not affected by this update.

Parameters:

newProperties - Properties to add, change, or remove.

context - the Context map to send with the invocation

Returns:

a future that will be completed when the invocation completes

createProxy

static PropertiesAdminPrx createProxy(Communicator communicator,
 String proxyString)

Creates a new proxy that implements PropertiesAdminPrx.

Parameters:

communicator - the communicator of the new proxy

proxyString - the string representation of the proxy

Returns:

the new proxy

checkedCast

static PropertiesAdminPrx checkedCast(ObjectPrx obj)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.

Parameters:

obj - the source proxy

Returns:

a proxy for this type, or null if the target object does not support this type

checkedCast

static PropertiesAdminPrx checkedCast(ObjectPrx obj,
 Map<String,String> context)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.

Parameters:

obj - the source proxy

context - the Context map to send with the invocation

Returns:

a new proxy for this type, or null if the target object does not support this type

checkedCast

static PropertiesAdminPrx checkedCast(ObjectPrx obj,
 String facet)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.

Parameters:

obj - the source proxy

facet - the name of the desired facet

Returns:

a new proxy for this type, or null if the facet does not support this type.

checkedCast

static PropertiesAdminPrx checkedCast(ObjectPrx obj,
 String facet,
 Map<String,String> context)

Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.

Parameters:

obj - the source proxy

facet - the name of the desired facet

context - the Context map to send with the invocation

Returns:

a new proxy for this type, or null if the target object does not support this type.

uncheckedCast

static PropertiesAdminPrx uncheckedCast(ObjectPrx obj)

Creates a new proxy from an existing proxy.

Parameters:

obj - the source proxy

Returns:

a new proxy with this type or null if obj is null

uncheckedCast

static PropertiesAdminPrx uncheckedCast(ObjectPrx obj,
 String facet)

Creates a new proxy from an existing proxy.

Parameters:

obj - the source proxy

facet - the name of the desired facet

Returns:

a new proxy with this type or null if obj is null

ice_context

PropertiesAdminPrx ice_context(Map<String,String> newContext)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the per-proxy context.

Specified by:

ice_context in interface ObjectPrx

Parameters:

newContext - the context for the new proxy

Returns:

a proxy with the new per-proxy context

ice_adapterId

PropertiesAdminPrx ice_adapterId(String newAdapterId)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the adapter ID.

Specified by:

ice_adapterId in interface ObjectPrx

Parameters:

newAdapterId - the adapter ID for the new proxy

Returns:

a proxy with the new adapter ID

ice_endpoints

PropertiesAdminPrx ice_endpoints(Endpoint[] newEndpoints)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the endpoints.

Specified by:

ice_endpoints in interface ObjectPrx

Parameters:

newEndpoints - the endpoints for the new proxy

Returns:

a proxy with the new endpoints

ice_locatorCacheTimeout

PropertiesAdminPrx ice_locatorCacheTimeout(int newTimeout)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the locator cache timeout.

Specified by:

ice_locatorCacheTimeout in interface ObjectPrx

Parameters:

newTimeout - the new locator cache timeout (in seconds)

Returns:

a proxy with the new timeout

See Also:

• Locator

ice_invocationTimeout

PropertiesAdminPrx ice_invocationTimeout(int newTimeout)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the invocation timeout.

Specified by:

ice_invocationTimeout in interface ObjectPrx

Parameters:

newTimeout - the new invocation timeout (in milliseconds)

Returns:

a proxy with the new timeout

ice_invocationTimeout

PropertiesAdminPrx ice_invocationTimeout(Duration newTimeout)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the invocation timeout.

Specified by:

ice_invocationTimeout in interface ObjectPrx

Parameters:

newTimeout - the new invocation timeout

Returns:

a proxy with the new timeout

ice_connectionCached

PropertiesAdminPrx ice_connectionCached(boolean newCache)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for connection caching.

Specified by:

ice_connectionCached in interface ObjectPrx

Parameters:

newCache - true if the new proxy should cache connections, false otherwise

Returns:

a proxy with the specified caching policy

ice_endpointSelection

PropertiesAdminPrx ice_endpointSelection(EndpointSelectionType newType)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the endpoint selection policy.

Specified by:

ice_endpointSelection in interface ObjectPrx

Parameters:

newType - the new endpoint selection policy

Returns:

a proxy with the specified endpoint selection policy

ice_encodingVersion

PropertiesAdminPrx ice_encodingVersion(EncodingVersion e)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the encoding used to marshal parameters.

Specified by:

ice_encodingVersion in interface ObjectPrx

Parameters:

e - the encoding version to use to marshal request parameters

Returns:

a proxy with the specified encoding version

ice_router

PropertiesAdminPrx ice_router(RouterPrx router)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the router.

Specified by:

ice_router in interface ObjectPrx

Parameters:

router - the router for the new proxy

Returns:

a proxy with the specified router

ice_locator

PropertiesAdminPrx ice_locator(LocatorPrx locator)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for the locator.

Specified by:

ice_locator in interface ObjectPrx

Parameters:

locator - the locator for the new proxy

Returns:

a proxy with the specified locator

ice_collocationOptimized

PropertiesAdminPrx ice_collocationOptimized(boolean b)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for collocation optimization.

Specified by:

ice_collocationOptimized in interface ObjectPrx

Parameters:

b - true if the new proxy enables collocation optimization, false otherwise

Returns:

a proxy with the specified collocation optimization

ice_twoway

PropertiesAdminPrx ice_twoway()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses twoway invocations.

Specified by:

ice_twoway in interface ObjectPrx

Returns:

a proxy that uses twoway invocations

ice_oneway

PropertiesAdminPrx ice_oneway()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses oneway invocations.

Specified by:

ice_oneway in interface ObjectPrx

Returns:

a proxy that uses oneway invocations

ice_batchOneway

PropertiesAdminPrx ice_batchOneway()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses batch oneway invocations.

Specified by:

ice_batchOneway in interface ObjectPrx

Returns:

a proxy that uses batch oneway invocations

ice_datagram

PropertiesAdminPrx ice_datagram()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses datagram invocations.

Specified by:

ice_datagram in interface ObjectPrx

Returns:

a proxy that uses datagram invocations

ice_batchDatagram

PropertiesAdminPrx ice_batchDatagram()

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, but uses batch datagram invocations.

Specified by:

ice_batchDatagram in interface ObjectPrx

Returns:

a proxy that uses batch datagram invocations

ice_compress

PropertiesAdminPrx ice_compress(boolean co)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.

Specified by:

ice_compress in interface ObjectPrx

Parameters:

co - true enables compression for the new proxy, false disables compression.

Returns:

a proxy with the specified compression override setting

ice_connectionId

PropertiesAdminPrx ice_connectionId(String connectionId)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except for its connection ID.

Specified by:

ice_connectionId in interface ObjectPrx

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

PropertiesAdminPrx ice_fixed(Connection connection)

Description copied from interface: ObjectPrx

Creates a proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.

Specified by:

ice_fixed in interface ObjectPrx

Parameters:

connection - the fixed proxy connection

Returns:

a fixed proxy bound to the given connection

ice_staticId

static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::Ice::PropertiesAdmin"