Package 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.

Author:

Tim Dudgeon

Method Summary

Modifier and Type	Method	Description
java.lang.String	findCurrentDDLLockOwner()
java.util.List<DFUserLoginInfo>	getAllLogins()	Get the login states for all users of the system.
DFUserLoginInfo	getLogin(java.lang.String username)	Gets the login state for the specified user.
com.im.ijcs.api.util.DFUser	getMe()
org.springframework.security.core.GrantedAuthority[]	getMyRoles()	Get the roles for the current user.
java.lang.String	whoAmI()

Method Detail

whoAmI

java.lang.String whoAmI()

Returns:

my login name. This is a shorthand for getMe().getUsername().

getMe

com.im.ijcs.api.util.DFUser getMe()

Returns:

my user object.

getMyRoles

org.springframework.security.core.GrantedAuthority[] getMyRoles()

Get the roles for the current user. This has similar effect to getMe().getRoles().

Returns:

The roles the user has. Never returns null.

getAllLogins

@Secured({"ROLE_USER","ROLE_EDIT_DATA","ROLE_EDIT_SCHEMA","ROLE_ADMIN","ROLE_EXPORT_DATA","ROLE_EDIT_SCRIPT"})
@Transactional(readOnly=true)
java.util.List<DFUserLoginInfo> getAllLogins()

Get the login states for all users of the system.

Returns:

The list of all usernames. Never returns null

getLogin

@Secured({"ROLE_USER","ROLE_EDIT_DATA","ROLE_EDIT_SCHEMA","ROLE_ADMIN","ROLE_EXPORT_DATA","ROLE_EDIT_SCRIPT"})
@Transactional(readOnly=true)
DFUserLoginInfo getLogin(java.lang.String username)

Gets the login state for the specified user.

Parameters:

username - The username.

Returns:

The user login info or null if the requested user has never before used the IJC schema controlled by this service.

findCurrentDDLLockOwner

@Secured({"ROLE_USER","ROLE_EDIT_DATA","ROLE_EDIT_SCHEMA","ROLE_ADMIN","ROLE_EXPORT_DATA","ROLE_EDIT_SCRIPT"})
@Transactional(readOnly=true)
java.lang.String findCurrentDDLLockOwner()