org.ow2.proactive.scheduler.common.util.logforwarder

Class LogForwardingService

java.lang.Object

org.ow2.proactive.scheduler.common.util.logforwarder.LogForwardingService

public final class LogForwardingService
extends Object

This class provides server and appenders for log forwarding. Forwarding method/protocol (direct socket, ssh-tunneled sockets or ProActive) is specified by the LogForwarding provider.

See Also:

LogForwardingProvider

Constructor Summary

Constructors

Constructor and Description
LogForwardingService(String providerClassname) Create a new LogForwardingService, based on the provider providerClassname.

Method Summary

Modifier and Type	Method and Description
void	addAppender(String loggerName, org.apache.log4j.Appender appender)
AppenderProvider	getAppenderProvider() Create an appender provider that contains an appender to the server created by initialize() method.
URI	getServerURI() Return the URI on which the log server is bound.
void	initialize() Instantiate the LogForwardingProvider specified by providerClassname value, and create and start the log server.
void	removeAllAppenders(String loggerName)
void	removeLogger(String loggerName)
void	terminate() Terminate this logging service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogForwardingService

public LogForwardingService(String providerClassname)

Create a new LogForwardingService, based on the provider providerClassname.

Parameters:

providerClassname - the classname of the provider that will be used (see LogForwardingProvider).

Method Detail

addAppender

public void addAppender(String loggerName,
                        org.apache.log4j.Appender appender)

removeAllAppenders

public void removeAllAppenders(String loggerName)

removeLogger

public void removeLogger(String loggerName)

initialize

public final void initialize()
                      throws LogForwardingException

Instantiate the LogForwardingProvider specified by providerClassname value, and create and start the log server. AppenderProvider to this server are available after the call to initialize().

Throws:

LogForwardingException - if the LogForwardingProvider cannot be instantiated, or if the log server cannot be created.

IllegalStateException - if the LogForwardingService is already initialized.

terminate

public final void terminate()
                     throws LogForwardingException

Terminate this logging service. The log server started by the LogForwardingProvider is terminated. Appenders created by this service cannot be used anymore.

Throws:

LogForwardingException - if the log server started by the LogForwardingProvider cannot be terminated.

getAppenderProvider

public final AppenderProvider getAppenderProvider()
                                           throws LogForwardingException

Create an appender provider that contains an appender to the server created by initialize() method.

Returns:

an appender provider that contains an appender to the server created by initialize() method.

Throws:

LogForwardingException - if the appender provider cannot be created.

IllegalStateException - if the LogForwardingService is not initialized.

getServerURI

public final URI getServerURI()

Return the URI on which the log server is bound.

Returns:

the URI on which the log server is bound.

Throws:

IllegalStateException - if the LogForwardingService is not initialized.