Package com.zeroc.Ice

Interface LoggerAdminPrx

All Superinterfaces:
ObjectPrx

public interface LoggerAdminPrx extends ObjectPrx
Represents the admin facet that allows an Ice application to attach its RemoteLoggerPrx to the local logger of an Ice communicator.
  • Method Details

    • attachRemoteLogger

      default void attachRemoteLogger(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax) throws RemoteLoggerAlreadyAttachedException
      Attaches a RemoteLoggerPrx object to the local logger. This operation calls RemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[]) on prx.
      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 if messageTypes 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 to RemoteLoggerPrx.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 RemoteLoggerAlreadyAttachedException
      Attaches a RemoteLoggerPrx object to the local logger. This operation calls RemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[]) on prx.
      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 if messageTypes 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 to RemoteLoggerPrx.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 a RemoteLoggerPrx object to the local logger. This operation calls RemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[]) on prx.
      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 if messageTypes 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 to RemoteLoggerPrx.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 a RemoteLoggerPrx object to the local logger. This operation calls RemoteLoggerPrx.init(java.lang.String, com.zeroc.Ice.LogMessage[]) on prx.
      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 if messageTypes 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 to RemoteLoggerPrx.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

      default boolean detachRemoteLogger(RemoteLoggerPrx prx)
      Detaches a RemoteLoggerPrx object from the local logger.
      Parameters:
      prx - A proxy to the remote logger.
      Returns:
      true if the provided remote logger proxy was detached, and false otherwise.
    • detachRemoteLogger

      default boolean detachRemoteLogger(RemoteLoggerPrx prx, Map<String,String> context)
      Detaches a RemoteLoggerPrx 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, and false otherwise.
    • detachRemoteLoggerAsync

      default CompletableFuture<Boolean> detachRemoteLoggerAsync(RemoteLoggerPrx prx)
      Detaches a RemoteLoggerPrx object from the local logger.
      Parameters:
      prx - A proxy to the remote logger.
      Returns:
      true if the provided remote logger proxy was detached, and false otherwise.
    • detachRemoteLoggerAsync

      default CompletableFuture<Boolean> detachRemoteLoggerAsync(RemoteLoggerPrx prx, Map<String,String> context)
      Detaches a RemoteLoggerPrx 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, and false 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 if messageTypes 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 if messageTypes 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 if messageTypes 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 if messageTypes 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

      static LoggerAdminPrx createProxy(Communicator communicator, String proxyString)
      Creates a new proxy that implements LoggerAdminPrx.
      Parameters:
      communicator - The communicator of the new proxy.
      proxyString - The string representation of the proxy.
      Returns:
      The new proxy.
    • checkedCast

      static LoggerAdminPrx checkedCast(ObjectPrx obj)
      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

      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. 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

      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. 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

      static LoggerAdminPrx 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. 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

      static LoggerAdminPrx uncheckedCast(ObjectPrx obj)
      Creates a new proxy from an existing proxy.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A new proxy for this type.
    • uncheckedCast

      static LoggerAdminPrx uncheckedCast(ObjectPrx obj, String facet)
      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

      LoggerAdminPrx ice_context(Map<String,String> newContext)
      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 interface ObjectPrx
      Parameters:
      newContext - The context for the new proxy.
      Returns:
      A proxy with the new per-proxy context.
    • ice_adapterId

      LoggerAdminPrx ice_adapterId(String newAdapterId)
      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 interface ObjectPrx
      Parameters:
      newAdapterId - The adapter ID for the new proxy.
      Returns:
      A proxy with the new adapter ID.
    • ice_endpoints

      LoggerAdminPrx ice_endpoints(Endpoint[] newEndpoints)
      Description copied from interface: ObjectPrx
      Creates a new 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

      LoggerAdminPrx ice_locatorCacheTimeout(int newTimeout)
      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 interface ObjectPrx
      Parameters:
      newTimeout - The new locator cache timeout (in seconds).
      Returns:
      A proxy with the new timeout.
      See Also:
    • ice_invocationTimeout

      LoggerAdminPrx ice_invocationTimeout(int newTimeout)
      Description copied from interface: ObjectPrx
      Returns 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:
      The proxy with the new timeout.
    • ice_invocationTimeout

      LoggerAdminPrx ice_invocationTimeout(Duration newTimeout)
      Description copied from interface: ObjectPrx
      Returns 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:
      The proxy with the new timeout.
    • ice_connectionCached

      LoggerAdminPrx ice_connectionCached(boolean newCache)
      Description copied from interface: ObjectPrx
      Returns 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:
      The proxy with the specified caching policy.
    • ice_endpointSelection

      LoggerAdminPrx ice_endpointSelection(EndpointSelectionType newType)
      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 interface ObjectPrx
      Parameters:
      newType - The new endpoint selection policy.
      Returns:
      The proxy with the specified endpoint selection policy.
      See Also:
    • ice_encodingVersion

      LoggerAdminPrx ice_encodingVersion(EncodingVersion e)
      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 interface ObjectPrx
      Parameters:
      e - The encoding version to use to marshal request parameters.
      Returns:
      The proxy with the specified encoding version.
    • ice_router

      LoggerAdminPrx ice_router(RouterPrx router)
      Description copied from interface: ObjectPrx
      Returns 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:
      The proxy with the specified router.
    • ice_locator

      LoggerAdminPrx ice_locator(LocatorPrx locator)
      Description copied from interface: ObjectPrx
      Returns 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:
      The proxy with the specified locator.
    • ice_collocationOptimized

      LoggerAdminPrx ice_collocationOptimized(boolean b)
      Description copied from interface: ObjectPrx
      Returns 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:
      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 interface ObjectPrx
      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 interface ObjectPrx
      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 interface ObjectPrx
      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 interface ObjectPrx
      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 interface ObjectPrx
      Returns:
      A proxy that uses batch datagram invocations.
    • ice_compress

      LoggerAdminPrx ice_compress(boolean co)
      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 interface ObjectPrx
      Parameters:
      co - true enables compression for the new proxy; false disables compression.
      Returns:
      A proxy with the specified compression setting.
    • ice_connectionId

      LoggerAdminPrx ice_connectionId(String 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 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

      LoggerAdminPrx ice_fixed(Connection connection)
      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.
      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::LoggerAdmin"