com.bmc.arsys.util

Class CentralConfig

java.lang.Object

com.bmc.arsys.util.CentralConfig

public class CentralConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	AR_SYSTEM_CONFIGURATION_COMPONENT_SETTING_FORM

Constructor Summary

Constructors

Constructor and Description
CentralConfig()

Method Summary

Modifier and Type	Method and Description
static void	changeComponentStatus(ARServerUser context, String componentGUID, boolean status) This method will set the component to Active if status is true, else set it to Inactive
static String	createComponentEntry(ARServerUser context, String componentName, String componentType, String componentDescription, boolean status) The function creates a new configuration component entry and returns the GUID for that entry.
static int	createSettingEntries(ARServerUser context, String componentGUID, String componentName, String componentType, List<String[]> nameValuePair) The function creates a new setting entry on "AR System Configuration Component Setting" form.
static boolean	deleteSetting(ARServerUser context, String componentName, String componentType, String settingName, String settingValue) Delete settings entries that have a specific name and value.
static Entry	getActiveComponent(ARServerUser context, String componentName, String componentType) Get the active component entry for a given component name and type.
static String	getComponentGUIDFromEntry(Entry thisEntry)
static List<Entry>	getComponentWithPrefix(ARServerUser context, String componentNamePrefix, String componentType) This method will return the component GUIDs that are active, with the given component type and prefixed with the componentNamePrefix
static List<String[]>	getConfigSettingsAsList(ARServerUser context, String configName, String configType, String settingName)
static Map<String,List<String>>	getConfigSettingsAsMap(ARServerUser context, String configName, String configType, String settingName) This method will return a HashMap of setting name vs list of setting values associated with that setting name.
static List<Entry>	getConfigSettingsWithEntryIDs(ARServerUser context, String configName, String configType, String settingName)
static List<Entry>	getConfigSettingsWithEntryIDs(ARServerUser context, String configName, String configType, String settingName, int relationOPForCompName)
static String	getEntryValue(Entry thisEntry)
static void	setSettingEntries(ARServerUser context, String entryID, String componentGUID, String componentName, String componentType, String settingName, String settingValue) The function creates a new setting entry on "AR System Configuration Component Setting" form.
static void	updateComponent(ARServerUser context, String componentGUID, String componentName, String componentType, String componentDescription, boolean status) This method can be used to update component values like name, type and description provided these fields are not null Status will always be updated This method will not update the GUID
static void	updateConfigSetting(ARServerUser context, String settingEntryID, String settingName, String settingValue)
static void	updateOlderComponents(ARServerUser context, String componentNamePrefix, String componentType, String description, boolean status) Use this method to deactivate older Active components.
static void	updateOrCreateSetting(ARServerUser context, String componentGUID, String componentName, String componentType, String settingName, String settingValue) Only use this method if setting name is unique, will not work for duplicates as it will only update the first one

Methods inherited from class java.lang.Object

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

Field Detail

AR_SYSTEM_CONFIGURATION_COMPONENT_SETTING_FORM

public static final String AR_SYSTEM_CONFIGURATION_COMPONENT_SETTING_FORM

See Also:

Constant Field Values

Constructor Detail

CentralConfig

public CentralConfig()

Method Detail

createComponentEntry

public static String createComponentEntry(ARServerUser context,
                                          String componentName,
                                          String componentType,
                                          String componentDescription,
                                          boolean status)
                                   throws ARException

The function creates a new configuration component entry and returns the GUID for that entry.

Parameters:

context - : ARServerUser context

componentName - : Name of the component to be created

componentType - : Type of component com.bmc.arsys*

status - : true : Creates the new component in active state false: creates the new component in inactive state.

Returns:

: GUID of the newly created component.

Throws:

ARException

updateOlderComponents

public static void updateOlderComponents(ARServerUser context,
                                         String componentNamePrefix,
                                         String componentType,
                                         String description,
                                         boolean status)
                                  throws ARException

Use this method to deactivate older Active components. The method will take the component Name as prefix while getting the entries to deactivate. Ensure that you are activating your component AFTER this method is called.

Parameters:

context -

componentNamePrefix -

componentType -

description -

status -

Throws:

ARException

getComponentWithPrefix

public static List<Entry> getComponentWithPrefix(ARServerUser context,
                                                 String componentNamePrefix,
                                                 String componentType)
                                          throws ARException

This method will return the component GUIDs that are active, with the given component type and prefixed with the componentNamePrefix

Parameters:

context -

componentNamePrefix -

componentType -

Returns:

Throws:

ARException

getActiveComponent

public static Entry getActiveComponent(ARServerUser context,
                                       String componentName,
                                       String componentType)
                                throws ARException

Get the active component entry for a given component name and type. If there is not an active entry, this will return null.

Parameters:

context -

componentName -

componentType -

Returns:

Throws:

ARException

createSettingEntries

public static int createSettingEntries(ARServerUser context,
                                       String componentGUID,
                                       String componentName,
                                       String componentType,
                                       List<String[]> nameValuePair)
                                throws ARException

The function creates a new setting entry on "AR System Configuration Component Setting" form.

Parameters:

context - : ARServerUser context

componentGUID - : Component GUID. If a NULL is passed here, a new component entry will get created

componentName - : Component Name.

componentType - : Component Type.

nameValuePair - : List of Name value pairs.

Returns:

: Returns the number of entries created. If all entries are created, the count will be equal to the number of Name/Value pairs passed.

Throws:

ARException

setSettingEntries

public static void setSettingEntries(ARServerUser context,
                                     String entryID,
                                     String componentGUID,
                                     String componentName,
                                     String componentType,
                                     String settingName,
                                     String settingValue)
                              throws ARException

The function creates a new setting entry on "AR System Configuration Component Setting" form.

Parameters:

context - : ARServerUser context

componentGUID - : Component GUID. If a NULL is passed here, a new component entry will get created

componentName - : Component Name.

componentType - : Component Type.

nameValuePair - : List of Name value pairs.

Throws:

ARException

getConfigSettingsAsList

public static List<String[]> getConfigSettingsAsList(ARServerUser context,
                                                     String configName,
                                                     String configType,
                                                     String settingName)
                                              throws ARException

Throws:

ARException

getEntryValue

public static String getEntryValue(Entry thisEntry)

getConfigSettingsWithEntryIDs

public static List<Entry> getConfigSettingsWithEntryIDs(ARServerUser context,
                                                        String configName,
                                                        String configType,
                                                        String settingName)
                                                 throws ARException

Throws:

ARException

getConfigSettingsWithEntryIDs

public static List<Entry> getConfigSettingsWithEntryIDs(ARServerUser context,
                                                        String configName,
                                                        String configType,
                                                        String settingName,
                                                        int relationOPForCompName)
                                                 throws ARException

Throws:

ARException

getComponentGUIDFromEntry

public static String getComponentGUIDFromEntry(Entry thisEntry)

getConfigSettingsAsMap

public static Map<String,List<String>> getConfigSettingsAsMap(ARServerUser context,
                                                              String configName,
                                                              String configType,
                                                              String settingName)
                                                       throws ARException

This method will return a HashMap of setting name vs list of setting values associated with that setting name.

Parameters:

context -

configName -

configType -

settingName -

Returns:

Throws:

ARException

changeComponentStatus

public static void changeComponentStatus(ARServerUser context,
                                         String componentGUID,
                                         boolean status)
                                  throws ARException

This method will set the component to Active if status is true, else set it to Inactive

Parameters:

componentGUID -

status -

Throws:

ARException

updateComponent

public static void updateComponent(ARServerUser context,
                                   String componentGUID,
                                   String componentName,
                                   String componentType,
                                   String componentDescription,
                                   boolean status)
                            throws ARException

This method can be used to update component values like name, type and description provided these fields are not null Status will always be updated This method will not update the GUID

Parameters:

componentGUID -

status -

Throws:

ARException

updateConfigSetting

public static void updateConfigSetting(ARServerUser context,
                                       String settingEntryID,
                                       String settingName,
                                       String settingValue)
                                throws ARException

Throws:

ARException

updateOrCreateSetting

public static void updateOrCreateSetting(ARServerUser context,
                                         String componentGUID,
                                         String componentName,
                                         String componentType,
                                         String settingName,
                                         String settingValue)
                                  throws ARException

Only use this method if setting name is unique, will not work for duplicates as it will only update the first one

Parameters:

context -

componentGUID -

componentName -

componentType -

settingName -

settingValue -

Throws:

ARException

deleteSetting

public static boolean deleteSetting(ARServerUser context,
                                    String componentName,
                                    String componentType,
                                    String settingName,
                                    String settingValue)
                             throws ARException

Delete settings entries that have a specific name and value.

Parameters:

context - the server connection

componentName - the component name

componentType - the component type

settingName - the setting name

settingValue - the setting value

Returns:

true if at least one entry was deleted, false otherwise

Throws:

ARException