Package com.ibm.websphere.config.mbeans
Interface ServerSchemaGenerator
-
public interface ServerSchemaGeneratorThis MBean allows callers to generate the schema pertaining to server.xml.The ObjectName for this MBean is "WebSphere:name=com.ibm.ws.config.serverSchemaGenerator".
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringKEY_FILE_PATHKey for the file path of the generated schema.static java.lang.StringKEY_OUTPUTKey for the merged (systemOut and systemErr) output of the schema generation.static java.lang.StringKEY_RETURN_CODEKey for the return code of the schema generation.static java.lang.StringOBJECT_NAMEA String representing theObjectNamethat this MXBean maps to.static intRETURN_CODE_ERRORValue ofKEY_RETURN_CODEwhen an error is encountered during schema generation.static intRETURN_CODE_OKValue ofKEY_RETURN_CODEwhen the schema generation is successful.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Stringgenerate()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>generateInstallSchema(java.lang.String schemaVersion, java.lang.String outputVersion, java.lang.String encoding, java.lang.String locale, boolean compactOutput)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.
-
-
-
Field Detail
-
OBJECT_NAME
static final java.lang.String OBJECT_NAME
A String representing theObjectNamethat this MXBean maps to.- See Also:
- Constant Field Values
-
KEY_RETURN_CODE
static final java.lang.String KEY_RETURN_CODE
Key for the return code of the schema generation. The value is an integer that will be eitherRETURN_CODE_OKorRETURN_CODE_ERROR.- See Also:
- Constant Field Values
-
KEY_OUTPUT
static final java.lang.String KEY_OUTPUT
Key for the merged (systemOut and systemErr) output of the schema generation. The value is a java.lang.String- See Also:
- Constant Field Values
-
KEY_FILE_PATH
static final java.lang.String KEY_FILE_PATH
Key for the file path of the generated schema. The value is a java.lang.String and represents the absolute location of the generated schema in the server's file system.- See Also:
- Constant Field Values
-
RETURN_CODE_OK
static final int RETURN_CODE_OK
Value ofKEY_RETURN_CODEwhen the schema generation is successful.- See Also:
- Constant Field Values
-
RETURN_CODE_ERROR
static final int RETURN_CODE_ERROR
Value ofKEY_RETURN_CODEwhen an error is encountered during schema generation.- See Also:
- Constant Field Values
-
-
Method Detail
-
generate
java.lang.String generate()
Generates a schema for the current runtime bundles. This is often not the desired output, since it only includes the currently load bundles. Users that are interested in the schema for the full set of installed features should usegenerateInstallSchema(String, String, String, String).- Returns:
- a String containing the generated schema for the current runtime.
-
generateServerSchema
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. 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:
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 generation- Returns:
- a map containing keys
KEY_RETURN_CODE,KEY_OUTPUTandKEY_FILE_PATH
-
generateInstallSchema
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. 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:
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 generation- Returns:
- a map containing keys
KEY_RETURN_CODE,KEY_OUTPUTandKEY_FILE_PATH
-
generateInstallSchema
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, boolean compactOutput)Creates a local file containing a schema for the installed features, 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:
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 generationcompactOutput- a boolean value that indicates if the schema output will contain any indenting white spaces, new line feeds or XML comments- Returns:
- a map containing keys
KEY_RETURN_CODE,KEY_OUTPUTandKEY_FILE_PATH
-
-