com.im.df.api 5.9

com.im.df.api.capabilities
Interface IJCUserLoginService

All Superinterfaces:
DFCapability, SchemaServiceCapability
All Known Subinterfaces:
IJCUserLoginServiceAdmin

public interface IJCUserLoginService
extends SchemaServiceCapability

This capability can be obtained from schema if user has sufficient access rights.


Method Summary
 List<DFUserLoginInfo> getAllLogins()
          Get the login states for all users of the system.
 DFUserLoginInfo getLogin(String username)
          Get the login state for the specified user.
 GrantedAuthority[] getMyRoles()
          Get the roles for the current user.
 String whoAmI()
          Return my login name.
 

Method Detail

whoAmI

String whoAmI()
Return my login name.


getMyRoles

GrantedAuthority[] getMyRoles()
Get the roles for the current user.

Returns:
The roles the user has. Never returns null.

getAllLogins

@Secured(value={"ROLE_USER","ROLE_EDIT_DATA","ROLE_EDIT_SCHEMA","ROLE_ADMIN"})
@Transactional(readOnly=true)
List<DFUserLoginInfo> getAllLogins()
Get the login states for all users of the system.

Returns:
The list of all usernames. Never returns null

getLogin

@Secured(value={"ROLE_USER","ROLE_EDIT_DATA","ROLE_EDIT_SCHEMA","ROLE_ADMIN"})
@Transactional(readOnly=true)
DFUserLoginInfo getLogin(String username)
Get the login state for the specified user.

Parameters:
username - The user
Returns:
The user login info for the specified user
Throws:
IllegalArgumentException - if the specified user is not a user of this schema e.g they don't have an entry in the ijc_user table

com.im.df.api 5.9