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

Interface LogForwardingProvider

All Known Implementing Classes:

ProActiveBasedForwardingProvider, SocketBasedForwardingProvider, SocketWithSSHTunnelBasedForwardingProvider

public interface LogForwardingProvider

This interface should be implemented by all log forwarding methods. It provide protocol-specific log server and appenders. Appenders are wrapped in an AppenderProvider to be sent over the network and created/activated on the remote side.

See Also:

LogForwardingService

Method Summary

Modifier and Type	Method and Description
AppenderProvider	createAppenderProvider(URI serverURI) Create an appender provider (i.e.
URI	createServer(LoggingEventProcessor eventProcessor) Create locally a server that is able to receive logging events from the appender created by createAppenderProvider.
void	terminateServer() Terminate the server created by createServer().

Method Detail

createAppenderProvider

AppenderProvider createAppenderProvider(URI serverURI)
                                 throws LogForwardingException

Create an appender provider (i.e. a container for appender). This provider is serializable and can be remotely sent. Note that a specific AppenderProvider implementation must be provided with a specific LogForwardingProvider implementation.

Parameters:

serverURI - the URI of the server that receives logging events appended in the contained appender.

Returns:

a container for an appender.

Throws:

LogForwardingException - if the provider cannot be created.

createServer

URI createServer(LoggingEventProcessor eventProcessor)
          throws LogForwardingException

Create locally a server that is able to receive logging events from the appender created by createAppenderProvider.

Returns:

the URI to reach this server.

Throws:

LogForwardingException - if the server cannot be created.

terminateServer

void terminateServer()
              throws LogForwardingException

Terminate the server created by createServer().

Throws:

LogForwardingException - if the server cannot be terminated.