Ice

Interface _LoggerAdminOperationsNC

All Known Subinterfaces:

LoggerAdmin

All Known Implementing Classes:

_LoggerAdminDisp

public interface _LoggerAdminOperationsNC

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 Summary

Modifier and Type	Method and Description
void	attachRemoteLogger(RemoteLoggerPrx prx, LogMessageType[] messageTypes, java.lang.String[] traceCategories, int messageMax) Attaches a RemoteLogger object to the local logger.
boolean	detachRemoteLogger(RemoteLoggerPrx prx) Detaches a RemoteLogger object from the local logger.
LogMessage[]	getLog(LogMessageType[] messageTypes, java.lang.String[] traceCategories, int messageMax, StringHolder prefix) Retrieves log messages recently logged.

Method Detail

attachRemoteLogger

void attachRemoteLogger(RemoteLoggerPrx prx,
                        LogMessageType[] messageTypes,
                        java.lang.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.

detachRemoteLogger

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.

getLog

LogMessage[] getLog(LogMessageType[] messageTypes,
                    java.lang.String[] traceCategories,
                    int messageMax,
                    StringHolder prefix)

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.

prefix - The prefix of the associated local logger.

Returns:

The Log messages.