Package com.microstrategy.webapi

Class ACMDistributor

java.lang.Object

com.microstrategy.webapi.ACMDistributor

public class ACMDistributor
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
ACMDistributor()

Method Summary

Modifier and Type	Method	Description
static com.microstrategy.webapi.ACMDistDistributorData	runSession(java.lang.String iSessionId, ACMConsolidator<ACMDestination.SessionDestination,ACMDestination.SessionTargetDestination> iConsolidator, java.util.Set<java.lang.String> iProjectIds)	runSession uses the iConsolidator to run an XML API that requires a session, iSessionId, on one or more IServers in a Cluster.
static com.microstrategy.webapi.ACMDistDistributorData	runSessionless(java.lang.String iClusterName, ACMConsolidator<ACMDestination.SessionlessDestination,ACMDestination.SessionlessTargetDestination> iConsolidator)	runSessionless uses the iConsolidator to run an XML API that does not require a session on one or more IServers in a Cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

ACMDistributor

public ACMDistributor()

Method Detail

runSession

public static com.microstrategy.webapi.ACMDistDistributorData runSession(java.lang.String iSessionId,
                                                                         ACMConsolidator<ACMDestination.SessionDestination,ACMDestination.SessionTargetDestination> iConsolidator,
                                                                         java.util.Set<java.lang.String> iProjectIds)
                                                                  throws MSTRWebAPIException

runSession uses the iConsolidator to run an XML API that requires a session, iSessionId, on one or more IServers in a Cluster. If the iProjectIds is null or empty, then all projects across the entire Cluster will be used.

Parameters:

iSessionId - a Session Id created by the ACM infrastructure. It can be a MasterSessionId or it must be resolvable to a MasterSessionId

iConsolidator - the concrete ACMConsolidator that implements the XML API logic

iProjectIds - a list of the project ids. If it is provided, results will only be requested/collected for these given projects. Otherwise, get the results for all the projects in the cluster.

Returns:

ACMDistributorData which includes results and/or errors

Throws:

MSTRWebAPIException

runSessionless

public static com.microstrategy.webapi.ACMDistDistributorData runSessionless(java.lang.String iClusterName,
                                                                             ACMConsolidator<ACMDestination.SessionlessDestination,ACMDestination.SessionlessTargetDestination> iConsolidator)
                                                                      throws MSTRWebAPIException

runSessionless uses the iConsolidator to run an XML API that does not require a session on one or more IServers in a Cluster.

Parameters:

iClusterName - the name of the cluster

iConsolidator - the concrete ACMConsolidator that implements the XML API logic

Returns:

ACMDistributorData which includes results and/or errors

Throws:

MSTRWebAPIException