public interface ServerSchemaGenerator
The ObjectName for this MBean is "WebSphere:name=com.ibm.ws.config.serverSchemaGenerator".
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
KEY_FILE_PATH
Key for the file path of the generated schema.
|
static java.lang.String |
KEY_OUTPUT
Key for the merged (systemOut and systemErr) output of the schema generation.
|
static java.lang.String |
KEY_RETURN_CODE
Key for the return code of the schema generation.
|
static java.lang.String |
OBJECT_NAME
A String representing the
javax.management.ObjectName that this MXBean maps to. |
static int |
RETURN_CODE_ERROR
Value of
KEY_RETURN_CODE when an error is encountered during schema generation. |
static int |
RETURN_CODE_OK
Value of
KEY_RETURN_CODE when the schema generation is successful. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
generate()
Generates a schema for the current runtime bundles.
|
java.util.Map<java.lang.String,java.lang.Object> |
generateInstallSchema(java.lang.String schemaVersion,
java.lang.String outputVersion,
java.lang.String encoding,
java.lang.String locale)
Creates a local file containing a schema for the installed features, generated with the given options.
|
java.util.Map<java.lang.String,java.lang.Object> |
generateServerSchema(java.lang.String schemaVersion,
java.lang.String outputVersion,
java.lang.String encoding,
java.lang.String locale)
Creates a local file containing a schema for the current runtime bundles, generated with the given options.
|
static final java.lang.String OBJECT_NAME
javax.management.ObjectName
that this MXBean maps to.static final java.lang.String KEY_RETURN_CODE
RETURN_CODE_OK
or RETURN_CODE_ERROR
.static final java.lang.String KEY_OUTPUT
static final java.lang.String KEY_FILE_PATH
static final int RETURN_CODE_OK
KEY_RETURN_CODE
when the schema generation is successful.static final int RETURN_CODE_ERROR
KEY_RETURN_CODE
when an error is encountered during schema generation.java.lang.String generate()
generateInstallSchema(String, String, String, String)
.java.util.Map<java.lang.String,java.lang.Object> generateServerSchema(java.lang.String schemaVersion, java.lang.String outputVersion, java.lang.String encoding, java.lang.String locale)
schemaVersion
- a string that indicates the schema version of the generated schemaoutputVersion
- a string that indicates the output version of the generated schemaencoding
- a string that indicates the encoding to be used during generationlocale
- a string that indicates the locale to be used during generationKEY_RETURN_CODE
, KEY_OUTPUT
and KEY_FILE_PATH
java.util.Map<java.lang.String,java.lang.Object> generateInstallSchema(java.lang.String schemaVersion, java.lang.String outputVersion, java.lang.String encoding, java.lang.String locale)
schemaVersion
- a string that indicates the schema version of the generated schemaoutputVersion
- a string that indicates the output version of the generated schemaencoding
- a string that indicates the encoding to be used during generationlocale
- a string that indicates the locale to be used during generationKEY_RETURN_CODE
, KEY_OUTPUT
and KEY_FILE_PATH