Package com.zeroc.Ice

Interface LoggerAdminPrx

All Superinterfaces:
ObjectPrx
public interface LoggerAdminPrx extends ObjectPrx
The interface of the admin object that allows an Ice application the attach its RemoteLogger to the Logger of this admin object's Ice communicator.

  • Method Details

    • attachRemoteLogger

      default void attachRemoteLogger(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax) throws RemoteLoggerAlreadyAttachedException
      Attaches a RemoteLogger object to the local logger. attachRemoteLogger calls init on the provided RemoteLogger proxy.
      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 init. A negative value requests all messages available.
      Throws:
      RemoteLoggerAlreadyAttachedException - Raised 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 RemoteLogger object to the local logger. attachRemoteLogger calls init on the provided RemoteLogger proxy.
      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 init. A negative value requests all messages available.
      context - The Context map to send with the invocation.
      Throws:
      RemoteLoggerAlreadyAttachedException - Raised 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 RemoteLogger object to the local logger. attachRemoteLogger calls init on the provided RemoteLogger proxy.
      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 init. 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 RemoteLogger object to the local logger. attachRemoteLogger calls init on the provided RemoteLogger proxy.
      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 init. 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 RemoteLogger 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 RemoteLogger 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 RemoteLogger 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 RemoteLogger 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 log messages recently logged.
      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 log messages recently logged.
      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 log messages recently logged.
      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 log messages recently logged.
      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.

    • checkedCast

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

      static LoggerAdminPrx checkedCast(ObjectPrx obj, Map<String,String> context)
      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

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

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

      static LoggerAdminPrx uncheckedCast(ObjectPrx obj)
      Downcasts the given proxy to this type without contacting the remote server.
      Parameters:
      obj - The untyped proxy.
      Returns:
      A proxy for this type.

    • uncheckedCast

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

      default LoggerAdminPrx ice_context(Map<String,String> newContext)
      Returns 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 specified per-proxy context.

    • ice_adapterId

      default LoggerAdminPrx ice_adapterId(String newAdapterId)
      Returns 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 specified adapter ID.

    • ice_endpoints

      default LoggerAdminPrx ice_endpoints(Endpoint[] newEndpoints)
      Returns 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 specified endpoints.

    • ice_locatorCacheTimeout

      default LoggerAdminPrx ice_locatorCacheTimeout(int newTimeout)
      Returns 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 specified locator cache timeout.
      See Also:

    • ice_invocationTimeout

      default LoggerAdminPrx ice_invocationTimeout(int newTimeout)
      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:
      A proxy with the specified invocation timeout.

    • ice_connectionCached

      default LoggerAdminPrx ice_connectionCached(boolean newCache)
      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:
      A proxy with the specified caching policy.

    • ice_endpointSelection

      default LoggerAdminPrx ice_endpointSelection(EndpointSelectionType newType)
      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:
      A proxy with the specified endpoint selection policy.
      See Also:

    • ice_secure

      default LoggerAdminPrx ice_secure(boolean b)
      Returns a proxy that is identical to this proxy, except for how it selects endpoints.
      Specified by:
      ice_secure in interface ObjectPrx
      Parameters:
      b - If b is true, only endpoints that use a secure transport are used by the new proxy. If b is false, the returned proxy uses both secure and insecure endpoints.
      Returns:
      A proxy with the specified selection policy.

    • ice_encodingVersion

      default LoggerAdminPrx ice_encodingVersion(EncodingVersion e)
      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:
      A proxy with the specified encoding version.

    • ice_preferSecure

      default LoggerAdminPrx ice_preferSecure(boolean b)
      Returns a proxy that is identical to this proxy, except for its endpoint selection policy.
      Specified by:
      ice_preferSecure in interface ObjectPrx
      Parameters:
      b - If b is true, the new proxy will use secure endpoints for invocations and only use insecure endpoints if an invocation cannot be made via secure endpoints. If b is false, the proxy prefers insecure endpoints to secure ones.
      Returns:
      A proxy with the specified selection policy.

    • ice_router

      default LoggerAdminPrx ice_router(RouterPrx router)
      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:
      A proxy with the specified router.

    • ice_locator

      default LoggerAdminPrx ice_locator(LocatorPrx locator)
      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:
      A proxy with the specified locator.

    • ice_collocationOptimized

      default LoggerAdminPrx ice_collocationOptimized(boolean b)
      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:
      A proxy with the specified collocation optimization.

    • ice_twoway

      default LoggerAdminPrx ice_twoway()
      Returns 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

      default LoggerAdminPrx ice_oneway()
      Returns 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

      default LoggerAdminPrx ice_batchOneway()
      Returns 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

      default LoggerAdminPrx ice_datagram()
      Returns 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

      default LoggerAdminPrx ice_batchDatagram()
      Returns 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

      default LoggerAdminPrx ice_compress(boolean co)
      Returns a proxy that is identical to this proxy, except for compression.
      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_timeout

      default LoggerAdminPrx ice_timeout(int t)
      Returns a proxy that is identical to this proxy, except for its connection timeout setting.
      Specified by:
      ice_timeout in interface ObjectPrx
      Parameters:
      t - The connection timeout for the proxy in milliseconds.
      Returns:
      A proxy with the specified timeout.

    • ice_connectionId

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

      default LoggerAdminPrx 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.
      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()
      Description copied from interface: ObjectPrx
      Returns the Slice type ID associated with this type.
      Returns:
      The Slice type ID.