| Package | Description |
|---|---|
| org.activiti.engine |
Public API of the Flowable version 5 engine.
It is highly recommended that the version 6 engine be used instead of the version 5 engine. Typical usage of the API starts by the creation of a ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine can be obtained.Through the services obtained from such a ProcessEngine, BPM and workflow operation
can be executed:RepositoryService: Manages Deployments.RuntimeService: For starting and searching org.activiti5.engine.runtime.ProcessInstances.TaskService: Exposes operations to manage human (standalone) Tasks,
such as claiming, completing and assigning tasks.IdentityService: Used for managing Users,
org.flowable.idm.api.identity.Groups and the relations between them.ManagementService: Exposes engine administration and maintenance operations,
which have no relation to the runtime exection of business processes.HistoryService: Exposes information about ongoing and past process instances.FormService: Access to form data and rendered forms for starting new process instances and completing tasks. |
| org.activiti.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.flowable.engine |
Public API of the Flowable engine.
Typical usage of the API starts by the creation of a ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine can be obtained.Through the services obtained from such a ProcessEngine, BPM and workflow operation
can be executed:RepositoryService: Manages Deployments.RuntimeService: For starting and searching ProcessInstances.TaskService: Exposes operations to manage human (standalone) tasks, such as claiming, completing and assigning tasks.IdentityService: Used for managing users, groups and the relations between them.ManagementService: Exposes engine administration and maintenance operations,
which have no relation to the runtime exection of business processes.HistoryService: Exposes information about ongoing and past process instances.FormService: Access to form data and rendered forms for starting new process instances and completing tasks. |
| org.flowable.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.flowable.engine.impl.cmd | |
| org.flowable.idm.api | |
| org.flowable.idm.engine.impl | |
| org.flowable.idm.engine.impl.cmd | |
| org.flowable.idm.engine.impl.persistence.entity | |
| org.flowable.idm.engine.impl.persistence.entity.data | |
| org.flowable.idm.engine.impl.persistence.entity.data.impl | |
| org.flowable.idm.rest.service.api | |
| org.flowable.idm.rest.service.api.user | |
| org.flowable.ldap | |
| org.flowable.ldap.impl | |
| org.flowable.rest.conf | |
| org.flowable.rest.service.api | |
| org.flowable.rest.service.api.identity | |
| org.flowable.spring.security | |
| org.flowable.ui.common.model | |
| org.flowable.ui.common.service.idm.cache | |
| org.flowable.ui.idm.conf | |
| org.flowable.ui.idm.model | |
| org.flowable.ui.idm.rest.app | |
| org.flowable.ui.idm.service | |
| org.flowable.ui.idm.service.keycloak | |
| org.flowable.ui.modeler.service | |
| org.flowable.ui.modeler.serviceapi | |
| org.flowable.ui.task.model.runtime | |
| org.flowable.ui.task.rest.idm | |
| org.flowable.ui.task.service.api |
| Modifier and Type | Method and Description |
|---|---|
User |
IdentityService.newUser(String userId)
Creates a new user.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IdentityService.saveUser(User user)
Saves the user.
|
void |
IdentityService.updateUserPassword(User user)
Update user password.
|
| Modifier and Type | Method and Description |
|---|---|
User |
IdentityServiceImpl.newUser(String userId) |
| Modifier and Type | Method and Description |
|---|---|
void |
IdentityServiceImpl.saveUser(User user) |
void |
IdentityServiceImpl.updateUserPassword(User user) |
| Modifier and Type | Method and Description |
|---|---|
User |
IdentityService.newUser(String userId)
Creates a new user.
|
| Modifier and Type | Method and Description |
|---|---|
List<User> |
IdentityService.getPotentialStarterUsers(String processDefinitionId)
Returns the potential starter users for a given process definition.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IdentityService.saveUser(User user)
Saves the user.
|
void |
IdentityService.updateUserPassword(User user)
Update user password.
|
| Modifier and Type | Method and Description |
|---|---|
User |
IdentityServiceImpl.newUser(String userId) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
IdentityServiceImpl.getPotentialStarterUsers(String processDefinitionId) |
| Modifier and Type | Method and Description |
|---|---|
void |
IdentityServiceImpl.saveUser(User user) |
void |
IdentityServiceImpl.updateUserPassword(User user) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
GetPotentialStarterUsersCmd.execute(CommandContext commandContext) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
UserBaseQuery<T extends UserBaseQuery<T,U>,U extends User>
Allows programmatic querying of
User |
| Modifier and Type | Method and Description |
|---|---|
User |
IdmIdentityService.newUser(String userId)
Creates a new user.
|
| Modifier and Type | Method and Description |
|---|---|
List<User> |
IdmIdentityService.getUsersWithPrivilege(String privilegeId)
Returns all
User instances that have a particular privilege. |
| Modifier and Type | Method and Description |
|---|---|
void |
IdmIdentityService.saveUser(User user)
Saves the user.
|
void |
IdmIdentityService.updateUserPassword(User user)
Update user password.
|
| Modifier and Type | Method and Description |
|---|---|
User |
IdmIdentityServiceImpl.newUser(String userId) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
UserQueryImpl.executeList(CommandContext commandContext) |
List<User> |
NativeUserQueryImpl.executeList(CommandContext commandContext,
Map<String,Object> parameterMap) |
List<User> |
IdmIdentityServiceImpl.getUsersWithPrivilege(String name) |
| Modifier and Type | Method and Description |
|---|---|
void |
IdmIdentityServiceImpl.saveUser(User user) |
void |
IdmIdentityServiceImpl.updateUserPassword(User user) |
| Modifier and Type | Field and Description |
|---|---|
protected User |
SaveUserCmd.user |
| Modifier and Type | Method and Description |
|---|---|
User |
CreateUserCmd.execute(CommandContext commandContext) |
User |
UpdateUserPasswordCmd.execute(CommandContext commandContext) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
GetUsersWithPrivilegeCmd.execute(CommandContext commandContext) |
| Constructor and Description |
|---|
SaveUserCmd(User user,
IdmEngineConfiguration idmEngineConfiguration) |
UpdateUserPasswordCmd(User user) |
| Modifier and Type | Interface and Description |
|---|---|
interface |
UserEntity |
| Modifier and Type | Class and Description |
|---|---|
class |
UserEntityImpl |
| Modifier and Type | Method and Description |
|---|---|
User |
UserEntityManagerImpl.createNewUser(String userId) |
User |
UserEntityManager.createNewUser(String userId) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
UserEntityManagerImpl.findUserByQueryCriteria(UserQueryImpl query) |
List<User> |
UserEntityManager.findUserByQueryCriteria(UserQueryImpl query) |
List<User> |
UserEntityManagerImpl.findUsersByNativeQuery(Map<String,Object> parameterMap) |
List<User> |
UserEntityManager.findUsersByNativeQuery(Map<String,Object> parameterMap) |
List<User> |
UserEntityManagerImpl.findUsersByPrivilegeId(String name) |
List<User> |
UserEntityManager.findUsersByPrivilegeId(String privilegeId) |
| Modifier and Type | Method and Description |
|---|---|
void |
UserEntityManagerImpl.deletePicture(User user) |
void |
UserEntityManager.deletePicture(User user) |
Picture |
UserEntityManagerImpl.getUserPicture(User user) |
Picture |
UserEntityManager.getUserPicture(User user) |
boolean |
UserEntityManagerImpl.isNewUser(User user) |
boolean |
UserEntityManager.isNewUser(User user) |
void |
UserEntityManagerImpl.setUserPicture(User user,
Picture picture) |
void |
UserEntityManager.setUserPicture(User user,
Picture picture) |
void |
UserEntityManagerImpl.updateUser(User updatedUser) |
void |
UserEntityManager.updateUser(User updatedUser) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
UserDataManager.findUserByQueryCriteria(UserQueryImpl query) |
List<User> |
UserDataManager.findUsersByNativeQuery(Map<String,Object> parameterMap) |
List<User> |
UserDataManager.findUsersByPrivilegeId(String privilegeId) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
MybatisUserDataManager.findUserByQueryCriteria(UserQueryImpl query) |
List<User> |
MybatisUserDataManager.findUsersByNativeQuery(Map<String,Object> parameterMap) |
List<User> |
MybatisUserDataManager.findUsersByPrivilegeId(String privilegeId) |
| Modifier and Type | Method and Description |
|---|---|
void |
IdmRestApiInterceptor.accessUserInfoById(User user) |
void |
IdmRestApiInterceptor.createNewUser(User user) |
UserResponse |
IdmRestResponseFactory.createUserResponse(User user,
boolean incudePassword) |
UserResponse |
IdmRestResponseFactory.createUserResponse(User user,
boolean incudePassword,
RestUrlBuilder urlBuilder) |
void |
IdmRestApiInterceptor.deleteUser(User user) |
| Modifier and Type | Method and Description |
|---|---|
PrivilegeResponse |
IdmRestResponseFactory.createPrivilegeResponse(Privilege privilege,
List<User> users,
List<Group> groups) |
List<UserResponse> |
IdmRestResponseFactory.createUserResponseList(List<User> users) |
List<UserResponse> |
IdmRestResponseFactory.createUserResponseList(List<User> users,
boolean incudePassword) |
| Modifier and Type | Method and Description |
|---|---|
protected User |
UserResource.getUserFromRequest(String userId) |
| Modifier and Type | Method and Description |
|---|---|
User |
LDAPIdentityServiceImpl.newUser(String userId) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
LDAPIdentityServiceImpl.getUsersWithPrivilege(String name) |
| Modifier and Type | Method and Description |
|---|---|
void |
LDAPIdentityServiceImpl.saveUser(User user) |
| Modifier and Type | Method and Description |
|---|---|
protected List<User> |
LDAPUserQueryImpl.executeAllUserQuery() |
List<User> |
LDAPUserQueryImpl.executeList(CommandContext commandContext) |
protected List<User> |
LDAPUserQueryImpl.executeNameQuery(String name) |
protected List<User> |
LDAPUserQueryImpl.executeQuery() |
protected List<User> |
LDAPUserQueryImpl.executeUsersQuery(String searchExpression) |
| Modifier and Type | Method and Description |
|---|---|
protected User |
BootstrapConfiguration.initRestAdmin() |
| Modifier and Type | Method and Description |
|---|---|
void |
BpmnRestApiInterceptor.accessUserInfoById(User user) |
UserResponse |
RestResponseFactory.createUserResponse(User user,
boolean includePassword) |
UserResponse |
RestResponseFactory.createUserResponse(User user,
boolean incudePassword,
RestUrlBuilder urlBuilder) |
void |
BpmnRestApiInterceptor.deleteUser(User user) |
| Modifier and Type | Method and Description |
|---|---|
List<UserResponse> |
RestResponseFactory.createUserResponseList(List<User> users) |
List<UserResponse> |
RestResponseFactory.createUserResponseList(List<User> users,
boolean includePassword) |
| Modifier and Type | Method and Description |
|---|---|
protected User |
BaseUserResource.getUserFromRequest(String userId) |
| Modifier and Type | Method and Description |
|---|---|
protected String |
UserInfoResource.getValidKeyFromRequest(User user,
String key) |
| Modifier and Type | Class and Description |
|---|---|
class |
UserDto
An immutable serializable implementation of
User. |
| Modifier and Type | Field and Description |
|---|---|
protected User |
FlowableUser.user |
| Modifier and Type | Method and Description |
|---|---|
User |
FlowableUserDetails.getUser()
The user object containing the information for the Flowable IDM User.
|
User |
FlowableUser.getUser() |
| Modifier and Type | Method and Description |
|---|---|
static UserDto |
UserDto.create(User user) |
protected FlowableUser |
FlowableUserDetailsService.createFlowableUser(User user) |
| Constructor and Description |
|---|
FlowableUser(User user,
boolean active,
List<? extends Group> groups,
Collection<? extends org.springframework.security.core.GrantedAuthority> authorities) |
FlowableUser(User user,
boolean active,
List<? extends Group> groups,
List<? extends Privilege> privileges,
Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)
Deprecated.
Privileges are no longer required use
FlowableUser(User, boolean, List, Collection) instead |
FlowableUser(User user,
String username,
boolean enabled,
List<? extends Group> groups,
Collection<? extends org.springframework.security.core.GrantedAuthority> authorities) |
| Modifier and Type | Class and Description |
|---|---|
class |
RemoteUser |
| Constructor and Description |
|---|
UserRepresentation(User user) |
| Modifier and Type | Method and Description |
|---|---|
User |
UserCache.CachedUser.getUser() |
| Constructor and Description |
|---|
CachedUser(User user,
Collection<org.springframework.security.core.GrantedAuthority> grantedAuthorities) |
| Modifier and Type | Method and Description |
|---|---|
protected User |
IdmBootstrapper.initializeAdminUser() |
| Modifier and Type | Field and Description |
|---|---|
protected User |
UserInformation.user |
| Modifier and Type | Method and Description |
|---|---|
User |
UserInformation.getUser() |
| Modifier and Type | Method and Description |
|---|---|
void |
UserInformation.setUser(User user) |
| Constructor and Description |
|---|
UserInformation(User user,
List<Group> groups,
List<String> privileges) |
| Modifier and Type | Method and Description |
|---|---|
protected List<UserRepresentation> |
IdmUsersResource.convertToUserRepresentations(List<User> users) |
| Modifier and Type | Method and Description |
|---|---|
User |
UserServiceImpl.createNewUser(String id,
String firstName,
String lastName,
String email,
String password) |
User |
UserService.createNewUser(String id,
String firstName,
String lastName,
String email,
String password) |
User |
UserServiceImpl.createNewUser(String id,
String firstName,
String lastName,
String email,
String password,
String tenantId) |
User |
UserService.createNewUser(String id,
String firstName,
String lastName,
String email,
String password,
String tenantId) |
User |
ProfileServiceImpl.updateProfile(String firstName,
String lastName,
String email) |
User |
ProfileService.updateProfile(String firstName,
String lastName,
String email) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
PrivilegeService.findUsersWithPrivilege(String privilegeId) |
List<User> |
PrivilegeServiceImpl.findUsersWithPrivilege(String privilegeId) |
List<User> |
GroupServiceImpl.getGroupUsers(String groupId,
String filter,
Integer page,
Integer pageSize) |
List<User> |
GroupService.getGroupUsers(String groupId,
String filter,
Integer page,
Integer pageSize) |
List<User> |
UserServiceImpl.getUsers(String filter,
String sort,
Integer start) |
List<User> |
UserService.getUsers(String filter,
String sort,
Integer start) |
| Modifier and Type | Method and Description |
|---|---|
User |
KeycloakIdentityServiceImpl.newUser(String userId) |
| Modifier and Type | Method and Description |
|---|---|
List<User> |
KeycloakUserQueryImpl.executeList(CommandContext commandContext) |
List<User> |
KeycloakIdentityServiceImpl.getUsersWithPrivilege(String name) |
| Modifier and Type | Method and Description |
|---|---|
void |
KeycloakIdentityServiceImpl.saveUser(User user) |
| Modifier and Type | Method and Description |
|---|---|
List<AppDefinitionServiceRepresentation> |
AppDefinitionServiceImpl.getDeployableAppDefinitions(User user)
Gathers all 'deployable' app definitions for the current user.
|
| Modifier and Type | Method and Description |
|---|---|
List<AppDefinitionServiceRepresentation> |
AppDefinitionService.getDeployableAppDefinitions(User user) |
| Constructor and Description |
|---|
CaseInstanceRepresentation(CaseInstance caseInstance,
boolean graphicalNotation,
User startedBy) |
CaseInstanceRepresentation(CaseInstance caseInstance,
CaseDefinition caseDefinition,
boolean graphicalNotation,
User startedBy) |
CaseInstanceRepresentation(HistoricCaseInstance caseInstance,
boolean graphicalNotation,
User startedBy) |
CaseInstanceRepresentation(HistoricCaseInstance caseInstance,
CaseDefinition caseDefinition,
boolean graphicalNotation,
User startedBy) |
ProcessInstanceRepresentation(HistoricProcessInstance processInstance,
boolean graphicalNotation,
User startedBy) |
ProcessInstanceRepresentation(HistoricProcessInstance processInstance,
ProcessDefinition processDefinition,
boolean graphicalNotation,
User startedBy) |
ProcessInstanceRepresentation(ProcessInstance processInstance,
boolean graphicalNotation,
User startedBy) |
ProcessInstanceRepresentation(ProcessInstance processInstance,
ProcessDefinition processDefinition,
boolean graphicalNotation,
User startedBy) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
WorkflowUsersResource.filterUsersInvolvedInProcess(String excludeProcessId,
List<? extends User> matchingUsers) |
protected void |
WorkflowUsersResource.filterUsersInvolvedInTask(String excludeTaskId,
List<? extends User> matchingUsers) |
protected void |
WorkflowUsersResource.removeinvolvedUsers(List<? extends User> matchingUsers,
Set<String> involvedUsers) |
| Modifier and Type | Method and Description |
|---|---|
List<AppDefinitionServiceRepresentation> |
AppDefinitionService.getDeployableAppDefinitions(User user) |
Copyright © 2023 Flowable. All rights reserved.