com.ibm.di.api.remote.impl
Class LogListenerBase

java.lang.Object
  extended by java.rmi.server.RemoteObject
      extended by java.rmi.server.RemoteServer
          extended by java.rmi.server.UnicastRemoteObject
              extended by com.ibm.di.api.remote.impl.APIRemoteObject
                  extended by com.ibm.di.api.remote.impl.LogListenerBase
All Implemented Interfaces:
LogListener, RemoteListener, Serializable, Remote, EventListener

public class LogListenerBase
extends APIRemoteObject
implements LogListener

This utility class allows remote clients to register listeners in the Server API. Remote listeners must be RMI server objects.

Since:
7.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.rmi.server.RemoteObject
ref
 
Method Summary
static LogListenerBase createInstance(LogListener localListener)
          Creates and exports an RMI server object, which can be used as a remote call-back.
static LogListenerBase createInstance(LogListener localListener, boolean useSSL)
          Creates and exports an RMI server object, which can be used as a remote call-back.
static LogListenerBase createInstance(LogListener localListener, boolean useSSL, boolean useCustomProperties)
          Creates and exports an RMI server object, which can be used as a remote call-back.
 void messageLogged(String message)
          Called right after the specified message is logged.
 
Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, unexportObject
 
Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog
 
Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toString, toStub
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

createInstance

public static LogListenerBase createInstance(LogListener localListener,
                                             boolean useSSL)
                                      throws Exception,
                                             RemoteException
Creates and exports an RMI server object, which can be used as a remote call-back. The created server object delegates calls to the specified POJO.

Parameters:
localListener - a POJO listener object in the local JVM
useSSL - if true SSL is used
Returns:
the RMI server object
Throws:
Exception - if Runtime or Security exception occurs
RemoteException - if a communication-related exception occurs.

createInstance

public static LogListenerBase createInstance(LogListener localListener)
                                      throws Exception,
                                             RemoteException
Creates and exports an RMI server object, which can be used as a remote call-back. The created server object delegates calls to the specified POJO.

Parameters:
localListener - a POJO listener object in the local JVM.
Returns:
the RMI server object
Throws:
Exception - if Runtime or Security exception occurs
RemoteException - if a communication-related exception occurs.

createInstance

public static LogListenerBase createInstance(LogListener localListener,
                                             boolean useSSL,
                                             boolean useCustomProperties)
                                      throws Exception,
                                             RemoteException
Creates and exports an RMI server object, which can be used as a remote call-back. The created server object delegates calls to the specified POJO.

Parameters:
localListener - a POJO listener object in the local JVM
useSSL - if true SSL is used
useCustomProperties - if true custom SSL properties are used ('api.client.*'), otherwise the default JSSE properties are used ('javax.net.ssl.*')
Returns:
the RMI server object
Throws:
Exception - if Runtime or Security exception occurs
RemoteException - if a communication-related exception occurs.

messageLogged

public void messageLogged(String message)
                   throws DIException,
                          RemoteException
Called right after the specified message is logged.

Specified by:
messageLogged in interface LogListener
Parameters:
message - the message text
Throws:
DIException - If an error is encountered.
RemoteException - if a communication-related exception occurs.