com.cloupia.lib.util.managedreports

Class APIFunctions

java.lang.Object

com.cloupia.lib.util.managedreports.APIFunctions

public class APIFunctions
extends java.lang.Object

This class provides utilities to access reports and the data from UCSD

Constructor Summary

Constructors

Constructor and Description
APIFunctions()

Method Summary

Modifier and Type	Method and Description
ReportContext	createContext(java.lang.String contextName, java.lang.String cloud, java.lang.String value)
ReportContext	createContextByType(int contextType, java.lang.String cloud, java.lang.String value)
APINameValue	createNameValue(java.lang.String name, java.lang.String value) Is used to create APINameValue which will be used to create APINameValueList to pass it to a workflow
APINameValueList	createNameValueList() Cloupia Script example to create list var params = util.createNameValueList(); params.addNameValue(util.createNameValue(Input_A, a)); params.addNameValue(util.createNameValue(Input_B, 1000)); params.addNameValue(util.createNameValue(Input_C, something));
int	getCloudType(java.lang.String cloudName)
CUICBranding	getCUICBranding()
HistoricalReport	getHistoricalReport(java.lang.String reportName, java.lang.String durationName, ReportContext context)
SnapshotReport	getSnapshotReport(java.lang.String reportName, ReportContext context)
TableView	getTabularReport(java.lang.String reportName, ReportContext context)
boolean	isAddressInTheSubnet(java.lang.String networkIP, java.lang.String subnetMask, java.lang.String addr)
boolean	isSameNetwork(java.lang.String ip1, java.lang.String ip2, java.lang.String subnetMask)
void	setDataStoreViaVSC(java.lang.String permission)

Methods inherited from class java.lang.Object

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

Constructor Detail

APIFunctions

public APIFunctions()

Method Detail

createNameValue

public APINameValue createNameValue(java.lang.String name,
                                    java.lang.String value)

Is used to create APINameValue which will be used to create APINameValueList to pass it to a workflow

Parameters:

name - Label of the work flow input

value - to be used when executing the work flow

Returns:

APINameValue

createNameValueList

public APINameValueList createNameValueList()

Cloupia Script example to create list var params = util.createNameValueList(); params.addNameValue(util.createNameValue(Input_A, a)); params.addNameValue(util.createNameValue(Input_B, 1000)); params.addNameValue(util.createNameValue(Input_C, something));

Returns:

createContext

public ReportContext createContext(java.lang.String contextName,
                                   java.lang.String cloud,
                                   java.lang.String value)
                            throws java.lang.Exception

Parameters:

contextName - Refer to UCSD API Guide for the available contexts

cloud - should be null unless contextName is "cloud" or "host node"

value - identifier of the object that is going to be referenced

Returns:

Throws:

java.lang.Exception

createContextByType

public ReportContext createContextByType(int contextType,
                                         java.lang.String cloud,
                                         java.lang.String value)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getTabularReport

public TableView getTabularReport(java.lang.String reportName,
                                  ReportContext context)
                           throws java.lang.Exception

Parameters:

reportName - This is ID of a report, which can be accessed from UCSD, Administration --> User Interface Settings --> Reports Customization

context -

Returns:

Throws:

java.lang.Exception

getSnapshotReport

public SnapshotReport getSnapshotReport(java.lang.String reportName,
                                        ReportContext context)
                                 throws java.lang.Exception

Parameters:

reportName - This is ID of a report, which can be accessed from UCSD, Administration --> User Interface Settings --> Reports Customization

context -

Returns:

Throws:

java.lang.Exception

getHistoricalReport

public HistoricalReport getHistoricalReport(java.lang.String reportName,
                                            java.lang.String durationName,
                                            ReportContext context)
                                     throws java.lang.Exception

Parameters:

reportName - This is ID of a report, which can be accessed from UCSD, Administration --> User Interface Settings --> Reports Customization

durationName -

context -

Returns:

Throws:

java.lang.Exception

isAddressInTheSubnet

public boolean isAddressInTheSubnet(java.lang.String networkIP,
                                    java.lang.String subnetMask,
                                    java.lang.String addr)

Parameters:

networkIP -

subnetMask -

addr -

Returns:

getCUICBranding

public CUICBranding getCUICBranding()

isSameNetwork

public boolean isSameNetwork(java.lang.String ip1,
                             java.lang.String ip2,
                             java.lang.String subnetMask)

Parameters:

ip1 -

ip2 -

subnetMask -

Returns:

getCloudType

public int getCloudType(java.lang.String cloudName)

Parameters:

cloud - name

Returns:

cloud type

setDataStoreViaVSC

public void setDataStoreViaVSC(java.lang.String permission)