org.flowable.idm.api

Interface IdmManagementService

public interface IdmManagementService

Service for admin and maintenance operations on the idm engine. These operations will typically not be used in a workflow driven application, but are used in for example the operational console.

Author:

Tijs Rademakers

Method Summary

Modifier and Type	Method and Description
TablePageQuery	createTablePageQuery() Creates a TablePageQuery that can be used to fetch TablePage containing specific sections of table row data.
String	databaseSchemaUpgrade(Connection connection, String catalog, String schema) programmatic schema update on a given connection returning feedback about what happened
Map<String,String>	getProperties() get the list of properties.
Map<String,Long>	getTableCount() Get the mapping containing {table name, row count} entries of the database schema.
TableMetaData	getTableMetaData(String tableName) Gets the metadata (column names, column types, etc.) of a certain table.
String	getTableName(Class<?> idmEntityClass) Gets the table name (including any configured prefix) for an entity.

Method Detail

getTableCount

Map<String,Long> getTableCount()

Get the mapping containing {table name, row count} entries of the database schema.

getTableName

String getTableName(Class<?> idmEntityClass)

Gets the table name (including any configured prefix) for an entity.

getTableMetaData

TableMetaData getTableMetaData(String tableName)

Gets the metadata (column names, column types, etc.) of a certain table. Returns null when no table exists with the given name.

createTablePageQuery

TablePageQuery createTablePageQuery()

Creates a TablePageQuery that can be used to fetch TablePage containing specific sections of table row data.

getProperties

Map<String,String> getProperties()

get the list of properties.

databaseSchemaUpgrade

String databaseSchemaUpgrade(Connection connection,
                             String catalog,
                             String schema)

programmatic schema update on a given connection returning feedback about what happened