oracle.as.scheduler.management
Interface RuntimeConfigMXBeanProxy

public interface RuntimeConfigMXBeanProxy

Since:

PS5

Version:

$Header: ess/src/oracle/as/scheduler/management/RuntimeConfigMXBeanProxy.java /st_ess_11.1.1.5.0pt/4 2012/03/07 09:51:34 riyanu Exp $

Author:

riyanu

Field Summary

static java.lang.String	s_mbeanObjectNameString
static java.lang.String	s_shortName

Method Summary

boolean	addOrReplaceConfigProperties(java.lang.String application, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propTypeNameValueMap) Add or replace a set of ESS/APP properties to the ess configuration of the specified application.
boolean	addOrReplaceConfigProperty(java.lang.String application, java.lang.String propType, java.lang.String propName, java.lang.String propValue) Add or replace a ESS/APP property to the ess configuration of the specified application.
boolean	deleteConfigProperties(java.lang.String application, java.util.Map<java.lang.String,java.util.List<java.lang.String>> propTypeNameMap) Deletes a set of ESS/APP properties from the ess configuration of the specified application.
boolean	deleteConfigProperty(java.lang.String application, java.lang.String propType, java.lang.String propName) Deletes an ESS/APP property fromthe ess configuration of the specified application.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getAllConfigProperties(java.lang.String application) Returns the name-value pair of properties of all types of a specific application.
java.util.Map<java.lang.String,java.lang.String>	getConfigProperties(java.lang.String application, java.lang.String propType) Returns the name-value pair of all the properties of type ESS/APP of a specific application.
java.lang.String	getConfigProperty(java.lang.String application, java.lang.String propType, java.lang.String propName) Returns the value of ESS/APP property name from the ess configuration of the specified application.
java.util.Map<java.lang.String,java.util.List<ConfigProperty>>	getDetailedConfigProperties(java.lang.String application) Returns the list of ConfigProperty instances of all types of a specific application.
boolean	isPropertyExists(java.lang.String application, java.lang.String propType, java.lang.String propName) Returns whether a property exists in properties list of the specified application.

Field Detail

s_shortName

static final java.lang.String s_shortName

See Also:

Constant Field Values

s_mbeanObjectNameString

static final java.lang.String s_mbeanObjectNameString

Method Detail

addOrReplaceConfigProperty

boolean addOrReplaceConfigProperty(java.lang.String application,
                                   java.lang.String propType,
                                   java.lang.String propName,
                                   java.lang.String propValue)
                                   throws java.io.IOException,
                                          javax.management.InvalidAttributeValueException,
                                          javax.management.OperationsException,
                                          javax.management.RuntimeOperationsException

Add or replace a ESS/APP property to the ess configuration of the specified application. ESS properties are predefined and properties cannot be added.

Parameters:

application - name of the application

propType - string equivalent of EssConfigFacade.PropertyType

propName - name of the property to add/modify

propValue - value of the property to add/modify

Returns:

true if property is added/replaced, false otherwise

Throws:

java.io.IOException - if a protocol error occurred.

javax.management.InvalidAttributeValueException - if the passed parameters are invalid

javax.management.OperationsException - if the specific action is not allowed

javax.management.RuntimeOperationsException - if a Configuration failure occurs

deleteConfigProperty

boolean deleteConfigProperty(java.lang.String application,
                             java.lang.String propType,
                             java.lang.String propName)
                             throws java.io.IOException,
                                    javax.management.InvalidAttributeValueException,
                                    javax.management.OperationsException,
                                    javax.management.RuntimeOperationsException

Deletes an ESS/APP property fromthe ess configuration of the specified application.

Parameters:

application - name of the application

propType - string equivalent of EssConfigFacade.PropertyType

propName - name of the property to delete

Returns:

true if property is deleted, false otherwise

Throws:

java.io.IOException - if a protocol error occurred.

javax.management.InvalidAttributeValueException - if the passed parameters are invalid

javax.management.RuntimeOperationsException - if a Configuration failure occurs

javax.management.OperationsException

getConfigProperty

java.lang.String getConfigProperty(java.lang.String application,
                                   java.lang.String propType,
                                   java.lang.String propName)
                                   throws java.io.IOException,
                                          javax.management.InvalidAttributeValueException,
                                          javax.management.InstanceNotFoundException,
                                          javax.management.RuntimeOperationsException

Returns the value of ESS/APP property name from the ess configuration of the specified application.

Parameters:

application - name of the application

propType - string equivalent of EssConfigFacade.PropertyType

propName - name of the property to retrieve

Returns:

value associated with the propName

Throws:

java.io.IOException - if a protocol error occurred.

javax.management.InvalidAttributeValueException - if the passed parameters are invalid

javax.management.InstanceNotFoundException - if the configuaction doesn't exists for the property supplied

javax.management.RuntimeOperationsException - if a Configuration failure occurs

isPropertyExists

boolean isPropertyExists(java.lang.String application,
                         java.lang.String propType,
                         java.lang.String propName)
                         throws java.io.IOException,
                                javax.management.InvalidAttributeValueException,
                                javax.management.RuntimeOperationsException

Returns whether a property exists in properties list of the specified application.

Parameters:

application - name of the application

propType - string equivalent of EssConfigFacade.PropertyType

propName - name of the property to check for existense

Returns:

value true if the property exists, false otherwise

Throws:

java.io.IOException - if a protocol error occurred.

javax.management.InvalidAttributeValueException - if the passed parameters are invalid

javax.management.RuntimeOperationsException - if a Configuration failure occurs

getConfigProperties

java.util.Map<java.lang.String,java.lang.String> getConfigProperties(java.lang.String application,
                                                                     java.lang.String propType)
                                                                     throws java.io.IOException,
                                                                            javax.management.InvalidAttributeValueException,
                                                                            javax.management.RuntimeOperationsException

Returns the name-value pair of all the properties of type ESS/APP of a specific application.

Parameters:

application - name of the application

propType - string equivalent of EssConfigFacade.PropertyType

Returns:

Map complete key-value pair of properties

Throws:

java.io.IOException - if a protocol error occurred.

javax.management.InvalidAttributeValueException - if the passed parameters are invalid

javax.management.RuntimeOperationsException - if a Configuration failure occurs

addOrReplaceConfigProperties

boolean addOrReplaceConfigProperties(java.lang.String application,
                                     java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> propTypeNameValueMap)
                                     throws javax.management.InvalidAttributeValueException,
                                            javax.management.OperationsException,
                                            javax.management.RuntimeOperationsException

Add or replace a set of ESS/APP properties to the ess configuration of the specified application. ESS properties are predefined and new properties cannot be added. The outer map of propTypeNameValueMap parameter must have either APP or ESS as key. Value part of outer Map is another Map of as pairs.

Parameters:

application - name of the application

propTypeNameValueMap - Map of maps that contain propName and propVal as key-value pairs

Returns:

true if properties are added/replaced, false otherwise

Throws:

javax.management.InvalidAttributeValueException - if the passed parameters are invalid

javax.management.OperationsException - if the specific action is not allowed

javax.management.RuntimeOperationsException - if a Configuration failure occurs

deleteConfigProperties

boolean deleteConfigProperties(java.lang.String application,
                               java.util.Map<java.lang.String,java.util.List<java.lang.String>> propTypeNameMap)
                               throws javax.management.InvalidAttributeValueException,
                                      javax.management.OperationsException,
                                      javax.management.RuntimeOperationsException

Deletes a set of ESS/APP properties from the ess configuration of the specified application. The map of propTypeNameMap parameter must have either APP or ESS as key. Value part is a list of property names tobe deleted

Parameters:

application - name of the application

propTypeNameMap - Map of maps that contain List of propName

Returns:

true if properties are deleted, false otherwise

Throws:

javax.management.InvalidAttributeValueException - if the passed parameters are invalid

javax.management.OperationsException - if the specific action is not allowed

javax.management.RuntimeOperationsException - if a Configuration failure occurs

getAllConfigProperties

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getAllConfigProperties(java.lang.String application)
                                                                                                        throws javax.management.InvalidAttributeValueException,
                                                                                                               javax.management.RuntimeOperationsException

Returns the name-value pair of properties of all types of a specific application.

Parameters:

application - name of the application

Returns:

Map> complete key-value pair of all properties

Throws:

javax.management.InvalidAttributeValueException - if the passed parameters are invalid

javax.management.RuntimeOperationsException - if a Configuration failure occurs

getDetailedConfigProperties

java.util.Map<java.lang.String,java.util.List<ConfigProperty>> getDetailedConfigProperties(java.lang.String application)
                                                                                           throws javax.management.InvalidAttributeValueException,
                                                                                                  javax.management.RuntimeOperationsException

Returns the list of ConfigProperty instances of all types of a specific application.

Parameters:

application - name of the application

Returns:

Map> complete ConfigProperty instances of all properties

Throws:

javax.management.InvalidAttributeValueException - if the passed parameters are invalid

javax.management.RuntimeOperationsException - if a Configuration failure occurs