Package com.ibm.websphere.config.mbeans
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 java.lang.String
KEY_FILE_PATH
Key for the file path of the generated feature list.static java.lang.String
KEY_OUTPUT
Key for the merged (systemOut and systemErr) output of the feature list generation.static java.lang.String
KEY_RETURN_CODE
Key for the return code of the feature list generation.static java.lang.String
OBJECT_NAME
A String representing theObjectName
that this MBean maps to.static int
RETURN_CODE_ERROR
Value ofKEY_RETURN_CODE
when an error is encountered during schema generation.static int
RETURN_CODE_OK
Value ofKEY_RETURN_CODE
when the schema generation is successful.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.Object>
generate(java.lang.String encoding, java.lang.String locale, java.lang.String productExt)
Creates a local XML file containing the server feature list, generated with the given options.
-
-
-
Field Detail
-
OBJECT_NAME
static final java.lang.String OBJECT_NAME
A String representing theObjectName
that this MBean maps to.- See Also:
- Constant Field Values
-
KEY_OUTPUT
static final java.lang.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:
- Constant Field Values
-
KEY_RETURN_CODE
static final java.lang.String KEY_RETURN_CODE
Key for the return code of the feature list generation. The value is an integer that will be eitherRETURN_CODE_OK
orRETURN_CODE_ERROR
.- See Also:
- Constant Field Values
-
KEY_FILE_PATH
static final java.lang.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:
- Constant Field Values
-
RETURN_CODE_OK
static final int RETURN_CODE_OK
Value ofKEY_RETURN_CODE
when the schema generation is successful.- See Also:
- Constant Field Values
-
RETURN_CODE_ERROR
static final int RETURN_CODE_ERROR
Value ofKEY_RETURN_CODE
when an error is encountered during schema generation.- See Also:
- Constant Field Values
-
-
Method Detail
-
generate
java.util.Map<java.lang.String,java.lang.Object> generate(java.lang.String encoding, java.lang.String locale, java.lang.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
, andKEY_FILE_PATH
-
-