org.pentaho.platform.repository.subscription
Class SubscriptionHelper

java.lang.Object
  org.pentaho.platform.repository.subscription.SubscriptionHelper

public class SubscriptionHelper
extends Object

Constructor Summary

SubscriptionHelper()

Method Summary

static String	createSubscriptionArchive(String subscriptionName, IPentahoSession session, SimpleUrlFactory urlFactory, IParameterProvider sessionParameters)
static String	deleteSubscription(String subscriptionId, IPentahoSession userSession)
static String	deleteSubscriptionArchive(String subscriptionName, String fileId, IPentahoSession session)
static void	editSubscription(String subscriptionName, IPentahoSession session, SimpleUrlFactory urlFactory, OutputStream outputStream)
static void	getArchived(String subscriptionName, String fileId, IPentahoSession session, IOutputHandler outputHandler)
static DateFormat	getDateTimeFormatter() This formatter works with a date/time string with this format: May 21, 2008 8:29:21 PM NOTE: the formatter cannot be shared across threads (since DateFormat implementations are not guaranteed to be thread safe) or across sessions (since different sessions may have different locales).
static String	getSubscriptionOutputLocation(String solutionName, String actionPath, String actionName)
static String	getSubscriptionParameters(String subscriptionName, IParameterSetter parameters, IPentahoSession session)
static void	runSubscription(String subscriptionName, IPentahoSession session, IParameterProvider sessionParameters, SimpleUrlFactory urlFactory, IOutputHandler outputHandler)
static String	saveSubscription(IParameterProvider parameterProvider, String actionReference, IPentahoSession userSession)
static String	saveSubscription(IParameterProvider parameterProvider, String actionReference, IPentahoSession userSession, boolean saveOnly)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionHelper

public SubscriptionHelper()

Method Detail

editSubscription

public static void editSubscription(String subscriptionName,
                                    IPentahoSession session,
                                    SimpleUrlFactory urlFactory,
                                    OutputStream outputStream)

saveSubscription

public static String saveSubscription(IParameterProvider parameterProvider,
                                      String actionReference,
                                      IPentahoSession userSession)

saveSubscription

public static String saveSubscription(IParameterProvider parameterProvider,
                                      String actionReference,
                                      IPentahoSession userSession,
                                      boolean saveOnly)

deleteSubscription

public static String deleteSubscription(String subscriptionId,
                                        IPentahoSession userSession)

runSubscription

public static void runSubscription(String subscriptionName,
                                   IPentahoSession session,
                                   IParameterProvider sessionParameters,
                                   SimpleUrlFactory urlFactory,
                                   IOutputHandler outputHandler)

getArchived

public static void getArchived(String subscriptionName,
                               String fileId,
                               IPentahoSession session,
                               IOutputHandler outputHandler)

getSubscriptionParameters

public static String getSubscriptionParameters(String subscriptionName,
                                               IParameterSetter parameters,
                                               IPentahoSession session)

deleteSubscriptionArchive

public static String deleteSubscriptionArchive(String subscriptionName,
                                               String fileId,
                                               IPentahoSession session)

createSubscriptionArchive

public static String createSubscriptionArchive(String subscriptionName,
                                               IPentahoSession session,
                                               SimpleUrlFactory urlFactory,
                                               IParameterProvider sessionParameters)
                                        throws BackgroundExecutionException

Throws:

BackgroundExecutionException

getSubscriptionOutputLocation

public static String getSubscriptionOutputLocation(String solutionName,
                                                   String actionPath,
                                                   String actionName)

getDateTimeFormatter

public static DateFormat getDateTimeFormatter()

This formatter works with a date/time string with this format: May 21, 2008 8:29:21 PM NOTE: the formatter cannot be shared across threads (since DateFormat implementations are not guaranteed to be thread safe) or across sessions (since different sessions may have different locales). So create a new one an each call.

Returns: