oracle.epm.fm.domainobject.application

Class SessionOM

java.lang.Object

oracle.epm.fm.domainobject.application.SessionOM

public class SessionOM
extends Object

The SessionOM is responsible for the application creation, registration, deleting the application, closing the application.
This OM class mainly deals with administrative actions related to an application.

 
 Here is the sample code to open an application.

   Map context = new HashMap(5);
   CSSSystem system = CSSSystem.getInstance(context, "C:\Oracle\Middleware\EPMSystem11R1");
   CSSAPIIF css = system.getCSSAPI();
   CSSUserIF user = css.authenticate(context, "admin", "password");
   String ssoToken = user.getToken();
   SessionInfo session = sessionOM.createSession(ssoToken, Locale.ENGLISH, "Cluster_name", "Application_name");

 Every open application call should have a corresponding close application.

   sessionOM.closeSession(session);

 
 

Constructor Summary

Constructors

Constructor and Description
SessionOM() Creates the Session OM object.

Method Summary

Modifier and Type	Method and Description
int	backupApplication(String clusterName, String ssoToken, String appName, String path, boolean isToBeScrambled, double scramblingValue, boolean isCopyTaskAudit, boolean isCopyDataAudit, int rowCount) Creates the backup for the given application name.
void	closeSession(SessionInfo sessionInfo) closes the application, takes the session info object of the application has to be closed.
void	createApplication(String ssoToken, String clusterName, String appName, String appDescription, InputStream profileStream, String projectName, String webServerURL, APPLICATION_TYPES appType) Creates an applicaiton on the server.
SessionInfo	createSession(String ssoToken, Locale locale, String server, int port, String appName) This opens the application specified and returns a valid sessionId for that application.
SessionInfo	createSession(String ssoToken, Locale locale, String clusterName, String appName) This opens the application specified and returns a valid sessionId for that application.
SessionInfo	createSession(String user, String password, Locale locale, String server, int port, String appName) This opens the application specified and returns a valid sessionId for that application.
void	deleteApplication(String ssoToken, String clusterName, String applicationName) Deletes the application.
int	duplicateApplication(String clusterName, String ssoToken, String appName, String newAppName, String newAppDescription, boolean isCopyTaskAudit, boolean isCopyDataAudit, String projectName, boolean isHFMMode) Duplicates the source application to given new application name.
List<String>	enumCluster() Return the list of Clusters for a user, the cluster information would be avilable in the cluster list with update more than 2 mins ago.
List<String>	enumProvisioningProjects(String ssoToken) Return the list of provisioning projects.
List<String>	enumServers(String cluster) Return the list of Servers for a user in given Cluster. It calls enumServers() method of JHsxClient class if, server list was update more than 2 mins ago.
byte[]	getAdminTaskLogData(String ssoToken, String clusterName, int taskID) Returns the log file path information of the specified admin task id.
AdminTaskProgress	getAdminTaskProgress(String clusterName, String ssoToken, int taskID) the synchornised method to get the status of the admin task progress.
AdminTaskProgress	getAdminTaskProgress(String clusterName, String ssoToken, int taskID, long poolingTime) returns the status of the Admin task prgress.
Map<USERPREFERENCES,String>	getAllUserPreferenceValues(String ssoToken, String clusterName, String appName) Gets all the user preferences.
APPLICATION_ENABLED_STATUS	getApplicationEnabledStatus(String ssoToken, String clusterName, String serverName, String applicationName) Returns the application mode status as enabled or disabled for the list of application name.
List<String>	getApplicationLanguages(String ssoToken, String clusterName, String applicationName) Returns the list of languages supported for the given application.
APPLICATION_MODE	getApplicationMode(String ssoToken, String clusterName, String appName) Gets the application mode for the Application specified.
byte[]	getApplicationProfileData(String ssoToken, String clusterName, String applicationName) Extracts the profile data for the given application name.
APPLICATION_RULES_MODE	getApplicationRulesMode(String ssoToken, String clusterName, String appName) Gets the application rules mode for the Application specified.
List<ApplicationInformation>	getApplications(String clusterName, String ssoToken, String language) Return the List of applications in the form the ApplicationInformation object.. the application list would be provisioned for this user. identifies with the Sso Token.
List<APPLICATION_ENABLED_STATUS>	getApplicationsEnabledStatus(String ssoToken, String clusterName, String serverName, List<String> applicationNames) Returns the list of application mode status as enabled or disabled for the list of application names.
byte[]	getApplicationSettingsData(String ssoToken, String clusterName, String applicationName) Extracts the app settings data for the given application name.
List<APPLICATION_TYPES>	getApplicationType(String ssoToken, String serverName, String applicationName) Return the application type enum.
String	getAvailableCluster(String ssoToken) Return the list of Clusters for a user, It calls enumClusters() method of JHsxClient class if, cluster list was update more than 2 mins ago.
String	getAvailableServer(String ssoToken) Returns the available server .
String	getAvailableServer(String ssoToken, String clusterName) Returns the available server in the given cluster.
Map<String,String>	getDSNDetails(String clusterName, String ssoToken, String dsnName) Extracts the DSN information as a map for the given dsn name.
int	getHsxServerPort(String serverName) Returns the get HsxServer port of the given server.
List<ModuleDetails>	getModuleConfig(String ssoToken, String clusterName, String applicationName) Get the modules that are disabled for the application.
String	getUserPreferenceValue(String ssoToken, String clusterName, String appName, USERPREFERENCES preference) Gets the user preferences.
int	importApplication(String clusterName, String ssoToken, String appName, String newAppName, String newAppDescription, boolean isImportTaskAudit, boolean isImportData, String projectName, boolean isHFMMode, String dbLinkName, String scenarioList, String yearList, String hfmDBName)
int	importApplication(String clusterName, String ssoToken, String appName, String newAppName, String newAppDescription, boolean isImportTaskAudit, boolean isImportData, String projectName, boolean isHFMMode, String dbLinkName, String scenarioList, String yearList, String hfmDBName, boolean purgeSourceData)
void	killAdminTask(String ssoToken, String internalKey, String clusterName, String applicationName) Kills the admin task (that is running) specified.
List<LogoutUserStatus>	logoutAllUsers(String ssoToken, String clusterName, String serverName, String applicationName, boolean forcedLogout) Logouts the all the users from the environment.
List<LogoutUserStatus>	logoutUsers(String ssoToken, String clusterName, List<LogoutUserInfo> userInfoList, boolean forcedLogout) Logouts the list of users given.
int	modifyApplication(String clusterName, String ssoToken, String applicationName, InputStream profileFileContents) Modifies the application , with the profile content given.
List<String>	provisionedAppsForUser(String ssoToken) This mthod return the list of Application names provisioned for a user.
void	refreshCachedXfmParameter(String clusterName, String ssoToken, String appName)
void	registerApplication(String ssoToken, String clusterName, String appName, String appDescription, String projectName, String webServerURL) Creates an applicaiton on the server.
void	removeDeadAdminTasks(String ssoToken, String internalKey, String clusterName) Removes all the Admin tasks that are not running currently.
void	restartApplication(String serverName, String applicationName, String ssoToken, Locale locale, boolean force) Will shutdown the Datasource associated with the application.
int	restoreApplication(String clusterName, String ssoToken, String appName, String path, int rowCount, boolean isForceRestore) Restores the application from the backup file .
void	setAdminMode(String ssoToken, String clusterName, String appName, boolean adminMode) Enables/Disables the admin mode for the Application specified.
void	setAllUserPreferenceValues(String ssoToken, String clusterName, String appName, Map<USERPREFERENCES,String> preferences) Sets the user preference for the given application name.
void	setApplicationMode(String ssoToken, String clusterName, String appName, APPLICATION_MODE appMode) Sets the application mode for the Application specified.
boolean	setApplicationsEnabledStatus(String ssoToken, String clusterName, List<String> serverName, List<String> applicationName, APPLICATION_ENABLED_STATUS status) Sets the application enabled / disabled mode.
void	setModuleConfig(String ssoToken, String clusterName, String applicationName, List<ModuleDetails> moduleDetailsList) Set the modules that are disabled for the application.
boolean	shutDownApplication(String applicationName, String ssoToken, boolean isForceKill) Shuts down the application on all the Jhsxserver instances across all the clusters and servers.
boolean	shutDownApplication(String serverName, String applicationName, String ssoToken, boolean isForceKill) Shuts down the application on the mentioned server name.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionOM

public SessionOM()
          throws HFMException

Creates the Session OM object.

Throws:

HFMException - - throws HFMException.

Method Detail

enumCluster

public List<String> enumCluster()
                         throws HFMException

Return the list of Clusters for a user, the cluster information would be avilable in the cluster list with update more than 2 mins ago.

Returns:

List Of Strings

Throws:

HFMException - - throws HFMException. usage : List of Strings = SessionOM.enumClusters();

getAvailableCluster

public String getAvailableCluster(String ssoToken)
                           throws HFMException

Return the list of Clusters for a user, It calls enumClusters() method of JHsxClient class if, cluster list was update more than 2 mins ago.

Parameters:

ssoToken - - the sso token.

Returns:

List of Cluster names

Throws:

HFMException

enumServers

public List<String> enumServers(String cluster)
                         throws HFMException

Return the list of Servers for a user in given Cluster.
It calls enumServers() method of JHsxClient class if, server list was update more than 2 mins ago.

Parameters:

cluster - - the cluster name.

Returns:

List of Server names

Throws:

HFMException

getApplicationType

public List<APPLICATION_TYPES> getApplicationType(String ssoToken,
                                                  String serverName,
                                                  String applicationName)
                                           throws HFMException

Return the application type enum.

Parameters:

ssoToken - -the ssoToken

serverName - - Name of the server.

applicationName - - the application name.

Returns:

List of APPLICATION_TYPES

Throws:

HFMException - - throws HFM exception.

getApplications

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

Return the List of applications in the form the ApplicationInformation object..
the application list would be provisioned for this user.
identifies with the Sso Token.

Parameters:

clusterName - - Name of the server

ssoToken - ssoToken.

language - - the language .

Returns:

List of APPLICATION_TYPES

Throws:

HFMException - - throws HFM Exception.

enumProvisioningProjects

public List<String> enumProvisioningProjects(String ssoToken)
                                      throws HFMException

Return the list of provisioning projects.

Parameters:

ssoToken - ssoToken

Returns:

List of provisioning projects

Throws:

HFMException

provisionedAppsForUser

public List<String> provisionedAppsForUser(String ssoToken)
                                    throws HFMException

This mthod return the list of Application names provisioned for a user. It authenticates the user based on the ssoToken and then fetch the provisioned app names from getUserProvisionedApps() method of Security class.

Parameters:

ssoToken - - the sso token.

Returns:

List of Application names

Throws:

HFMException

createSession

public SessionInfo createSession(String ssoToken,
                                 Locale locale,
                                 String clusterName,
                                 String appName)
                          throws HFMException

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

Parameters:

ssoToken - a valid ssoToken

locale - object.

clusterName - a vaid Custer name

appName - Application which wil be opened

Returns:

SessionInfo - returns the session Info object.

Throws:

HFMException - - throws HFM Exception.

createSession

public SessionInfo createSession(String user,
                                 String password,
                                 Locale locale,
                                 String server,
                                 int port,
                                 String appName)
                          throws HFMException

This opens the application specified and returns a valid sessionId for that application. This sessionId is required for futher communication to retrieve any kind of aplication related information. Connection will be attempted directly on the server and port specified.

Parameters:

user - a valid user name

password - password for user

locale - object.

server - a vaid server name

appName - Application which wil be opened

Returns:

SessionInfo - returns the session Info object.

Throws:

HFMException - - throws HFM Exception.

createSession

public SessionInfo createSession(String ssoToken,
                                 Locale locale,
                                 String server,
                                 int port,
                                 String appName)
                          throws HFMException

This opens the application specified and returns a valid sessionId for that application. This sessionId is required for futher communication to retrieve any kind of aplication related information. Connection will be attempted directly on the server and port specified.

Parameters:

ssoToken -

locale - object.

server - a vaid server name

appName - Application which wil be opened

Returns:

SessionInfo - returns the session Info object.

Throws:

HFMException - - throws HFM Exception.

createApplication

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

Creates an applicaiton on the server.

Parameters:

ssoToken - - web session, not application session id for current user

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(String ssoToken,
                                String clusterName,
                                String appName,
                                String appDescription,
                                String projectName,
                                String webServerURL)
                         throws HFMException

Creates an applicaiton on the server.

Parameters:

ssoToken - - web session, not application session id for current user

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

deleteApplication

public void deleteApplication(String ssoToken,
                              String clusterName,
                              String applicationName)
                       throws HFMException

Deletes the application.

Parameters:

ssoToken - The unique token for the logged in user

clusterName - The cluser name to delete the application under

applicationName - The name of the application

Throws:

HFMException

setApplicationMode

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

Sets the application mode for the Application specified.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

appName - - the application name.

appMode - - the application mode.

Throws:

HFMException - - throws HFMException.

getApplicationMode

public APPLICATION_MODE getApplicationMode(String ssoToken,
                                           String clusterName,
                                           String appName)
                                    throws HFMException

Gets the application mode for the Application specified.

Parameters:

ssoToken - - the sso Token.

clusterName - - the cluster name.

appName - - the application name.

Returns:

APPLICATION_MODE.

Throws:

HFMException - - throws HFMException.

getApplicationRulesMode

public APPLICATION_RULES_MODE getApplicationRulesMode(String ssoToken,
                                                      String clusterName,
                                                      String appName)
                                               throws HFMException

Gets the application rules mode for the Application specified.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

appName - - the application name.

Returns:

APPLICATION_RULES_MODE

Throws:

HFMException - - throws HFMException.

setAdminMode

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

Enables/Disables the admin mode for the Application specified.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

appName - - the application name.

adminMode - - the admin mode flag.

Throws:

HFMException - - throws HFMException.

getAllUserPreferenceValues

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

Gets all the user preferences.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

appName - - the application name.

Returns:

map of USERPREFERENCES to string - returns the map of USERPREFERENCES to string.

Throws:

HFMException - - throws HFMException.

getUserPreferenceValue

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

Gets the user preferences.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

appName - - the application name.

preference - - the user preferences.

Returns:

String.

Throws:

HFMException - - throws HFMException.

setAllUserPreferenceValues

public void setAllUserPreferenceValues(String ssoToken,
                                       String clusterName,
                                       String appName,
                                       Map<USERPREFERENCES,String> preferences)
                                throws HFMException

Sets the user preference for the given application name.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

appName - - the app name.

preferences - - the map of USERPREFERENCES

Throws:

HFMException - - throws HFMException.

getApplicationLanguages

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

Returns the list of languages supported for the given application.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

applicationName - - the application name.

Returns:

List of String.- the list of string.

Throws:

HFMException - - throw HFMException.

duplicateApplication

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

Duplicates the source application to given new application name. creates new application and copies all the tables from the souce application to target application.

Parameters:

clusterName - - the cluster name,

ssoToken - - the sso token.

appName - - the application name.

newAppName - - the new application name.

newAppDescription - - the new application description.

isCopyTaskAudit - - is copy task audit table is enabled.

isCopyDataAudit - - is copy data audit table is enabled/

Returns:

int - the status of the duplicate

Throws:

HFMException - - throws HFMException.

importApplication

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

Throws:

HFMException

importApplication

public int importApplication(String clusterName,
                             String ssoToken,
                             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

Throws:

HFMException

refreshCachedXfmParameter

public void refreshCachedXfmParameter(String clusterName,
                                      String ssoToken,
                                      String appName)
                               throws HFMException

Throws:

HFMException

backupApplication

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

Creates the backup for the given application name. queries all the tables for the application, compresses and creates backup file.

Parameters:

clusterName - - the cluster name.

ssoToken - - the sso token.

appName - - the application name.

path - - the absolute path where the backup file should be placed.

isToBeScrambled - - is the data tables has to be scrambled.

scramblingValue - - the scrambling value for the data files.

isCopyTaskAudit - - is copy task audit table is enabled.

isCopyDataAudit - - is copy data audit table is enabled.

rowCount - - the table query row count fetch.

Returns:

returns the status of the back up task.

Throws:

HFMException - - throws HFMException.

restoreApplication

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

Restores the application from the backup file . decompresses the backup file, creates application and loads all the application table and data.

Parameters:

clusterName - - the cluster name.

ssoToken - - the sso token.

appName - - the application name.

path - - the absolute path for the backup file.

rowCount - - the row count for table fetch size.

isForceRestore - - is force restore is enabled.

Returns:

returns the status of the task.

Throws:

HFMException - - throws HFMexception.

getAdminTaskProgress

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

the synchornised method to get the status of the admin task progress.

Parameters:

clusterName - - the cluster name.

ssoToken - - the cluster name.

taskID - - the admin task id.

Returns:

AdminTaskProgress - the progress status of the admin task.

Throws:

HFMException - - throws HFMException.

getAdminTaskProgress

public AdminTaskProgress getAdminTaskProgress(String clusterName,
                                              String ssoToken,
                                              int taskID,
                                              long poolingTime)
                                       throws HFMException,
                                              InterruptedException

returns the status of the Admin task prgress. pools the status on the specified intervels and returns the status.

Parameters:

clusterName - - the clustername.

ssoToken - - the sso token.

taskID - - the task id.

poolingTime - - the configurable pooling time.

Returns:

the admin task progress.

Throws:

HFMException

InterruptedException

getAdminTaskLogData

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

Returns the log file path information of the specified admin task id.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

taskID - - the admin task id.

Returns:

String - returns the absolute path for the admin task log file.

Throws:

HFMException - - throws HFMException.

removeDeadAdminTasks

public void removeDeadAdminTasks(String ssoToken,
                                 String internalKey,
                                 String clusterName)
                          throws HFMException

Removes all the Admin tasks that are not running currently. NOTE:This method must be used for internal purpose only.

Parameters:

ssoToken - valid sso token for authentication

internalKey - Internal code for validation

clusterName - valid cluster name

Throws:

HFMException

getApplicationProfileData

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

Extracts the profile data for the given application name.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

applicationName - - the application name.

Returns:

profile data in byte array format.

Throws:

HFMException - - throws HFMException.

killAdminTask

public void killAdminTask(String ssoToken,
                          String internalKey,
                          String clusterName,
                          String applicationName)
                   throws HFMException

Kills the admin task (that is running) specified. Updates the DB as well. NOTE:This method must be used for internal purpose only.

Parameters:

ssoToken - valid sso token for authentication

internalKey - Internal code for validation

clusterName - valid cluster name

applicationName - Application Name

Throws:

HFMException

getAvailableServer

public String getAvailableServer(String ssoToken,
                                 String clusterName)
                          throws HFMException

Returns the available server in the given cluster.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

Returns:

avilable server.

Throws:

HFMException - - throws HFMException.

getAvailableServer

public String getAvailableServer(String ssoToken)
                          throws HFMException

Returns the available server . internally picks the cluster name in sequential order and returns the server for the cluster.

Parameters:

ssoToken - - the sso token.

Returns:

avilable server.

Throws:

HFMException - - throws HFMException.

getHsxServerPort

public int getHsxServerPort(String serverName)
                     throws HFMException

Returns the get HsxServer port of the given server.

Parameters:

serverName - - the server name.

Returns:

port information.

Throws:

HFMException - - throws HFMException.

logoutUsers

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

Logouts the list of users given.

Parameters:

ssoToken - - the sso token.

clusterName - - the clustername.

userInfoList - - the list of user information list.

forcedLogout - - is forced log out is enabled.

Returns:

List Logout user status.

Throws:

HFMException - - throws HFMException.

logoutAllUsers

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

Logouts the all the users from the environment.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

serverName - - the server name,

applicationName - - the application name.

forcedLogout - - is forced logout.

Returns:

List of Logout users.

Throws:

HFMException - - throws HFMException.

getModuleConfig

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

Get the modules that are disabled for the application.

Parameters:

ssoToken - sso token

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 - - throws HFMException.

closeSession

public void closeSession(SessionInfo sessionInfo)
                  throws HFMException

closes the application, takes the session info object of the application has to be closed.

Parameters:

sessionInfo - - the session info information.

Throws:

HFMException - -throws HFMException.

setModuleConfig

public void setModuleConfig(String ssoToken,
                            String clusterName,
                            String applicationName,
                            List<ModuleDetails> moduleDetailsList)
                     throws HFMException

Set the modules that are disabled for the application.

Parameters:

ssoToken - sso token.

clusterName - cluster that will be responsible for connecting.

applicationName - the application name of the application to be updated.

moduleDetailsList - List of disabled modules.

Throws:

HFMException - - throws HFMException.

getDSNDetails

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

Extracts the DSN information as a map for the given dsn name.

Parameters:

ssoToken - sso token.

clusterName - cluster that will be responsible for connecting.

dsnName - - the dsn name.

Throws:

HFMException - - throws HFMException.

shutDownApplication

public boolean shutDownApplication(String applicationName,
                                   String ssoToken,
                                   boolean isForceKill)
                            throws HFMException

Shuts down the application on all the Jhsxserver instances across all the clusters and servers.

Parameters:

ssoToken -

applicationName -

isForceKill -

Returns:

boolean

Throws:

HFMException

shutDownApplication

public boolean shutDownApplication(String serverName,
                                   String applicationName,
                                   String ssoToken,
                                   boolean isForceKill)
                            throws HFMException

Shuts down the application on the mentioned server name. if the data source is not avilable on the mentioned server or the server is not avilable the exception would be thrown.

Parameters:

serverName -

applicationName -

ssoToken -

isForceKill -

Returns:

boolean

Throws:

HFMException

modifyApplication

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

Modifies the application , with the profile content given. enable admin mode before calling this API.

Parameters:

clusterName -

ssoToken -

applicationName -

profileFileContents -

Returns:

int

Throws:

HFMException

setApplicationsEnabledStatus

public boolean setApplicationsEnabledStatus(String ssoToken,
                                            String clusterName,
                                            List<String> serverName,
                                            List<String> applicationName,
                                            APPLICATION_ENABLED_STATUS status)
                                     throws HFMException

Sets the application enabled / disabled mode.

Parameters:

ssoToken -

clusterName -

serverName -

applicationName -

status -

Returns:

boolean

Throws:

HFMException

getApplicationsEnabledStatus

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

Returns the list of application mode status as enabled or disabled for the list of application names.

Parameters:

ssoToken -

clusterName -

serverName -

applicationNames -

Returns:

Throws:

HFMException

getApplicationEnabledStatus

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

Returns the application mode status as enabled or disabled for the list of application name.

Parameters:

ssoToken -

clusterName -

serverName -

applicationName -

Returns:

Throws:

HFMException

restartApplication

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

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

Parameters:

ssoToken - credentials.

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.

getApplicationSettingsData

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

Extracts the app settings data for the given application name.

Parameters:

ssoToken - - the sso token.

clusterName - - the cluster name.

applicationName - - the application name.

Returns:

profile data in byte array format.

Throws:

HFMException - - throws HFMException.