com.ibm.soa.common.mbean
Interface Settings

All Superinterfaces:
GeneralProperties, com.ibm.soa.common.mbean.SettingsHelperIF

public interface Settings
extends GeneralProperties

The Settings interface is the base interface for administered settings.

Version:
1.3

Method Summary
 java.lang.String getApplicationName()
          Get the Application Name (EAR Name).
 java.lang.Object getAttribute(java.lang.String s)
          Get an attribute.
 javax.management.AttributeList getAttributes(java.lang.String[] attributes)
          Get the attributes.
 java.lang.String getBeanName()
          Get the name of the MBean.
 java.lang.String getHelpPage(java.lang.String name, java.util.Locale locale)
          Get the help page.
 java.lang.String getInterfaceNames()
          Get the interfaces names that this MBean supports for JSP rendering.
 java.lang.String getObjectName()
          Get the Object name of this MBean.
 java.lang.String getString(java.lang.String key, java.util.Locale locale)
          Get a string from a resource.
 java.lang.String getTypeName()
          Get the Type name that this MBean is registered under.
 boolean isValidEndpoint(java.lang.String endPoint)
          Is the endpoint valid.
 void setAttribute(javax.management.Attribute attribute)
          Set the attribute.
 
Methods inherited from interface com.ibm.soa.common.mbean.GeneralProperties
getAttributeContext, getAttributePossibleValues, getAttributeProperties, getAttributeType, getContext, getDisplayName, getDisplayName, setContext, setDisplayName
 

Method Detail

getApplicationName

java.lang.String getApplicationName()
Get the Application Name (EAR Name).

Returns:
the EAR name

getObjectName

java.lang.String getObjectName()
Get the Object name of this MBean.

Returns:
the ObjectName

getTypeName

java.lang.String getTypeName()
Get the Type name that this MBean is registered under.

Returns:
the Type name

getBeanName

java.lang.String getBeanName()
Get the name of the MBean.

Returns:
the name

getInterfaceNames

java.lang.String getInterfaceNames()
Get the interfaces names that this MBean supports for JSP rendering.

Returns:
the array of interfaces

getAttribute

java.lang.Object getAttribute(java.lang.String s)
                              throws javax.management.AttributeNotFoundException,
                                     javax.management.MBeanException,
                                     javax.management.ReflectionException
Get an attribute.

Parameters:
s - the name of the attribute
Returns:
the attribute value
Throws:
javax.management.AttributeNotFoundException - on invalid attribute
javax.management.MBeanException - on bean error
javax.management.ReflectionException - on dynamic invocation error

setAttribute

void setAttribute(javax.management.Attribute attribute)
                  throws javax.management.AttributeNotFoundException,
                         javax.management.InvalidAttributeValueException,
                         javax.management.MBeanException,
                         javax.management.InstanceNotFoundException,
                         javax.management.ReflectionException
Set the attribute.

Parameters:
attribute - the attribute to set
Throws:
javax.management.AttributeNotFoundException - on invalid attribute
javax.management.InvalidAttributeValueException - on an invalid error
javax.management.MBeanException - on bean error
javax.management.InstanceNotFoundException - on invalid instance
javax.management.ReflectionException - on dynamic invocation error

getAttributes

javax.management.AttributeList getAttributes(java.lang.String[] attributes)
                                             throws javax.management.InstanceNotFoundException,
                                                    javax.management.ReflectionException
Get the attributes.

Parameters:
attributes - the array of attribute names
Returns:
the result list
Throws:
javax.management.InstanceNotFoundException - on invalid instance error
javax.management.ReflectionException - on dynamic invocation error

getString

java.lang.String getString(java.lang.String key,
                           java.util.Locale locale)
Get a string from a resource.

Parameters:
key - the key
locale - the locale
Returns:
the result

getHelpPage

java.lang.String getHelpPage(java.lang.String name,
                             java.util.Locale locale)
Get the help page.

Parameters:
name - the name of the file
locale - the locale
Returns:
the page content

isValidEndpoint

boolean isValidEndpoint(java.lang.String endPoint)
Is the endpoint valid.

Parameters:
endPoint - the endpoint.
Returns:
true for valid


Copyright © 2006 IBM Corp. All Rights Reserved.