Module com.zeroc.ice

Package com.zeroc.Ice

Interface LoggerAdmin

All Superinterfaces:

Object

public interface LoggerAdmin
extends Object

Represents the admin facet that allows an Ice application to attach its RemoteLoggerPrx to the local logger of an Ice communicator.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LoggerAdmin.GetLogResult	Holds the result of operation getLog.

Nested classes/interfaces inherited from interface com.zeroc.Ice.Object

Object.Ice_invokeResult

Method Summary

Modifier and Type	Method	Description
void	attachRemoteLogger(RemoteLoggerPrx prx, LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Current current)	Attaches a RemoteLoggerPrx object to the local logger.
boolean	detachRemoteLogger(RemoteLoggerPrx prx, Current current)	Detaches a RemoteLoggerPrx object from the local logger.
default CompletionStage<OutgoingResponse>	dispatch(IncomingRequest request)	Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
LoggerAdmin.GetLogResult	getLog(LogMessageType[] messageTypes, String[] traceCategories, int messageMax, Current current)	Retrieves recently logged log messages.
static String	ice_staticId()	Gets the type ID of the associated Slice interface.

Methods inherited from interface com.zeroc.Ice.Object

ice_id, ice_ids, ice_isA, ice_ping

Method Details

attachRemoteLogger

void attachRemoteLogger(RemoteLoggerPrx prx,
 LogMessageType[] messageTypes,
 String[] traceCategories,
 int messageMax,
 Current current)
                 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.

current - The Current object of the incoming request.

Throws:

RemoteLoggerAlreadyAttachedException - Thrown if this remote logger is already attached to this admin object.

detachRemoteLogger

boolean detachRemoteLogger(RemoteLoggerPrx prx,
 Current current)

Detaches a RemoteLoggerPrx object from the local logger.

Parameters:

prx - A proxy to the remote logger.

current - The Current object of the incoming request.

Returns:

true if the provided remote logger proxy was detached, and false otherwise.

getLog

LoggerAdmin.GetLogResult getLog(LogMessageType[] messageTypes,
 String[] traceCategories,
 int messageMax,
 Current current)

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.

current - The Current object of the incoming request.

Returns:

An instance of LoggerAdmin.GetLogResult.

ice_staticId

static String ice_staticId()

Gets the type ID of the associated Slice interface.

Returns:

the string "::Ice::LoggerAdmin"

dispatch

default CompletionStage<OutgoingResponse> dispatch(IncomingRequest request)
                                            throws UserException

Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.

Specified by:

dispatch in interface Object

Parameters:

request - the incoming request

Returns:

the outgoing response

Throws:

UserException - if a UserException is thrown, Ice will marshal it as the response payload.