Interface FeatureListMBean


public interface FeatureListMBean
This MBean allows users to generate the feature list pertaining to the Liberty server.

The ObjectName for this MBean is "WebSphere:name=com.ibm.websphere.config.mbeans.FeatureListMBean".

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Key for the file path of the generated feature list.
    static final String
    Key for the merged (systemOut and systemErr) output of the feature list generation.
    static final String
    Key for the return code of the feature list generation.
    static final String
    A String representing the ObjectName that this MBean maps to.
    static final int
    Value of KEY_RETURN_CODE when an error is encountered during schema generation.
    static final int
    Value of KEY_RETURN_CODE when the schema generation is successful.
  • Method Summary

    Modifier and Type
    Method
    Description
    generate(String encoding, String locale, String productExt)
    Creates a local XML file containing the server feature list, generated with the given options.
  • Field Details

    • OBJECT_NAME

      static final String OBJECT_NAME
      A String representing the ObjectName that this MBean maps to.
      See Also:
    • KEY_OUTPUT

      static final String KEY_OUTPUT
      Key for the merged (systemOut and systemErr) output of the feature list generation. The value is a java.lang.String
      See Also:
    • KEY_RETURN_CODE

      static final String KEY_RETURN_CODE
      Key for the return code of the feature list generation. The value is an integer that will be either RETURN_CODE_OK or RETURN_CODE_ERROR.
      See Also:
    • KEY_FILE_PATH

      static final String KEY_FILE_PATH
      Key for the file path of the generated feature list. The value is a java.lang.String and represents the absolute location of the generated feature list in the server's file system.
      See Also:
    • RETURN_CODE_OK

      static final int RETURN_CODE_OK
      Value of KEY_RETURN_CODE when the schema generation is successful.
      See Also:
    • RETURN_CODE_ERROR

      static final int RETURN_CODE_ERROR
      Value of KEY_RETURN_CODE when an error is encountered during schema generation.
      See Also:
  • Method Details

    • generate

      Map<String,Object> generate(String encoding, String locale, String productExt)
      Creates a local XML file containing the server feature list, generated with the given options. It is the responsibility of the user to delete this generated file after it is used, since the server will only delete it during the next server startup.
      Parameters:
      encoding - a String that specifies the character set to use when writing the feature list xml file.
      locale - a String which specifies the language to use when writing the feature list. This consists of the ISO-639 two-letter lowercase language code, optionally followed by an underscore and the ISO-3166 uppercase two-letter country code.
      productExt - a String which specifies the product extension name whose features are to be listed. If the product extension is installed in the default user location, use the keyword: usr. If this option is not specified, the action is taken on Liberty core.
      Returns:
      a map containing keys KEY_OUTPUT, KEY_RETURN_CODE, and KEY_FILE_PATH