- All Superinterfaces:
ObjectPrx
Represents the admin facet that allows an Ice application to attach its
RemoteLoggerPrx
to the local
logger of an Ice communicator.-
Field Summary
Fields inherited from interface com.zeroc.Ice.ObjectPrx
ice_staticId, noExplicitContext
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
attachRemoteLogger
(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax) Attaches aRemoteLoggerPrx
object to the local logger.default void
attachRemoteLogger
(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Map<String, String> context) Attaches aRemoteLoggerPrx
object to the local logger.default CompletableFuture<Void>
attachRemoteLoggerAsync
(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax) Attaches aRemoteLoggerPrx
object to the local logger.default CompletableFuture<Void>
attachRemoteLoggerAsync
(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Map<String, String> context) Attaches aRemoteLoggerPrx
object to the local logger.static LoggerAdminPrx
checkedCast
(ObjectPrx obj) Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.static LoggerAdminPrx
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 LoggerAdminPrx
Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation.static LoggerAdminPrx
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 LoggerAdminPrx
createProxy
(Communicator communicator, String proxyString) Creates a new proxy that implementsLoggerAdminPrx
.default boolean
Detaches aRemoteLoggerPrx
object from the local logger.default boolean
detachRemoteLogger
(RemoteLoggerPrx prx, Map<String, String> context) Detaches aRemoteLoggerPrx
object from the local logger.default CompletableFuture<Boolean>
Detaches aRemoteLoggerPrx
object from the local logger.default CompletableFuture<Boolean>
detachRemoteLoggerAsync
(RemoteLoggerPrx prx, Map<String, String> context) Detaches aRemoteLoggerPrx
object from the local logger.default LoggerAdmin.GetLogResult
getLog
(LogMessageType[] messageTypes, String[] traceCategories, int messageMax) Retrieves recently logged log messages.default LoggerAdmin.GetLogResult
getLog
(LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Map<String, String> context) Retrieves recently logged log messages.getLogAsync
(LogMessageType[] messageTypes, String[] traceCategories, int messageMax) Retrieves recently logged log messages.getLogAsync
(LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Map<String, String> context) Retrieves recently logged log messages.ice_adapterId
(String newAdapterId) Creates a new proxy that is identical to this proxy, except for the adapter ID.Creates a new proxy that is identical to this proxy, but uses batch datagram invocations.Creates a new proxy that is identical to this proxy, but uses batch oneway invocations.ice_collocationOptimized
(boolean b) Returns a proxy that is identical to this proxy, except for collocation optimization.ice_compress
(boolean co) Returns a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.ice_connectionCached
(boolean newCache) Returns a proxy that is identical to this proxy, except for connection caching.ice_connectionId
(String connectionId) Returns a proxy that is identical to this proxy, except for its connection ID.ice_context
(Map<String, String> newContext) Creates a new proxy that is identical to this proxy, except for the per-proxy context.Creates a new proxy that is identical to this proxy, but uses datagram invocations.Returns a proxy that is identical to this proxy, except for the encoding used to marshal parameters.ice_endpoints
(Endpoint[] newEndpoints) Creates a new proxy that is identical to this proxy, except for the endpoints.Returns a proxy that is identical to this proxy, except for the endpoint selection policy.ice_fixed
(Connection connection) Creates a new proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection.ice_invocationTimeout
(int newTimeout) Returns a proxy that is identical to this proxy, except for the invocation timeout.ice_invocationTimeout
(Duration newTimeout) Returns a proxy that is identical to this proxy, except for the invocation timeout.ice_locator
(LocatorPrx locator) Returns a proxy that is identical to this proxy, except for the locator.ice_locatorCacheTimeout
(int newTimeout) Creates a new proxy that is identical to this proxy, except for the locator cache timeout.Creates a new proxy that is identical to this proxy, but uses oneway invocations.ice_router
(RouterPrx router) Returns a proxy that is identical to this proxy, except for the router.static String
Gets the type ID of the associated Slice interface.Creates a new proxy that is identical to this proxy, but uses twoway invocations.static LoggerAdminPrx
uncheckedCast
(ObjectPrx obj) Creates a new proxy from an existing proxy.static LoggerAdminPrx
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
-
attachRemoteLogger
default void attachRemoteLogger(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax) throws RemoteLoggerAlreadyAttachedException Attaches aRemoteLoggerPrx
object to the local logger. This operation callsRemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[])
onprx
.- Parameters:
prx
- A proxy to the remote logger.messageTypes
- The list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types).traceCategories
- The categories of traces that the remote logger wishes to receive. This parameter is ignored ifmessageTypes
is not empty and does not include trace. An empty list means no filtering (send all trace categories).messageMax
- The maximum number of log messages (of all types) to be provided toRemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[])
. A negative value requests all messages available.- Throws:
RemoteLoggerAlreadyAttachedException
- Thrown if this remote logger is already attached to this admin object.
-
attachRemoteLogger
default void attachRemoteLogger(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Map<String, String> context) throws RemoteLoggerAlreadyAttachedExceptionAttaches aRemoteLoggerPrx
object to the local logger. This operation callsRemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[])
onprx
.- Parameters:
prx
- A proxy to the remote logger.messageTypes
- The list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types).traceCategories
- The categories of traces that the remote logger wishes to receive. This parameter is ignored ifmessageTypes
is not empty and does not include trace. An empty list means no filtering (send all trace categories).messageMax
- The maximum number of log messages (of all types) to be provided toRemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[])
. A negative value requests all messages available.context
- The Context map to send with the invocation.- Throws:
RemoteLoggerAlreadyAttachedException
- Thrown if this remote logger is already attached to this admin object.
-
attachRemoteLoggerAsync
default CompletableFuture<Void> attachRemoteLoggerAsync(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax) Attaches aRemoteLoggerPrx
object to the local logger. This operation callsRemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[])
onprx
.- Parameters:
prx
- A proxy to the remote logger.messageTypes
- The list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types).traceCategories
- The categories of traces that the remote logger wishes to receive. This parameter is ignored ifmessageTypes
is not empty and does not include trace. An empty list means no filtering (send all trace categories).messageMax
- The maximum number of log messages (of all types) to be provided toRemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[])
. A negative value requests all messages available.- Returns:
- A future that will be completed when the invocation completes.
-
attachRemoteLoggerAsync
default CompletableFuture<Void> attachRemoteLoggerAsync(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Map<String, String> context) Attaches aRemoteLoggerPrx
object to the local logger. This operation callsRemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[])
onprx
.- Parameters:
prx
- A proxy to the remote logger.messageTypes
- The list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types).traceCategories
- The categories of traces that the remote logger wishes to receive. This parameter is ignored ifmessageTypes
is not empty and does not include trace. An empty list means no filtering (send all trace categories).messageMax
- The maximum number of log messages (of all types) to be provided toRemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[])
. A negative value requests all messages available.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed when the invocation completes.
-
detachRemoteLogger
Detaches aRemoteLoggerPrx
object from the local logger.- Parameters:
prx
- A proxy to the remote logger.- Returns:
true
if the provided remote logger proxy was detached, andfalse
otherwise.
-
detachRemoteLogger
Detaches aRemoteLoggerPrx
object from the local logger.- Parameters:
prx
- A proxy to the remote logger.context
- The Context map to send with the invocation.- Returns:
true
if the provided remote logger proxy was detached, andfalse
otherwise.
-
detachRemoteLoggerAsync
Detaches aRemoteLoggerPrx
object from the local logger.- Parameters:
prx
- A proxy to the remote logger.- Returns:
true
if the provided remote logger proxy was detached, andfalse
otherwise.
-
detachRemoteLoggerAsync
default CompletableFuture<Boolean> detachRemoteLoggerAsync(RemoteLoggerPrx prx, Map<String, String> context) Detaches aRemoteLoggerPrx
object from the local logger.- Parameters:
prx
- A proxy to the remote logger.context
- The Context map to send with the invocation.- Returns:
true
if the provided remote logger proxy was detached, andfalse
otherwise.
-
getLog
default LoggerAdmin.GetLogResult getLog(LogMessageType[] messageTypes, String[] traceCategories, int messageMax) Retrieves recently logged log messages.- Parameters:
messageTypes
- The list of message types that the caller wishes to receive. An empty list means no filtering (send all message types).traceCategories
- The categories of traces that caller wish to receive. This parameter is ignored ifmessageTypes
is not empty and does not include trace. An empty list means no filtering (send all trace categories).messageMax
- The maximum number of log messages (of all types) to be returned. A negative value requests all messages available.- Returns:
- An instance of LoggerAdmin.GetLogResult.
-
getLog
default LoggerAdmin.GetLogResult getLog(LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Map<String, String> context) Retrieves recently logged log messages.- Parameters:
messageTypes
- The list of message types that the caller wishes to receive. An empty list means no filtering (send all message types).traceCategories
- The categories of traces that caller wish to receive. This parameter is ignored ifmessageTypes
is not empty and does not include trace. An empty list means no filtering (send all trace categories).messageMax
- The maximum number of log messages (of all types) to be returned. A negative value requests all messages available.context
- The Context map to send with the invocation.- Returns:
- An instance of LoggerAdmin.GetLogResult.
-
getLogAsync
default CompletableFuture<LoggerAdmin.GetLogResult> getLogAsync(LogMessageType[] messageTypes, String[] traceCategories, int messageMax) Retrieves recently logged log messages.- Parameters:
messageTypes
- The list of message types that the caller wishes to receive. An empty list means no filtering (send all message types).traceCategories
- The categories of traces that caller wish to receive. This parameter is ignored ifmessageTypes
is not empty and does not include trace. An empty list means no filtering (send all trace categories).messageMax
- The maximum number of log messages (of all types) to be returned. A negative value requests all messages available.- Returns:
- A future that will be completed with an instance of LoggerAdmin.GetLogResult.
-
getLogAsync
default CompletableFuture<LoggerAdmin.GetLogResult> getLogAsync(LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Map<String, String> context) Retrieves recently logged log messages.- Parameters:
messageTypes
- The list of message types that the caller wishes to receive. An empty list means no filtering (send all message types).traceCategories
- The categories of traces that caller wish to receive. This parameter is ignored ifmessageTypes
is not empty and does not include trace. An empty list means no filtering (send all trace categories).messageMax
- The maximum number of log messages (of all types) to be returned. A negative value requests all messages available.context
- The Context map to send with the invocation.- Returns:
- A future that will be completed with an instance of LoggerAdmin.GetLogResult.
-
createProxy
Creates a new proxy that implementsLoggerAdminPrx
.- Parameters:
communicator
- The communicator of the new proxy.proxyString
- The string representation of the proxy.- Returns:
- The new proxy.
-
checkedCast
Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.- Parameters:
obj
- The source proxy.- Returns:
- A proxy for this type, or null if the object does not support this type.
-
checkedCast
Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.- 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 object does not support this type.
-
checkedCast
Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.- 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
Creates a new proxy from an existing proxy after confirming the target object's type via a remote invocation. Throws a local exception if a communication error occurs.- 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 object does not support this type.
-
uncheckedCast
Creates a new proxy from an existing proxy.- Parameters:
obj
- The untyped proxy.- Returns:
- A new proxy for this type.
-
uncheckedCast
Creates a new proxy from an existing proxy.- Parameters:
obj
- The untyped proxy.facet
- The name of the desired facet.- Returns:
- A new proxy for this type.
-
ice_context
Description copied from interface:ObjectPrx
Creates a new 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 new per-proxy context.
-
ice_adapterId
Description copied from interface:ObjectPrx
Creates a new 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 new adapter ID.
-
ice_endpoints
Description copied from interface:ObjectPrx
Creates a new 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 new endpoints.
-
ice_locatorCacheTimeout
Description copied from interface:ObjectPrx
Creates a new 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 new timeout.
- See Also:
-
ice_invocationTimeout
Description copied from interface:ObjectPrx
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 milliseconds).- Returns:
- The proxy with the new timeout.
-
ice_invocationTimeout
Description copied from interface:ObjectPrx
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.- Returns:
- The proxy with the new timeout.
-
ice_connectionCached
Description copied from interface:ObjectPrx
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:
- The proxy with the specified caching policy.
-
ice_endpointSelection
Description copied from interface:ObjectPrx
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:
- The proxy with the specified endpoint selection policy.
- See Also:
-
ice_encodingVersion
Description copied from interface:ObjectPrx
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:
- The proxy with the specified encoding version.
-
ice_router
Description copied from interface:ObjectPrx
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:
- The proxy with the specified router.
-
ice_locator
Description copied from interface:ObjectPrx
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:
- The proxy with the specified locator.
-
ice_collocationOptimized
Description copied from interface:ObjectPrx
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:
- The proxy with the specified collocation optimization.
-
ice_twoway
LoggerAdminPrx ice_twoway()Description copied from interface:ObjectPrx
Creates a new 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
LoggerAdminPrx ice_oneway()Description copied from interface:ObjectPrx
Creates a new 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
LoggerAdminPrx ice_batchOneway()Description copied from interface:ObjectPrx
Creates a new 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
LoggerAdminPrx ice_datagram()Description copied from interface:ObjectPrx
Creates a new 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
LoggerAdminPrx ice_batchDatagram()Description copied from interface:ObjectPrx
Creates a new 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
Description copied from interface:ObjectPrx
Returns 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 interfaceObjectPrx
- Parameters:
co
-true
enables compression for the new proxy;false
disables compression.- Returns:
- A proxy with the specified compression setting.
-
ice_connectionId
Description copied from interface:ObjectPrx
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
Description copied from interface:ObjectPrx
Creates a new proxy that is identical to this proxy, except it's a fixed proxy bound to the given connection. -
ice_staticId
Gets the type ID of the associated Slice interface.- Returns:
- the string "::Ice::LoggerAdmin"
-