com.ibm.broker.plugin

Class MbConfigObject

  • java.lang.Object
    • com.ibm.broker.plugin.MbConfigObject


  • public class MbConfigObject
    extends java.lang.Object
    MbConfigObject provides access to a config object in the C++ part of the broker. An instance of this class is returned by the getConfigObject() method of MbNode.
    • Constructor Summary

      Constructors 
      Constructor and Description
      MbConfigObject(long handle_)
      The only constructor for a config object accepts the native handle to the C++ config object
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String asString()
      Returns a string representation of the config object
      MbConfigObject findPolicy(java.lang.String policyType, java.lang.String policyName)
      Retrieves the closest relevant policy to this object.
      boolean getBooleanPropertyValue(java.lang.String propertyName)
      Retrieves the boolean value for the named property.
      MbConfigObject getChildByIdentifier(java.lang.String id)
      Returns the child object for the matching internal identifier
      java.util.Collection<MbProperty> getDescriptiveProperties()
      Return a collection containing the descriptive properties
      MbProperty getDescriptiveProperty(java.lang.String name)
      Returns the named descriptive property from the config object
      java.lang.Object getDescriptivePropertyValue(java.lang.String name)
      Returns the value of the named descriptive property from the config object
      java.lang.String getDescriptiveStringPropertyValue(java.lang.String propertyName)
      Retrieves the character value for the named descriptive property.
      MbConfigObject getFirstChild(java.lang.String name)
      Returns the child object matching the provided name
      int getIntegerPropertyValue(java.lang.String propertyName)
      Retrieves the int value for the named property.
      long getLongPropertyValue(java.lang.String propertyName)
      Retrieves the long value for the named property.
      java.util.Collection<MbProperty> getProperties()
      Return a collection containing the properties
      MbProperty getProperty(java.lang.String name)
      Returns the named property from the config object
      java.lang.Object getPropertyValue(java.lang.String name)
      Returns the value of the named property from the config object
      java.lang.String getStringPropertyValue(java.lang.String propertyName)
      Retrieves the character value for the named property.
      java.lang.String getStringPropertyValue(java.lang.String propertyName, java.lang.String defaultValue)
      Retrieves the string value for the named property.
      boolean hasProperty(java.lang.String name)
      Returns the value of the named property from the config object
      java.lang.String internalIdentifier()
      Returns the internalIdentifier of the config object as a string
      boolean isPropertyValueValid(java.lang.String name)
      Returns whether the value of the named property from the config object has a valid value
      java.lang.String longDescription()
      Returns the longDescription property of the config object as a string
      java.lang.String name()
      Returns the name of the config object as a string
      int numberOfChildren()
      Returns the number of children config objects
      int numberOfChildren(java.lang.String name)
      Returns the number of children config objects matching the supplied name
      int numberOfDescriptiveProperties()
      Returns the number of descriptive properties in the config object
      int numberOfProperties()
      Returns the number of properties in the config object
      MbConfigObject owner()
      Returns the parent config object
      java.lang.String shortDescription()
      Returns the shortDescription property of the config object as a string
      java.lang.String type()
      Returns the type property of the config object as a string
      java.lang.String version()
      Returns the version property of the config object as a string
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MbConfigObject

        public MbConfigObject(long handle_)
        The only constructor for a config object accepts the native handle to the C++ config object
    • Method Detail

      • name

        public java.lang.String name()
                              throws MbException
        Returns the name of the config object as a string
        Returns:
        The config object name
        Throws:
        MbException
      • type

        public java.lang.String type()
                              throws MbException
        Returns the type property of the config object as a string
        Returns:
        The config object type
        Throws:
        MbException
      • internalIdentifier

        public java.lang.String internalIdentifier()
                                            throws MbException
        Returns the internalIdentifier of the config object as a string
        Returns:
        The config object internalIdentifier
        Throws:
        MbException
      • version

        public java.lang.String version()
                                 throws MbException
        Returns the version property of the config object as a string
        Returns:
        The config object version
        Throws:
        MbException
      • shortDescription

        public java.lang.String shortDescription()
                                          throws MbException
        Returns the shortDescription property of the config object as a string
        Returns:
        The config object shortDescription
        Throws:
        MbException
      • longDescription

        public java.lang.String longDescription()
                                         throws MbException
        Returns the longDescription property of the config object as a string
        Returns:
        The config object longDescription
        Throws:
        MbException
      • asString

        public java.lang.String asString()
                                  throws MbException
        Returns a string representation of the config object
        Returns:
        The config object asString
        Throws:
        MbException
      • numberOfProperties

        public int numberOfProperties()
                               throws MbException
        Returns the number of properties in the config object
        Returns:
        The number of properties
        Throws:
        MbException
      • numberOfDescriptiveProperties

        public int numberOfDescriptiveProperties()
                                          throws MbException
        Returns the number of descriptive properties in the config object
        Returns:
        The number of descriptive properties
        Throws:
        MbException
      • getPropertyValue

        public java.lang.Object getPropertyValue(java.lang.String name)
                                          throws MbException
        Returns the value of the named property from the config object
        Parameters:
        name - The property to be returned
        Returns:
        java.lang.Object
        Throws:
        MbException
      • hasProperty

        public boolean hasProperty(java.lang.String name)
                            throws MbException
        Returns the value of the named property from the config object
        Parameters:
        name - The property to be returned
        Returns:
        boolean
        Throws:
        MbException
      • isPropertyValueValid

        public boolean isPropertyValueValid(java.lang.String name)
                                     throws MbException
        Returns whether the value of the named property from the config object has a valid value
        Parameters:
        name - The property to be returned
        Returns:
        boolean
        Throws:
        MbException
      • getDescriptivePropertyValue

        public java.lang.Object getDescriptivePropertyValue(java.lang.String name)
                                                     throws MbException
        Returns the value of the named descriptive property from the config object
        Parameters:
        name - The property to be returned
        Returns:
        java.lang.Object
        Throws:
        MbException
      • getDescriptiveStringPropertyValue

        public java.lang.String getDescriptiveStringPropertyValue(java.lang.String propertyName)
                                                           throws MbException
        Retrieves the character value for the named descriptive property. If the node property does not exist then an exception will be thrown. If the node property is not a character value then an exception will be thrown.
        Returns:
        the String value for the property
        Throws:
        MbException
      • getProperty

        public MbProperty getProperty(java.lang.String name)
                               throws MbException
        Returns the named property from the config object
        Parameters:
        name - The property to be returned
        Returns:
        java.lang.Object
        Throws:
        MbException
      • getDescriptiveProperty

        public MbProperty getDescriptiveProperty(java.lang.String name)
                                          throws MbException
        Returns the named descriptive property from the config object
        Parameters:
        name - The property to be returned
        Returns:
        MbProperty
        Throws:
        MbException
      • numberOfChildren

        public int numberOfChildren()
                             throws MbException
        Returns the number of children config objects
        Returns:
        The number of children objects
        Throws:
        MbException
      • numberOfChildren

        public int numberOfChildren(java.lang.String name)
                             throws MbException
        Returns the number of children config objects matching the supplied name
        Returns:
        The number of matching children objects
        Throws:
        MbException
      • getFirstChild

        public MbConfigObject getFirstChild(java.lang.String name)
                                     throws MbException
        Returns the child object matching the provided name
        Parameters:
        name - The name of the child to be returned
        Returns:
        MbConfigObject
        Throws:
        MbException
      • getChildByIdentifier

        public MbConfigObject getChildByIdentifier(java.lang.String id)
                                            throws MbException
        Returns the child object for the matching internal identifier
        Parameters:
        id - The internal identifier of the child to be returned
        Returns:
        MbConfigObject
        Throws:
        MbException
      • getProperties

        public java.util.Collection<MbProperty> getProperties()
                                                       throws MbException
        Return a collection containing the properties
        Returns:
        The property collection
        Throws:
        MbException
      • getDescriptiveProperties

        public java.util.Collection<MbProperty> getDescriptiveProperties()
                                                                  throws MbException
        Return a collection containing the descriptive properties
        Returns:
        The descriptive property collection
        Throws:
        MbException
      • getBooleanPropertyValue

        public boolean getBooleanPropertyValue(java.lang.String propertyName)
                                        throws MbException
        Retrieves the boolean value for the named property. If the property does not exist then an exception will be thrown. If the property is not a boolean value then an exception will be thrown.
        Returns:
        the boolean value for the property
        Throws:
        MbException
      • getStringPropertyValue

        public java.lang.String getStringPropertyValue(java.lang.String propertyName)
                                                throws MbException
        Retrieves the character value for the named property. If the property does not exist then an exception will be thrown. If the property is not a character value then an exception will be thrown.
        Returns:
        the String value for the property
        Throws:
        MbException
      • getStringPropertyValue

        public java.lang.String getStringPropertyValue(java.lang.String propertyName,
                                                       java.lang.String defaultValue)
        Retrieves the string value for the named property. If the property does not exist then the default value will be returned. If the property is not a string value then the default value will be returned.
        Returns:
        the String value for the property or the defaultValue
      • getLongPropertyValue

        public long getLongPropertyValue(java.lang.String propertyName)
                                  throws MbException
        Retrieves the long value for the named property. If the property does not exist then an exception will be thrown. If the property is not a long value then an exception will be thrown.
        Returns:
        the long value for the property
        Throws:
        MbException
      • getIntegerPropertyValue

        public int getIntegerPropertyValue(java.lang.String propertyName)
                                    throws MbException
        Retrieves the int value for the named property. If th property does not exist then an exception will be thrown. If the property is not an integer value then an exception will be thrown.
        Returns:
        the integer value for the property
        Throws:
        MbException
      • findPolicy

        public MbConfigObject findPolicy(java.lang.String policyType,
                                         java.lang.String policyName)
                                  throws MbException
        Retrieves the closest relevant policy to this object.
        Returns:
        closest relevant policy, or null if no relevant policy found
        Throws:
        MbException
IBM Integration BusTM
JavaTM Plugin Node API