Package org.osgi.jmx.service.cm

Interface ConfigurationAdminMBean

  • public interface ConfigurationAdminMBean
    This MBean provides the management interface to the OSGi Configuration Administration Service.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String OBJECTNAME
      The object name for this mbean.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createFactoryConfiguration​(java.lang.String factoryPid)
      Create a new configuration instance for the supplied persistent id of the factory, answering the PID of the created configuration
      java.lang.String createFactoryConfigurationForLocation​(java.lang.String factoryPid, java.lang.String location)
      Create a factory configuration for the supplied persistent id of the factory and the bundle location bound to bind the created configuration to, answering the PID of the created configuration
      void delete​(java.lang.String pid)
      Delete the configuration
      void deleteConfigurations​(java.lang.String filter)
      Delete the configurations matching the filter specification.
      void deleteForLocation​(java.lang.String pid, java.lang.String location)
      Delete the configuration
      java.lang.String getBundleLocation​(java.lang.String pid)
      Answer the bundle location the configuration is bound to
      java.lang.String[][] getConfigurations​(java.lang.String filter)
      Answer the list of PID/Location pairs of the configurations managed by this service
      java.lang.String getFactoryPid​(java.lang.String pid)
      Answer the factory PID if the configuration is a factory configuration, null otherwise.
      java.lang.String getFactoryPidForLocation​(java.lang.String pid, java.lang.String location)
      Answer the factory PID if the configuration is a factory configuration, null otherwise.
      javax.management.openmbean.TabularData getProperties​(java.lang.String pid)
      Answer the contents of the configuration
      javax.management.openmbean.TabularData getPropertiesForLocation​(java.lang.String pid, java.lang.String location)
      Answer the contents of the configuration
      void setBundleLocation​(java.lang.String pid, java.lang.String location)
      Set the bundle location the configuration is bound to
      void update​(java.lang.String pid, javax.management.openmbean.TabularData properties)
      Update the configuration with the supplied properties For each property entry, the following row is supplied
      void updateForLocation​(java.lang.String pid, java.lang.String location, javax.management.openmbean.TabularData properties)
      Update the configuration with the supplied properties For each property entry, the following row is supplied

    • Field Detail

      • OBJECTNAME

        static final java.lang.String OBJECTNAME
        The object name for this mbean.
        See Also:
        Constant Field Values

    • Method Detail

      • createFactoryConfiguration

        java.lang.String createFactoryConfiguration​(java.lang.String factoryPid)
                                     throws java.io.IOException
        Create a new configuration instance for the supplied persistent id of the factory, answering the PID of the created configuration
        Parameters:
        factoryPid - the persistent id of the factory
        Returns:
        the PID of the created configuration
        Throws:
        java.io.IOException - if the operation failed

      • createFactoryConfigurationForLocation

        java.lang.String createFactoryConfigurationForLocation​(java.lang.String factoryPid,
                                                       java.lang.String location)
                                                throws java.io.IOException
        Create a factory configuration for the supplied persistent id of the factory and the bundle location bound to bind the created configuration to, answering the PID of the created configuration
        Parameters:
        factoryPid - the persistent id of the factory
        location - the bundle location
        Returns:
        the pid of the created configuation
        Throws:
        java.io.IOException - if the operation failed

      • delete

        void delete​(java.lang.String pid)
     throws java.io.IOException
        Delete the configuration
        Parameters:
        pid - the persistent identifier of the configuration
        Throws:
        java.io.IOException - if the operation fails

      • deleteForLocation

        void deleteForLocation​(java.lang.String pid,
                       java.lang.String location)
                throws java.io.IOException
        Delete the configuration
        Parameters:
        pid - the persistent identifier of the configuration
        location - the bundle location
        Throws:
        java.io.IOException - if the operation fails

      • deleteConfigurations

        void deleteConfigurations​(java.lang.String filter)
                   throws java.io.IOException
        Delete the configurations matching the filter specification.
        Parameters:
        filter - the string representation of the org.osgi.framework.Filter
        Throws:
        java.io.IOException - if the operation failed
        java.lang.IllegalArgumentException - if the filter is invalid

      • getBundleLocation

        java.lang.String getBundleLocation​(java.lang.String pid)
                            throws java.io.IOException
        Answer the bundle location the configuration is bound to
        Parameters:
        pid - the persistent identifier of the configuration
        Returns:
        the bundle location
        Throws:
        java.io.IOException - if the operation fails

      • getFactoryPid

        java.lang.String getFactoryPid​(java.lang.String pid)
                        throws java.io.IOException
        Answer the factory PID if the configuration is a factory configuration, null otherwise.
        Parameters:
        pid - the persistent identifier of the configuration
        Returns:
        the factory PID
        Throws:
        java.io.IOException - if the operation fails

      • getFactoryPidForLocation

        java.lang.String getFactoryPidForLocation​(java.lang.String pid,
                                          java.lang.String location)
                                   throws java.io.IOException
        Answer the factory PID if the configuration is a factory configuration, null otherwise.
        Parameters:
        pid - the persistent identifier of the configuration
        location - the bundle location
        Returns:
        the factory PID
        Throws:
        java.io.IOException - if the operation fails

      • getProperties

        javax.management.openmbean.TabularData getProperties​(java.lang.String pid)
                                              throws java.io.IOException
        Answer the contents of the configuration

        Parameters:
        pid - the persistent identifier of the configuration
        Returns:
        the table of contents
        Throws:
        java.io.IOException - if the operation fails
        See Also:
        for the details of the TabularType

      • getPropertiesForLocation

        javax.management.openmbean.TabularData getPropertiesForLocation​(java.lang.String pid,
                                                                java.lang.String location)
                                                         throws java.io.IOException
        Answer the contents of the configuration

        Parameters:
        pid - the persistent identifier of the configuration
        location - the bundle location
        Returns:
        the table of contents
        Throws:
        java.io.IOException - if the operation fails
        See Also:
        for the details of the TabularType

      • getConfigurations

        java.lang.String[][] getConfigurations​(java.lang.String filter)
                                throws java.io.IOException
        Answer the list of PID/Location pairs of the configurations managed by this service
        Parameters:
        filter - the string representation of the org.osgi.framework.Filter
        Returns:
        the list of configuration PID/Location pairs
        Throws:
        java.io.IOException - if the operation failed
        java.lang.IllegalArgumentException - if the filter is invalid

      • setBundleLocation

        void setBundleLocation​(java.lang.String pid,
                       java.lang.String location)
                throws java.io.IOException
        Set the bundle location the configuration is bound to
        Parameters:
        pid - the persistent identifier of the configuration
        location - the bundle location
        Throws:
        java.io.IOException - if the operation fails

      • update

        void update​(java.lang.String pid,
            javax.management.openmbean.TabularData properties)
     throws java.io.IOException
        Update the configuration with the supplied properties For each property entry, the following row is supplied

        Parameters:
        pid - the persistent identifier of the configuration
        properties - the table of properties
        Throws:
        java.io.IOException - if the operation fails
        See Also:
        for the details of the TabularType

      • updateForLocation

        void updateForLocation​(java.lang.String pid,
                       java.lang.String location,
                       javax.management.openmbean.TabularData properties)
                throws java.io.IOException
        Update the configuration with the supplied properties For each property entry, the following row is supplied

        Parameters:
        pid - the persistent identifier of the configuration
        location - the bundle location
        properties - the table of properties
        Throws:
        java.io.IOException - if the operation fails
        See Also:
        for the details of the TabularType