org.pentaho.platform.repository.subscription
Class SubscriptionHelper

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

public class SubscriptionHelper
extends java.lang.Object

Constructor Summary

SubscriptionHelper()

Method Summary

static java.lang.String	createSubscriptionArchive(java.lang.String subscriptionName, IPentahoSession session, SimpleUrlFactory urlFactory, IParameterProvider sessionParameters)
static java.lang.String	deleteSubscription(java.lang.String subscriptionId, IPentahoSession userSession)
static java.lang.String	deleteSubscriptionArchive(java.lang.String subscriptionName, java.lang.String fileId, IPentahoSession session)
static void	editSubscription(java.lang.String subscriptionName, IPentahoSession session, SimpleUrlFactory urlFactory, java.io.OutputStream outputStream)
static void	getArchived(java.lang.String subscriptionName, java.lang.String fileId, IPentahoSession session, IOutputHandler outputHandler)
static java.text.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 java.lang.String	getSubscriptionOutputLocation(java.lang.String solutionName, java.lang.String actionPath, java.lang.String actionName)
static java.lang.String	getSubscriptionParameters(java.lang.String subscriptionName, IParameterSetter parameters, IPentahoSession session)
static void	runSubscription(java.lang.String subscriptionName, IPentahoSession session, IParameterProvider sessionParameters, SimpleUrlFactory urlFactory, IOutputHandler outputHandler)
static java.lang.String	saveSubscription(IParameterProvider parameterProvider, java.lang.String actionReference, IPentahoSession userSession)
static java.lang.String	saveSubscription(IParameterProvider parameterProvider, java.lang.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(java.lang.String subscriptionName,
                                    IPentahoSession session,
                                    SimpleUrlFactory urlFactory,
                                    java.io.OutputStream outputStream)

saveSubscription

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

saveSubscription

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

deleteSubscription

public static java.lang.String deleteSubscription(java.lang.String subscriptionId,
                                                  IPentahoSession userSession)

runSubscription

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

getArchived

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

getSubscriptionParameters

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

deleteSubscriptionArchive

public static java.lang.String deleteSubscriptionArchive(java.lang.String subscriptionName,
                                                         java.lang.String fileId,
                                                         IPentahoSession session)

createSubscriptionArchive

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

Throws:

BackgroundExecutionException

getSubscriptionOutputLocation

public static java.lang.String getSubscriptionOutputLocation(java.lang.String solutionName,
                                                             java.lang.String actionPath,
                                                             java.lang.String actionName)

getDateTimeFormatter

public static java.text.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: