RMILog Class Reference

Inherits org::apache::harmony::rmi::common::RMIProperties.

List of all members.

---

Detailed Description

Class containing all RMI logging functionality.

Author:

Mikhail A. Markov

Version:

Revision

1.1.2.4

Public Member Functions
boolean	isLoggable (Level l)
	Checks if underlying logger would log a message with the specified level.
void	log (Level l, String msg)
	Logs specified message prepended by the current Thread's name with the given level to the underlying logger.
void	log (Level l, String msg, Throwable t)
	Logs specified message prepended by the current Thread's name and Throwable object with the given level to the underlying logger.
synchronized void	setOutputStream (OutputStream out)
	Adds additional handler to the underlying logger from the given OutputStream.
synchronized PrintStream	getPrintStream ()
	Returns PrintStream where RMI logs messages.
Static Public Member Functions
static RMILog	getServerCallsLog ()
	Helper method.
static RMILog	getClientCallsLog ()
	Helper method.
static RMILog	getServerRefLog ()
	Helper method.
static RMILog	getClientRefLog ()
	Helper method.
static RMILog	getDGCLog ()
	Helper method.
static RMILog	getLoaderLog ()
	Helper method.
static RMILog	getTransportLog ()
	Helper method.
static RMILog	getTcpTransportLog ()
	Helper method.
static RMILog	getProxyTransportLog ()
	Helper method.
static RMILog	getActivationLog ()
	Helper method.
static RMILog	getLog (String loggerName, String logLevel)
	Creates RMILog.
static RMILog	getLog (String loggerName, final Level logLevel)
	Creates RMILog.
static Level	parseLevelString (String levelStr)
	Parses the given string and returns the corresponding Level object.
Static Public Attributes
static final Level	SILENT = Level.OFF
	RMI logging level corresponding to Level.OFF value.
static final Level	BRIEF = Level.FINE
	RMI logging level corresponding to Level.FINE value.
static final Level	VERBOSE = Level.FINER
	RMI logging level corresponding to Level.FINER value.
Private Member Functions
	RMILog (Logger logger)
String[]	getLogSource ()
Static Private Member Functions
static boolean	getBoolean (String propName)
static String	getString (String propName)
Private Attributes
Logger	logger
RMIStreamHandler	rmiLogHandler
Static Private Attributes
static Handler	consoleHandler
Classes
class	RMIStreamHandler

---

Constructor & Destructor Documentation

RMILog

(

Logger

logger

)

[private]

---

Member Function Documentation

static RMILog getServerCallsLog

(

)

[static]

Helper method.

Returns RMILog for logging remote calls on server side. If such a log does not exist, creates it.

Returns:

RMILog for logging remote calls on server side

static RMILog getClientCallsLog

(

)

[static]

Helper method.

Returns RMILog for logging remote calls on client side. If such a log does not exist, creates it.

Returns:

RMILog for logging remote calls on client side

static RMILog getServerRefLog

(

)

[static]

Helper method.

Returns RMILog for logging remote reference activity on server side. If such a log does not exist, creates it.

Returns:

RMILog for logging remote reference activity on server side

static RMILog getClientRefLog

(

)

[static]

Helper method.

Returns RMILog for logging remote reference activity on client side. If such a log does not exist, creates it.

Returns:

RMILog for logging remote reference activity on client side

static RMILog getDGCLog

(

)

[static]

Helper method.

Returns RMILog for logging DGC activity. If such a log does not exist, creates it.

Returns:

RMILog for logging DGC activity

static RMILog getLoaderLog

(

)

[static]

Helper method.

Returns RMILog for logging activity of default RMIClassLoader provider. If such a log does not exist, creates it.

Returns:

RMILog for logging activity of default RMIClassLoader provider

static RMILog getTransportLog

(

)

[static]

Helper method.

Returns RMILog for logging transport-layer activity. If such a log does not exist, creates it.

Returns:

RMILog for logging transport-layer activity

static RMILog getTcpTransportLog

(

)

[static]

Helper method.

Returns RMILog for logging TCP binding/connection activity. If such a log does not exist, creates it.

Returns:

RMILog for logging TCP binding/connection activity

static RMILog getProxyTransportLog

(

)

[static]

Helper method.

Returns RMILog for logging HTTP connections activity. If such a log does not exist, creates it.

Returns:

RMILog for logging HTTP connections activity

static RMILog getActivationLog

(

)

[static]

Helper method.

Returns RMILog for logging Activation/ActivationGroup/Rmid events. If such a log does not exist, creates it.

Returns:

RMILog for logging remote calls on server side

static RMILog getLog	(	String	loggerName,
		String	logLevel
	)			[static]

Creates RMILog.

Underlying logger will have the name 'loggerName'. The level for created RMILog will be equal to 'logLevel' value.

Parameters:

	loggerName	the name of the logger to be obtained
	logLevel	the level for RMILog: it should be one of RMI logging levels (SILENT, BRIEF, VERBOSE or one of levels from java.util.logging.Level class

static RMILog getLog	(	String	loggerName,
		final Level	logLevel
	)			[static]

Creates RMILog.

Underlying logger will have the name 'loggerName'. The level for created RMILog will be equal to 'logLevel' value.

Parameters:

	loggerName	the name of the logger to be obtained
	logLevel	the level for RMILog

static Level parseLevelString

(

String

levelStr

)

[static]

Parses the given string and returns the corresponding Level object.

Possible values for the incoming string are one of RMI logging levels (SILENT, BRIEF, VERBOSE or one of levels from java.util.logging.Level class. If the given string is null or it could not be parsed then Level.OFF value will be returned.

Parameters:

levelStr

String to be parsed

Returns:

parsed Level or Level.OFF if the given string is null or an error occurred while it's parsing

boolean isLoggable

(

Level

l

)

Checks if underlying logger would log a message with the specified level.

Parameters:

l

Logging level to be checked

Returns:

true if underlying logger would log a message with the specified level and false otherwise

void log	(	Level	l,
		String	msg
	)

Logs specified message prepended by the current Thread's name with the given level to the underlying logger.

Parameters:

	l	logging level of the message
	msg	message to be logged

void log	(	Level	l,
		String	msg,
		Throwable	t
	)

Logs specified message prepended by the current Thread's name and Throwable object with the given level to the underlying logger.

Parameters:

	l	logging level of the message and Throwable
	msg	message to be logged
	t	Throwable to be logged

synchronized void setOutputStream

(

OutputStream

out

)

Adds additional handler to the underlying logger from the given OutputStream.

If this method with non-null parameter was already called and thus additional handler already exists, this handler will be replaced by newly created handler. This method is intended to be used by RemoteServer.setLog() method.

Parameters:

out

OutputStream for additional handler. If it's null then messages will not be logged to any additional handlers.

See also:

RemoteServer.setLog(OutputStream)

synchronized PrintStream getPrintStream

(

)

Returns PrintStream where RMI logs messages.

This method is intended to be used by RemoteServer.getLog() method

Returns:

PrintStream where RMI logs messages (possibly null)

See also:

RemoteServer.getLog()

static boolean getBoolean

(

String

propName

)

[static, private]

static String getString

(

String

propName

)

[static, private]

String [] getLogSource

(

)

[private]

---

Member Data Documentation

final Level SILENT = Level.OFF [static]

RMI logging level corresponding to Level.OFF value.

final Level BRIEF = Level.FINE [static]

RMI logging level corresponding to Level.FINE value.

final Level VERBOSE = Level.FINER [static]

RMI logging level corresponding to Level.FINER value.

Handler consoleHandler [static, private]

Initial value:

        (Handler) AccessController.doPrivileged(new PrivilegedAction() {
            public Object run() {
                Handler h = new RMIStreamHandler(System.err);
                h.setLevel(Level.ALL);
                return h;
            }
        })

Logger logger [private]

RMIStreamHandler rmiLogHandler [private]