oracle.epm.fm.domainobject.application

Class JHsxClient

java.lang.Object

oracle.epm.fm.domainobject.application.JHsxClient

public class JHsxClient
extends Object

Method Summary

Modifier and Type	Method and Description
int	backupApplication(String clusterName, HsxRequestContext hsxRequestContext, String appName, String path, boolean isToBeScrambled, double scramblingValue, boolean isCopyTaskAudit, boolean isCopyDataAudit, int rowCount) Backup the application.
String	convertVBScriptToPureXML(HsxRequestContext hsxRequestContext, String clusterName, String applicationName, String vbScript, boolean compLevelCondition, int compSplitOption, String dimensionMapping)
String	convertVBScriptToXML(HsxRequestContext hsxRequestContext, String clusterName, String applicationName, String vbScript)
String	convertVBScriptToXMLOnFly(HsxRequestContext hsxRequestContext, String clusterName, String applicationName, String vbScript, boolean compLevelCondition, int compSplitOption, String calcType)
String	convertXMLToVBScript(HsxRequestContext hsxRequestContext, String clusterName, String applicationName, String calcMgrXML)
void	createApplication(HsxRequestContext hsxRequestContext, String clusterName, String appName, String appDescription, InputStream profileStream, String projectName, String webServerURL, APPLICATION_TYPES appType) Creates an applicaiton on the server
SessionInfo	createSession(HsxRequestContext hsxRequestContext, String server, int port, String appName) This opens the application specified and returns a valid sessionId for that application.
SessionInfo	createSession(HsxRequestContext hsxRequestContext, String clusterName, String appName) This opens the application specified and returns a valid sessionId for that application.
SessionInfo	createSession(HsxRequestContext hsxRequestContext, String user, String password, String server, int port, String appName) This opens the application specified and returns a valid sessionId for that application.
void	deleteApplication(HsxRequestContext hsxRequestContext, String clusterName, String appName) Deletes the application.
int	duplicateApplication(String clusterName, HsxRequestContext hsxRequestContext, String appName, String newAppName, String newAppDescription, boolean isCopyTaskAudit, boolean isCopyDataAudit, String projectName, boolean isHFMMode)
byte[]	getAdminTaskLogData(HsxRequestContext hsxRequestContext, String clusterName, int taskID) Returns the log information of the current admin task id as a string
AdminTaskProgress	getAdminTaskProgress(HsxRequestContext hsxRequestContext, String clusterName, int taskID)
Map<String,String>	getAllSettings(HsxRequestContext hsxRequestContext, String clusterName, String serverName, String applicationName) Method to get the all setting value from xfm paramater table
Map<USERPREFERENCES,String>	getAllUserPreferenceValues(HsxRequestContext hsxRequestContext, String clusterName, String appName) Gets all the user perferences for an application.
APPLICATION_ENABLED_STATUS	getApplicationEnabledStatus(HsxRequestContext hsxRequestContext, String ssoToken, String clusterName, String serverName, String applicationName)
List<String>	getApplicationLanguages(HsxRequestContext hsxRequestContext, String clusterName, String applicationName) returns the applciation lanugages
APPLICATION_MODE	getApplicationMode(HsxRequestContext hsxRequestContext, String clusterName, String appName) Gets the application mode for the Application specified
byte[]	getApplicationProfileData(HsxRequestContext hsxRequestContext, String clusterName, String ssoToken, String applicationName) extracts the application profile data for any given application name.
APPLICATION_RULES_MODE	getApplicationRulesMode(HsxRequestContext hsxRequestContext, String clusterName, String appName) Gets the application rules mode for the Application specified
List<ApplicationInformation>	getApplications(String clusterName, HsxRequestContext hsxRequestContext, String language)
List<APPLICATION_ENABLED_STATUS>	getApplicationsEnabledStatus(HsxRequestContext hsxRequestContext, String ssoToken, String clusterName, String serverName, List<String> applicationNames)
byte[]	getApplicationSettingsData(HsxRequestContext hsxRequestContext, String clusterName, String ssoToken, String applicationName) extracts the application settings data for any given application name.
List<APPLICATION_TYPES>	getApplicationType(HsxRequestContext hsxRequestContext, String clusterName, String appName) Get the application type of an applicaiton on the server.
String	getAvailableServer(HsxRequestContext hsxRequestContext, String clusterName) This method selects a server.
List<String>	getClusters(HsxRequestContext hsxRequestContext) Return the list of Clusters for a user from HIT registry object.
Map<String,String>	getDSNDetails(HsxRequestContext hsxRequestContext, String clusterName, String ssoToken, String dsnName) extracts the DSN information for the given dsn name.
int	getHsxServerPort(String serverName)
static JHsxClient	getInstance() returns the singleton instance.
List<ModuleDetails>	getModuleConfig(HsxRequestContext hsxRequestContext, String clusterName, String applicationName) Get the modules that are disabled for the application
List<String>	getServersInCluster(HsxRequestContext hsxRequestContext, String clusterName) Return the list of Servers for a user in given Cluster from HIT registry object.
long	getSettingsLastUpdated(HsxRequestContext hsxRequestContext, String clusterName) Method to get the last updated date from xfm paramater table
String	getUserPreferenceValue(HsxRequestContext hsxRequestContext, String clusterName, String appName, USERPREFERENCES preference) Get the user preference for an application
int	importApplication(String clusterName, HsxRequestContext hsxRequestContext, String appName, String newAppName, String newAppDescription, boolean isImportTaskAudit, boolean isImportData, String projectName, boolean isHFMMode, String dbLinkName, String scenarioList, String yearList, String hfmDBName) copies the application.
int	importApplication(String clusterName, HsxRequestContext hsxRequestContext, String appName, String newAppName, String newAppDescription, boolean isImportTaskAudit, boolean isImportData, String projectName, boolean isHFMMode, String dbLinkName, String scenarioList, String yearList, String hfmDBName, boolean purgeSourceData) Imports an application from another database with purge source data option
void	killAdminTask(HsxRequestContext hsxRequestContext, String clusterName, String applicationName)
List<LogoutUserStatus>	logoutAllUsers(HsxRequestContext hsxRequestContext, String clusterName, String serverName, String applicationName, boolean forcedLogout)
List<LogoutUserStatus>	logoutUsers(HsxRequestContext hsxRequestContext, String clusterName, List<LogoutUserInfo> userInfoList, boolean forcedLogout)
int	modifyApplication(HsxRequestContext hsxRequestContext, String clusterName, String ssoToken, String applicationName, InputStream profileFileContents)
void	refreshCachedXfmParameter(HsxRequestContext hsxRequestContext, String clusterName, String appName) Sets the admin mode for the Application specified
void	registerApplication(HsxRequestContext hsxRequestContext, String clusterName, String appName, String appDescription, String projectName, String webServerURL) Register an applicaiton on the server
void	removeDeadAdminTasks(HsxRequestContext hsxRequestContext, String clusterName)
void	restartApplication(HsxRequestContext hsxRequestContext, String applicationName, String serverName, Locale locale, boolean force) Will shutdown the Datasource associated with the application.
int	restoreApplication(String clusterName, HsxRequestContext hsxRequestContext, String appName, String path, int rowCount, boolean isForceRestore) Restores the application.
void	setAdminMode(HsxRequestContext hsxRequestContext, String clusterName, String appName, boolean adminMode) Sets the admin mode for the Application specified
void	setApplicationMode(HsxRequestContext hsxRequestContext, String clusterName, String appName, APPLICATION_MODE appMode) Sets the application mode for the Application specified
boolean	setApplicationsEnabledStatus(HsxRequestContext hsxRequestContext, String ssoToken, String clusterName, List<String> serverNames, List<String> applicationNames, APPLICATION_ENABLED_STATUS status)
void	setModuleConfig(HsxRequestContext hsxRequestContext, String clusterName, String applicationName, List<ModuleDetails> moduleDetails) Set the modules that are disabled for the application
void	setUserPreferenceValues(HsxRequestContext hsxRequestContext, String clusterName, String appName, Map<USERPREFERENCES,String> preferences) Sets the user preferences
boolean	shutDownApplicationOnAllNodes(HsxRequestContext hsxRequestContext, String applicationName, String clusterName, String ssoToken, boolean isForceKill) Shuts down the application.
boolean	shutDownApplicationOnThisNode(HsxRequestContext hsxRequestContext, String applicationName, String serverName, String ssoToken, boolean isForceKill) Shuts down the application.
String	validateDSN(HsxRequestContext hsxRequestContext, String clusterName, String appName, String sslParam)
String	validateVBComponents(HsxRequestContext hsxRequestContext, String clusterName, String applicationName, String calcMgrXML)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static JHsxClient getInstance()
                              throws HFMException

returns the singleton instance. Registry realted functions will be initialized if the instance was created earlier.

Throws:

HFMException

getClusters

public List<String> getClusters(HsxRequestContext hsxRequestContext)
                         throws HFMException

Return the list of Clusters for a user from HIT registry object.

Returns:

List of cluster names

Throws:

HFMException

getServersInCluster

public List<String> getServersInCluster(HsxRequestContext hsxRequestContext,
                                        String clusterName)
                                 throws HFMException

Return the list of Servers for a user in given Cluster from HIT registry object.

Parameters:

clusterName - Name of cluster

Returns:

List of Server names

Throws:

HFMException

getHsxServerPort

public int getHsxServerPort(String serverName)

createSession

public SessionInfo createSession(HsxRequestContext hsxRequestContext,
                                 String clusterName,
                                 String appName)
                          throws HFMException

This opens the application specified and returns a valid sessionId for that application. Thia sessionId is required for futher communication to retrieve any kind of aplication raleted information.

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - a vaid Custer name

appName - Application which wil be opened

Returns:

Throws:

HFMException

createSession

public SessionInfo createSession(HsxRequestContext hsxRequestContext,
                                 String user,
                                 String password,
                                 String server,
                                 int port,
                                 String appName)
                          throws HFMException

This opens the application specified and returns a valid sessionId for that application. Thia sessionId is required for futher communication to retrieve any kind of aplication raleted information.

Parameters:

hsxRequestContext - HsxRequestContext Object

server - a vaid server name

appName - Application which wil be opened

Returns:

Throws:

HFMException

createSession

public SessionInfo createSession(HsxRequestContext hsxRequestContext,
                                 String server,
                                 int port,
                                 String appName)
                          throws HFMException

This opens the application specified and returns a valid sessionId for that application. Thia sessionId is required for futher communication to retrieve any kind of aplication raleted information.

Parameters:

hsxRequestContext - HsxRequestContext Object

server - a vaid server name

appName - Application which wil be opened

Returns:

Throws:

HFMException

getAvailableServer

public String getAvailableServer(HsxRequestContext hsxRequestContext,
                                 String clusterName)
                          throws HFMException

This method selects a server.

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - Name of cluster

Throws:

HFMException

createApplication

public void createApplication(HsxRequestContext hsxRequestContext,
                              String clusterName,
                              String appName,
                              String appDescription,
                              InputStream profileStream,
                              String projectName,
                              String webServerURL,
                              APPLICATION_TYPES appType)
                       throws HFMException

Creates an applicaiton on the server

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - the server or cluster to create the application on

appName - the name of the application to create

appDescription - the description of the application

profileStream - inputstream that contains the profile information

projectName - the profile the application will be created under

webServerURL - the HFM web server url

appType - type of the application

Throws:

HFMException - if an error occurs while creating the application

registerApplication

public void registerApplication(HsxRequestContext hsxRequestContext,
                                String clusterName,
                                String appName,
                                String appDescription,
                                String projectName,
                                String webServerURL)
                         throws HFMException

Register an applicaiton on the server

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - the server or cluster to create the application on

appName - the name of the application to create

appDescription - the description of the application

projectName - the profile the application will be created under

webServerURL - the HFM web server url

Throws:

HFMException - if an error occurs while creating the application

getApplicationType

public List<APPLICATION_TYPES> getApplicationType(HsxRequestContext hsxRequestContext,
                                                  String clusterName,
                                                  String appName)
                                           throws HFMException

Get the application type of an applicaiton on the server. It returns a list which might be confusing. But, thhis contains only one value Used as list for future purpose when we want to consider returning multiple types for an app or consider application types equivalant to features in which case an application can support multiple features/types

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - the server or cluster to create the application on

appName - the name of the application to create

Returns:

List of application type

Throws:

HFMException - if an error occurs while creating the application

deleteApplication

public void deleteApplication(HsxRequestContext hsxRequestContext,
                              String clusterName,
                              String appName)
                       throws HFMException

Deletes the application.

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - The cluser name to delete the application under

appName - The name of the application

Throws:

HFMException

setApplicationMode

public void setApplicationMode(HsxRequestContext hsxRequestContext,
                               String clusterName,
                               String appName,
                               APPLICATION_MODE appMode)
                        throws HFMException

Sets the application mode for the Application specified

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName -

appName -

appMode -

Throws:

HFMException

getApplicationMode

public APPLICATION_MODE getApplicationMode(HsxRequestContext hsxRequestContext,
                                           String clusterName,
                                           String appName)
                                    throws HFMException

Gets the application mode for the Application specified

Parameters:

clusterName -

appName -

Throws:

HFMException

getApplicationRulesMode

public APPLICATION_RULES_MODE getApplicationRulesMode(HsxRequestContext hsxRequestContext,
                                                      String clusterName,
                                                      String appName)
                                               throws HFMException

Gets the application rules mode for the Application specified

Parameters:

clusterName -

appName -

Throws:

HFMException

setAdminMode

public void setAdminMode(HsxRequestContext hsxRequestContext,
                         String clusterName,
                         String appName,
                         boolean adminMode)
                  throws HFMException

Sets the admin mode for the Application specified

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName -

appName -

adminMode -

Throws:

HFMException

importApplication

public int importApplication(String clusterName,
                             HsxRequestContext hsxRequestContext,
                             String appName,
                             String newAppName,
                             String newAppDescription,
                             boolean isImportTaskAudit,
                             boolean isImportData,
                             String projectName,
                             boolean isHFMMode,
                             String dbLinkName,
                             String scenarioList,
                             String yearList,
                             String hfmDBName)
                      throws HFMException

copies the application.

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - The cluser name to delete the application under

appName - The name of the application

Returns:

task id. The task rpogress can be tracked by using this further.

Throws:

HFMException

importApplication

public int importApplication(String clusterName,
                             HsxRequestContext hsxRequestContext,
                             String appName,
                             String newAppName,
                             String newAppDescription,
                             boolean isImportTaskAudit,
                             boolean isImportData,
                             String projectName,
                             boolean isHFMMode,
                             String dbLinkName,
                             String scenarioList,
                             String yearList,
                             String hfmDBName,
                             boolean purgeSourceData)
                      throws HFMException

Imports an application from another database with purge source data option

Parameters:

clusterName - The cluster name to register the application under

hsxRequestContext - HsxRequestContext Object

appName - Source application name

newAppName - Target application name

newAppDescription - Target application description

isImportTaskAudit - True if importing task audit table; otherwise false

isImportData - True if importing data; otherwise false

projectName - Project name to register the application under

isHFMMode - True if HFM application; false if EPMA application

dbLinkName - Database link to source application

scenarioList - Comma-delimited list of scenarios if filtering; blank if not filtering

yearList - Comma-delimited list of years if filtering; blank if not filtering

hfmDBName - Target database name

purgeSourceData - True if purging source data; otherwise falose

Returns:

Task ID

Throws:

HFMException

restoreApplication

public int restoreApplication(String clusterName,
                              HsxRequestContext hsxRequestContext,
                              String appName,
                              String path,
                              int rowCount,
                              boolean isForceRestore)
                       throws HFMException

Restores the application.

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - The cluser name to delete the application under

appName - The name of the application

Returns:

task id. The task rpogress can be tracked by using this further.

Throws:

HFMException

backupApplication

public int backupApplication(String clusterName,
                             HsxRequestContext hsxRequestContext,
                             String appName,
                             String path,
                             boolean isToBeScrambled,
                             double scramblingValue,
                             boolean isCopyTaskAudit,
                             boolean isCopyDataAudit,
                             int rowCount)
                      throws HFMException

Backup the application.

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - The cluser name to delete the application under

appName - The name of the application

Returns:

task id. The task rpogress can be tracked by using this further.

Throws:

HFMException

duplicateApplication

public int duplicateApplication(String clusterName,
                                HsxRequestContext hsxRequestContext,
                                String appName,
                                String newAppName,
                                String newAppDescription,
                                boolean isCopyTaskAudit,
                                boolean isCopyDataAudit,
                                String projectName,
                                boolean isHFMMode)
                         throws HFMException

Throws:

HFMException

getApplications

public List<ApplicationInformation> getApplications(String clusterName,
                                                    HsxRequestContext hsxRequestContext,
                                                    String language)
                                             throws HFMException

Throws:

HFMException

setModuleConfig

public void setModuleConfig(HsxRequestContext hsxRequestContext,
                            String clusterName,
                            String applicationName,
                            List<ModuleDetails> moduleDetails)
                     throws HFMException

Set the modules that are disabled for the application

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - cluster that will be responsible for connecting

applicationName - the application name of the application to be updated

moduleDetails - List of disabled modules

Throws:

HFMException

getModuleConfig

public List<ModuleDetails> getModuleConfig(HsxRequestContext hsxRequestContext,
                                           String clusterName,
                                           String applicationName)
                                    throws HFMException

Get the modules that are disabled for the application

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - cluster that will be responsible for connecting

applicationName - the application name of the application to be updated

Returns:

List of disabled modules

Throws:

HFMException

getAllUserPreferenceValues

public Map<USERPREFERENCES,String> getAllUserPreferenceValues(HsxRequestContext hsxRequestContext,
                                                              String clusterName,
                                                              String appName)
                                                       throws HFMException

Gets all the user perferences for an application.

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName -

appName -

Returns:

Throws:

HFMException

getUserPreferenceValue

public String getUserPreferenceValue(HsxRequestContext hsxRequestContext,
                                     String clusterName,
                                     String appName,
                                     USERPREFERENCES preference)
                              throws HFMException

Get the user preference for an application

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName - the server or cluster to create the application on

appName - the name of the application to create

Returns:

List of application type

Throws:

HFMException - if an error occurs while creating the application

setUserPreferenceValues

public void setUserPreferenceValues(HsxRequestContext hsxRequestContext,
                                    String clusterName,
                                    String appName,
                                    Map<USERPREFERENCES,String> preferences)
                             throws HFMException

Sets the user preferences

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName -

appName -

preferences -

Throws:

HFMException

getApplicationLanguages

public List<String> getApplicationLanguages(HsxRequestContext hsxRequestContext,
                                            String clusterName,
                                            String applicationName)
                                     throws HFMException

returns the applciation lanugages

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName -

applicationName -

Returns:

Throws:

HFMException

getAdminTaskProgress

public AdminTaskProgress getAdminTaskProgress(HsxRequestContext hsxRequestContext,
                                              String clusterName,
                                              int taskID)
                                       throws HFMException

Throws:

HFMException

getAdminTaskLogData

public byte[] getAdminTaskLogData(HsxRequestContext hsxRequestContext,
                                  String clusterName,
                                  int taskID)
                           throws HFMException

Returns the log information of the current admin task id as a string

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName -

taskID -

Returns:

String

Throws:

HFMException

removeDeadAdminTasks

public void removeDeadAdminTasks(HsxRequestContext hsxRequestContext,
                                 String clusterName)
                          throws HFMException

Throws:

HFMException

killAdminTask

public void killAdminTask(HsxRequestContext hsxRequestContext,
                          String clusterName,
                          String applicationName)
                   throws HFMException

Throws:

HFMException

logoutUsers

public List<LogoutUserStatus> logoutUsers(HsxRequestContext hsxRequestContext,
                                          String clusterName,
                                          List<LogoutUserInfo> userInfoList,
                                          boolean forcedLogout)
                                   throws HFMException

Throws:

HFMException

logoutAllUsers

public List<LogoutUserStatus> logoutAllUsers(HsxRequestContext hsxRequestContext,
                                             String clusterName,
                                             String serverName,
                                             String applicationName,
                                             boolean forcedLogout)
                                      throws HFMException

Throws:

HFMException

convertXMLToVBScript

public String convertXMLToVBScript(HsxRequestContext hsxRequestContext,
                                   String clusterName,
                                   String applicationName,
                                   String calcMgrXML)
                            throws HFMException

Throws:

HFMException

convertVBScriptToXML

public String convertVBScriptToXML(HsxRequestContext hsxRequestContext,
                                   String clusterName,
                                   String applicationName,
                                   String vbScript)
                            throws HFMException

Throws:

HFMException

validateDSN

public String validateDSN(HsxRequestContext hsxRequestContext,
                          String clusterName,
                          String appName,
                          String sslParam)
                   throws HFMException

Throws:

HFMException

validateVBComponents

public String validateVBComponents(HsxRequestContext hsxRequestContext,
                                   String clusterName,
                                   String applicationName,
                                   String calcMgrXML)
                            throws HFMException

Throws:

HFMException

convertVBScriptToPureXML

public String convertVBScriptToPureXML(HsxRequestContext hsxRequestContext,
                                       String clusterName,
                                       String applicationName,
                                       String vbScript,
                                       boolean compLevelCondition,
                                       int compSplitOption,
                                       String dimensionMapping)
                                throws HFMException

Throws:

HFMException

convertVBScriptToXMLOnFly

public String convertVBScriptToXMLOnFly(HsxRequestContext hsxRequestContext,
                                        String clusterName,
                                        String applicationName,
                                        String vbScript,
                                        boolean compLevelCondition,
                                        int compSplitOption,
                                        String calcType)
                                 throws HFMException

Throws:

HFMException

getAllSettings

public Map<String,String> getAllSettings(HsxRequestContext hsxRequestContext,
                                         String clusterName,
                                         String serverName,
                                         String applicationName)
                                  throws HFMException

Method to get the all setting value from xfm paramater table

Parameters:

hsxRequestContext -

clusterName - name of the cluster

serverName - name of the server or null for All servers

applicationName - name of the applicaton or null for All servers

Returns:

setting value

Throws:

HFMException

getApplicationProfileData

public byte[] getApplicationProfileData(HsxRequestContext hsxRequestContext,
                                        String clusterName,
                                        String ssoToken,
                                        String applicationName)
                                 throws HFMException

extracts the application profile data for any given application name.

Parameters:

hsxRequestContext -

clusterName -

ssoToken -

applicationName -

Returns:

byte[]

Throws:

HFMException

getDSNDetails

public Map<String,String> getDSNDetails(HsxRequestContext hsxRequestContext,
                                        String clusterName,
                                        String ssoToken,
                                        String dsnName)
                                 throws HFMException

extracts the DSN information for the given dsn name.

Parameters:

hsxRequestContext -

clusterName -

ssoToken -

dsnName -

Returns:

Map<String, String>

Throws:

HFMException

getSettingsLastUpdated

public long getSettingsLastUpdated(HsxRequestContext hsxRequestContext,
                                   String clusterName)
                            throws HFMException

Method to get the last updated date from xfm paramater table

Parameters:

hsxRequestContext -

clusterName -

Returns:

setting value

Throws:

HFMException

shutDownApplicationOnAllNodes

public boolean shutDownApplicationOnAllNodes(HsxRequestContext hsxRequestContext,
                                             String applicationName,
                                             String clusterName,
                                             String ssoToken,
                                             boolean isForceKill)
                                      throws HFMException

Shuts down the application. first it shutdowsn the data source on the connected server and propagates the requests to do shutdown in the all the jhsxserver instances.

Parameters:

hsxRequestContext -

clusterName -

ssoToken -

applicationName -

isForceKill -

Returns:

boolean

Throws:

HFMException

shutDownApplicationOnThisNode

public boolean shutDownApplicationOnThisNode(HsxRequestContext hsxRequestContext,
                                             String applicationName,
                                             String serverName,
                                             String ssoToken,
                                             boolean isForceKill)
                                      throws HFMException

Shuts down the application. first it shutdowsn the data source on the connected server and propagates the requests to do shutdown in the all the jhsxserver instances.

Parameters:

hsxRequestContext -

serverName -

ssoToken -

applicationName -

isForceKill -

Returns:

boolean

Throws:

HFMException

modifyApplication

public int modifyApplication(HsxRequestContext hsxRequestContext,
                             String clusterName,
                             String ssoToken,
                             String applicationName,
                             InputStream profileFileContents)
                      throws HFMException

Parameters:

hsxRequestContext -

clusterName -

ssoToken -

applicationName -

profileFileContents -

Returns:

adminTaskId

Throws:

HFMException

setApplicationsEnabledStatus

public boolean setApplicationsEnabledStatus(HsxRequestContext hsxRequestContext,
                                            String ssoToken,
                                            String clusterName,
                                            List<String> serverNames,
                                            List<String> applicationNames,
                                            APPLICATION_ENABLED_STATUS status)
                                     throws HFMException

Throws:

HFMException

getApplicationsEnabledStatus

public List<APPLICATION_ENABLED_STATUS> getApplicationsEnabledStatus(HsxRequestContext hsxRequestContext,
                                                                     String ssoToken,
                                                                     String clusterName,
                                                                     String serverName,
                                                                     List<String> applicationNames)
                                                              throws HFMException

Throws:

HFMException

getApplicationEnabledStatus

public APPLICATION_ENABLED_STATUS getApplicationEnabledStatus(HsxRequestContext hsxRequestContext,
                                                              String ssoToken,
                                                              String clusterName,
                                                              String serverName,
                                                              String applicationName)
                                                       throws HFMException

Throws:

HFMException

restartApplication

public void restartApplication(HsxRequestContext hsxRequestContext,
                               String applicationName,
                               String serverName,
                               Locale locale,
                               boolean force)
                        throws HFMException

Will shutdown the Datasource associated with the application. Afterwards it will bring the application back up.

Parameters:

hsxRequestContext - contains ssoToken for validation.

applicationName - name of application cannot be null or empty.

locale - locale to createSession.

force - force shutdown of datasource regardless of whether there are running tasks (Currently not used).

Throws:

HFMException - if parameters are invalid errorCode=INVALID_PARAMETERS. if the user does not have admin rights errorCode=USER_NOT_PROVISIONED_FOR_SYS_ADMIN. if an unknown exception occurs errorCode=ERROR_RESTARING_APPLICATION.

refreshCachedXfmParameter

public void refreshCachedXfmParameter(HsxRequestContext hsxRequestContext,
                                      String clusterName,
                                      String appName)
                               throws HFMException

Sets the admin mode for the Application specified

Parameters:

hsxRequestContext - HsxRequestContext Object

clusterName -

appName -

Throws:

HFMException

getApplicationSettingsData

public byte[] getApplicationSettingsData(HsxRequestContext hsxRequestContext,
                                         String clusterName,
                                         String ssoToken,
                                         String applicationName)
                                  throws HFMException

extracts the application settings data for any given application name.

Parameters:

hsxRequestContext -

clusterName -

ssoToken -

applicationName -

Returns:

byte[]

Throws:

HFMException