org.pentaho.platform.plugin.services.pluginmgr
Class PluginAdapter

java.lang.Object
  org.pentaho.platform.plugin.services.pluginmgr.PluginAdapter

All Implemented Interfaces:

IPentahoPublisher, IPentahoSystemListener

public class PluginAdapter
extends Object
implements IPentahoSystemListener, IPentahoPublisher

Constructor Summary

PluginAdapter()

Method Summary

String	getDescription()
String	getName()
String	publish(IPentahoSession session, int loggingLevel) Called when the publish is requested.
void	shutdown() Notification of system shutdown.
boolean	startup(IPentahoSession session) Notification of system startup.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginAdapter

public PluginAdapter()

Method Detail

startup

public boolean startup(IPentahoSession session)

Description copied from interface: IPentahoSystemListener

Notification of system startup. This event fires at the end of system initialization, after all system components have started successfully.

Specified by:

startup in interface IPentahoSystemListener

shutdown

public void shutdown()

Description copied from interface: IPentahoSystemListener

Notification of system shutdown. This event fires right before the server context is shutdown.

Specified by:

shutdown in interface IPentahoSystemListener

getDescription

public String getDescription()

Specified by:

getDescription in interface IPentahoPublisher

Returns:

The description of the publisher. This string is displayed in the Publish JSP

getName

public String getName()

Specified by:

getName in interface IPentahoPublisher

Returns:

The name of the publisher. This name is displayed in the Publish JSP

publish

public String publish(IPentahoSession session,
                      int loggingLevel)

Description copied from interface: IPentahoPublisher

Called when the publish is requested.

Specified by:

publish in interface IPentahoPublisher

Parameters:

session - The session of the requester

loggingLevel - Log granularity level

Returns:

message indicating success or failure. This message is shown back to the user that requested the publish.