com.ibm.websphere.collective.controller

Interface ControllerConfigMBean



  • public interface ControllerConfigMBean
    ControllerConfigMBean defines the administrative interface for managing shared config files across a collective controller replica set.

    The ObjectName for this MBean is "WebSphere:feature=collectiveController,type=ControllerConfig,name=ControllerConfig".

    The ControllerConfigMBean supports the creation, deletion, and listing of shared config files. The config files are stored in the ${wlp.user.dir}//configDropins/defaults directory.

    When you store (or delete) a shared config file through one replica, it is automatically replicated to the corresponding directory in all the other replicas in the replica set.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String OBJECT_NAME
      A String representing the ObjectName that this MBean maps to.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addSharedConfig(java.lang.String fileName, java.lang.String config)
      Add additional config to the replica set through it's shared config directory.
      java.lang.String[] listSharedConfig()
      List the files in the replica's shared config directory.
      void removeSharedConfig(java.lang.String fileName)
      Remove config from the replica's shared config directory, by deleting the specified file from the replica's configDropins/defaults directory.
    • Field Detail

      • OBJECT_NAME

        static final java.lang.String OBJECT_NAME
        A String representing the ObjectName that this MBean maps to.
        See Also:
        Constant Field Values
    • Method Detail

      • addSharedConfig

        void addSharedConfig(java.lang.String fileName,
                           java.lang.String config)
                             throws java.io.IOException,
                                    java.lang.IllegalArgumentException
        Add additional config to the replica set through it's shared config directory. Store config in replica's configDropins/defaults directory, which shares it with the other replicas. If you specify a fileName that already exists in the shared config, it will be overwritten.
        Parameters:
        fileName - - file name to create in shared config directory
        config - - config to store in file
        Throws:
        java.io.IOException - - if something goes wrong in the replica during this operation.
        java.lang.IllegalArgumentException - - if fileName or config parameters are null.
      • removeSharedConfig

        void removeSharedConfig(java.lang.String fileName)
                                throws java.io.IOException,
                                       java.lang.IllegalArgumentException
        Remove config from the replica's shared config directory, by deleting the specified file from the replica's configDropins/defaults directory. If fileName is not found in shared config directory, this operation does nothing.
        Parameters:
        fileName - - file name to delete from shared config directory
        Throws:
        java.io.IOException - - if something goes wrong in replica during this operation.
        java.lang.IllegalArgumentException - - if fileName is null.
      • listSharedConfig

        java.lang.String[] listSharedConfig()
                                            throws java.io.IOException
        List the files in the replica's shared config directory. The array will be empty if the directory is empty. A null is returned if the shared config directory does not exist.
        Returns:
        array of file names
        Throws:
        java.io.IOException - - if something goes wrong in replica during this operation.