Interface DDLGenerationMBean
-
public interface DDLGenerationMBean
The DDLGenerationMBean provides an interface which can be used to generate DDL for WebSphere Liberty Profile features which use the persistence service.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FILE_COUNT
Key returned by the generateDDL function, which describes the number of DDL files written by the MBean.static java.lang.String
OBJECT_NAME
A String representing theObjectName
that this MBean maps to.static java.lang.String
OUTPUT_DIRECTORY
Key returned by the generateDDL function, which describes the path in the file system where the DDL files were written.static java.lang.String
SUCCESS
Key returned by the generateDDL function, which describes the overall success of the function.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.io.Serializable>
generateDDL()
Generate DDL for all features which use the persistence service to persist data to a database.
-
-
-
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
-
OUTPUT_DIRECTORY
static final java.lang.String OUTPUT_DIRECTORY
Key returned by the generateDDL function, which describes the path in the file system where the DDL files were written. The value of this key is a java.lang.String.- See Also:
- Constant Field Values
-
FILE_COUNT
static final java.lang.String FILE_COUNT
Key returned by the generateDDL function, which describes the number of DDL files written by the MBean. A value of zero indicates that nothing was written. The value of this key is a java.lang.Integer.- See Also:
- Constant Field Values
-
SUCCESS
static final java.lang.String SUCCESS
Key returned by the generateDDL function, which describes the overall success of the function. The value of this key is a java.lang.Boolean. A value of TRUE indicates that the function completed successfully. A value of FALSE indicates that the function did not complete successfully. Exceptions or FFDC entries may be found in the server's logs.- See Also:
- Constant Field Values
-
-
Method Detail
-
generateDDL
java.util.Map<java.lang.String,java.io.Serializable> generateDDL()
Generate DDL for all features which use the persistence service to persist data to a database. One file will be written for each user of the persistence service. The files will be written to a directory in the file system named ${server.output.dir}/ddl. The name of each file will be the config.displayId for the service generating the DDL.- Returns:
- A map of key/value pairs describing the results of the command. The map will include the following keys: DDLGenerationMBean.OUTPUT_DIRECTORY DDLGenerationMBean.SUCCESS
-
-