Package com.im.df.api.capabilities
Interface IJCUserLoginServiceAdmin
-
- All Superinterfaces:
DFCapability
,IJCUserLoginService
,SchemaServiceCapability
public interface IJCUserLoginServiceAdmin extends IJCUserLoginService
This capability can be obtained from DFSchema if user has sufficient access rights (probably must be admin).- Author:
- Tim Dudgeon
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addUserIfAbsent(java.lang.String userName)
Checks whether a record exists in IJC_USER table for the user identified byuserName
parameter and if the record doesn't exist new one will be inserted.com.im.ijcs.api.util.DFUser
authenticateUser(org.springframework.security.core.Authentication token)
Authenticate user with given authentication token.void
deleteSecurityConfig(com.im.commons.progress.DFEnvironmentRW env)
Remove the security configuration and reset to the defaultcom.im.commons.progress.DFLockable
getLockable()
Get special lockable for this capability.DFServiceConfiguration
getSecurityConfig()
Get the security configuration.DFServiceConfiguration[]
getSecurityConfigTemplates()
Get the available templates for security configurationboolean
isUsingDbAuthentication()
Checks if the user has set his security to be authenticated by DB login.void
logoutUser(java.lang.String username)
Logout the specified user (means kill his connection).void
updateSecurityConfig(DFServiceConfiguration config, com.im.commons.progress.DFEnvironmentRW env)
Update the security configuration.-
Methods inherited from interface com.im.df.api.capabilities.IJCUserLoginService
findCurrentDDLLockOwner, getAllLogins, getLogin, getMe, getMyRoles, whoAmI
-
-
-
-
Method Detail
-
getLockable
com.im.commons.progress.DFLockable getLockable()
Get special lockable for this capability. It must be used when calling user security config methods from this interface
-
logoutUser
@Secured("ROLE_ADMIN") @Transactional(readOnly=false) void logoutUser(java.lang.String username)
Logout the specified user (means kill his connection).- Parameters:
username
-
-
getSecurityConfig
@Secured("ROLE_ADMIN") @Transactional(readOnly=true) DFServiceConfiguration getSecurityConfig()
Get the security configuration. This can be edited to change the way users login and other aspects of security.
-
deleteSecurityConfig
@Secured("ROLE_ADMIN") @Transactional void deleteSecurityConfig(com.im.commons.progress.DFEnvironmentRW env)
Remove the security configuration and reset to the default
-
updateSecurityConfig
@Secured("ROLE_ADMIN") @Transactional void updateSecurityConfig(DFServiceConfiguration config, com.im.commons.progress.DFEnvironmentRW env)
Update the security configuration.
-
getSecurityConfigTemplates
DFServiceConfiguration[] getSecurityConfigTemplates()
Get the available templates for security configuration
-
authenticateUser
@Secured("ROLE_ADMIN") com.im.ijcs.api.util.DFUser authenticateUser(org.springframework.security.core.Authentication token) throws org.springframework.security.authentication.BadCredentialsException
Authenticate user with given authentication token. This method does not log in the user in the meaning of creating a record in IJC_USER table. This method is intended to be used from the server. The server is then responsible for managing its state of logged-in users.- Parameters:
token
- authentication token understood by one of authentication providers defined in current security configuration- Returns:
- authenticated user
- Throws:
org.springframework.security.authentication.BadCredentialsException
- when the user can't be authenticated
-
addUserIfAbsent
@Secured("ROLE_ADMIN") void addUserIfAbsent(java.lang.String userName)
Checks whether a record exists in IJC_USER table for the user identified byuserName
parameter and if the record doesn't exist new one will be inserted.- Parameters:
userName
- user name of user to be inserted to IJC_USER table- Since:
- 14.9.22
-
isUsingDbAuthentication
boolean isUsingDbAuthentication()
Checks if the user has set his security to be authenticated by DB login. The method was introduced due to Connect, which need to know this information.- Returns:
- boolean if the user is or isn't using the DB authentication
- Since:
- 19.8.0
-
-