org.pentaho.platform.engine.core.system
Class BasePublisher

java.lang.Object
  extended by org.pentaho.platform.engine.core.system.PentahoBase
      extended by org.pentaho.platform.engine.core.system.BasePublisher
All Implemented Interfaces:
Serializable, ILogger, IPentahoPublisher
Direct Known Subclasses:
CleanRepoPublisher, GlobalListsPublisher, MetadataPublisher, MondrianCachePublisher, SettingsPublisher, SolutionPublisher, SubscriptionPublisher

public abstract class BasePublisher
extends PentahoBase
implements IPentahoPublisher

See Also:
Serialized Form

Field Summary
static boolean debug
           
 
Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase
EMPTYLOGID, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR
 
Fields inherited from interface org.pentaho.platform.api.engine.ILogger
ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN
 
Constructor Summary
BasePublisher()
           
 
Method Summary
abstract  String publish(IPentahoSession session)
           
 String publish(IPentahoSession session, int pLoggingLevel)
          Called when the publish is requested.
 
Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase
debug, debug, error, error, fatal, fatal, genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLogger, getLoggingLevel, getLogId, getObjectName, info, info, setLoggingLevel, setLogId, trace, trace, warn, warn
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.platform.api.engine.IPentahoPublisher
getDescription, getName
 

Field Detail

debug

public static final boolean debug
See Also:
Constant Field Values
Constructor Detail

BasePublisher

public BasePublisher()
Method Detail

publish

public abstract String publish(IPentahoSession session)

publish

public String publish(IPentahoSession session,
                      int pLoggingLevel)
Description copied from interface: IPentahoPublisher
Called when the publish is requested.

Specified by:
publish in interface IPentahoPublisher
Parameters:
session - The session of the requester
pLoggingLevel - Log granularity level
Returns:
message indicating success or failure. This message is shown back to the user that requested the publish.