com.ibm.di.api.local
Interface SecurityRegistry

All Known Implementing Classes:
SecurityRegistryImpl

public interface SecurityRegistry

This interface provides information about various restrictions a user may have. It lets you query what rights a user is granted and whether he/she is authorized to execute a specific action.


Method Summary
 boolean userCanExecuteAL(String aUserId, String aConfigId, String aAssemblyLine)
          Returns whether specified user is allowed to execute given AL from a given configuration.
 boolean userCanExecuteAll(String aUserId)
          Returns whether specified user is allowed to execute everything.
 boolean userCanExecuteConfig(String aUserId, String aConfigId)
          Returns whether specified user is allowed to execute given configuration.
 boolean userCanExecuteConfigALs(String aUserId, String aConfigId)
          Returns whether specified user is allowed to execute assembly lines from a given configuration.
 boolean userCanReadAll(String aUserId)
          Returns whether specified user is allowed to read everything.
 boolean userCanReadConfig(String aUserId, String aConfigId)
          Returns whether specified user is allowed to read given configuration.
 boolean userIsAdmin(String aUserId)
          Returns whether specified user is granted admin role.
 

Method Detail

userIsAdmin

boolean userIsAdmin(String aUserId)
                    throws DIException
Returns whether specified user is granted admin role.

Parameters:
aUserId - the id of the user
Returns:
true if the user is granted the admin role
Throws:
DIException - if Runtime or Security exception occurs

userCanReadConfig

boolean userCanReadConfig(String aUserId,
                          String aConfigId)
                          throws DIException
Returns whether specified user is allowed to read given configuration.

Parameters:
aUserId - the id of the user
aConfigId - the id of the configuration
Returns:
return true only if aUserId is allowed to read aConfigId.
Throws:
DIException - if Runtime or Security exception occurs

userCanExecuteAL

boolean userCanExecuteAL(String aUserId,
                         String aConfigId,
                         String aAssemblyLine)
                         throws DIException
Returns whether specified user is allowed to execute given AL from a given configuration.

Parameters:
aUserId - the id of the user
aConfigId - the id of the configuration
aAssemblyLine - the name of the assembly line
Returns:
return true only if aUserId is allowed to execute aAssemblyLine from configuration aConfigId.
Throws:
DIException - if Runtime or Security exception occurs

userCanExecuteConfig

boolean userCanExecuteConfig(String aUserId,
                             String aConfigId)
                             throws DIException
Returns whether specified user is allowed to execute given configuration.

Parameters:
aUserId - the id of the user
aConfigId - the id of the configuration
Returns:
return true only if aUserId is allowed to execute configuration aConfigId.
Throws:
DIException - if Runtime or Security exception occurs

userCanExecuteConfigALs

boolean userCanExecuteConfigALs(String aUserId,
                                String aConfigId)
                                throws DIException
Returns whether specified user is allowed to execute assembly lines from a given configuration.

Parameters:
aUserId - the id of the user
aConfigId - the id of the configuration
Returns:
return true only if aUserId is allowed to execute assembly lines from configuration aConfigId.
Throws:
DIException - if Runtime or Security exception occurs

userCanExecuteAll

boolean userCanExecuteAll(String aUserId)
                          throws DIException
Returns whether specified user is allowed to execute everything.

Parameters:
aUserId - the id of the user
Returns:
return true only if aUserId is allowed to execute everything.
Throws:
DIException - if Runtime or Security exception occurs

userCanReadAll

boolean userCanReadAll(String aUserId)
                       throws DIException
Returns whether specified user is allowed to read everything.

Parameters:
aUserId - the id of the user
Returns:
return true only if aUserId is allowed to read everything.
Throws:
DIException - if Runtime or Security exception occurs