com.retek.rsm.app.security.service
Interface SecurityService

All Superinterfaces:
com.retek.platform.service.Service
All Known Implementing Classes:
SecurityServiceEjb

public interface SecurityService
extends com.retek.platform.service.Service

The external security API. This interface should be used by clients of RSM to perform security operations.


Field Summary
static long serialVersionUID
           
 
Method Summary
 void authenticate(com.retek.platform.service.ClientContext context, java.lang.String userName, EncryptedTextVo encryptedPassword)
          Authenticate a username and encrypted password against a system defined service.
 void authenticate(com.retek.platform.service.ClientContext context, java.lang.String userName, com.retek.platform.util.type.security.UserSignature signature)
          Authenticate a userSignature.
 java.util.Map findDataPermissions(com.retek.platform.service.ClientContext clientContext, java.util.Set userVos, com.retek.platform.app.security.service.Application applicationName)
          Retrieve a map of users to data permissions.
 java.util.Set findUserVos(com.retek.platform.service.ClientContext context, UserSearchCriteria criteria)
          Find a collection of users based on the UserSearchCriteria.
 java.util.Set findUserVosWithPermissions(com.retek.platform.service.ClientContext clientContext, java.util.Set permissions, com.retek.platform.app.security.service.Application applicationName)
          Retrieve a set of users given a set of permissions
 boolean isUserNameValid(com.retek.platform.service.ClientContext context, java.lang.String userName)
          Validates that the userName is a valid user name on the authentication system.
 LoginCredentialsVo login(com.retek.platform.service.ClientContext context, java.lang.String userName, EncryptedTextVo encryptedPassword, com.retek.platform.app.security.service.Application application, PublicKeyEncryptionStrategyVo appLaunchParameterPasswordEncryptionKey)
          Authenticate a username and enrypted password against a system defined service and retrieve user information.
 LoginCredentialsVo login(com.retek.platform.service.ClientContext clientContext, java.lang.String userName, com.retek.platform.util.type.security.UserSignature signature, com.retek.platform.app.security.service.Application application)
          Authenticate a username and signature and retrieve user information.
 LoginCredentialsWithContentModelVo loginAndGetContentModel(com.retek.platform.service.ClientContext context, java.lang.String userName, EncryptedTextVo encryptedPassword, com.retek.platform.app.security.service.Application application)
          Authenticate a username and encrypted password, retrieve user information and fetch the secure content model.
 LoginCredentialsWithContentModelVo loginAndGetContentModel(com.retek.platform.service.ClientContext clientContext, java.lang.String userName, com.retek.platform.util.type.security.UserSignature signature, com.retek.platform.app.security.service.Application application)
          Authenticate a username and signature, retrieve user information and fetch the secure content model.
 PublicKeyEncryptionStrategyVo retrievePublicKeyEncryptionStrategy(com.retek.platform.service.ClientContext context)
          Gets the public key encryption strategy value object.
 
Methods inherited from interface com.retek.platform.service.Service
attachFallbackHandler
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Method Detail

authenticate

public void authenticate(com.retek.platform.service.ClientContext context,
                         java.lang.String userName,
                         EncryptedTextVo encryptedPassword)
                  throws AuthenticationFailedException
Authenticate a username and encrypted password against a system defined service.

Throws:
Throws - an AuthenticationFailedException if the username/password combination is invalid or a LockedUserAccountException if the user account is locked.
AuthenticationFailedException

authenticate

public void authenticate(com.retek.platform.service.ClientContext context,
                         java.lang.String userName,
                         com.retek.platform.util.type.security.UserSignature signature)
                  throws AuthenticationFailedException
Authenticate a userSignature.

Throws:
Throws - an AuthenticationFailedException if the UserSignature is invalid or a LockedUserAccountException if the user account has been locked.
AuthenticationFailedException

login

public LoginCredentialsVo login(com.retek.platform.service.ClientContext context,
                                java.lang.String userName,
                                EncryptedTextVo encryptedPassword,
                                com.retek.platform.app.security.service.Application application,
                                PublicKeyEncryptionStrategyVo appLaunchParameterPasswordEncryptionKey)
                         throws AuthenticationFailedException
Authenticate a username and enrypted password against a system defined service and retrieve user information.

Parameters:
application - - The user will contain the permissions for the specified application.
Returns:
LoginCredentialsVo - Contains user information.
Throws:
Throws - an AuthenticationFailedException if the username/password combination is invalid or a LockedUserAccountException if the user account is locked.
AuthenticationFailedException

login

public LoginCredentialsVo login(com.retek.platform.service.ClientContext clientContext,
                                java.lang.String userName,
                                com.retek.platform.util.type.security.UserSignature signature,
                                com.retek.platform.app.security.service.Application application)
                         throws AuthenticationFailedException
Authenticate a username and signature and retrieve user information.

Parameters:
application - - The user will contain the permissions for the specified application.
Returns:
LoginCredentialsVo - Contains user information.
Throws:
Throws - an AuthenticationFailedException if the UserSignature is invalid or a LockedUserAccountException if the user account has been locked.
AuthenticationFailedException

loginAndGetContentModel

public LoginCredentialsWithContentModelVo loginAndGetContentModel(com.retek.platform.service.ClientContext context,
                                                                  java.lang.String userName,
                                                                  EncryptedTextVo encryptedPassword,
                                                                  com.retek.platform.app.security.service.Application application)
                                                           throws AuthenticationFailedException
Authenticate a username and encrypted password, retrieve user information and fetch the secure content model.

Parameters:
application - - The user will contain the permissions for the specified application.
Returns:
LoginCredentialsWithContentModelVo - Contains user and screen information.
Throws:
Throws - an AuthenticationFailedException if the username/password combination is invalid or a LockedUserAccountException if the user account is locked.
AuthenticationFailedException

loginAndGetContentModel

public LoginCredentialsWithContentModelVo loginAndGetContentModel(com.retek.platform.service.ClientContext clientContext,
                                                                  java.lang.String userName,
                                                                  com.retek.platform.util.type.security.UserSignature signature,
                                                                  com.retek.platform.app.security.service.Application application)
                                                           throws AuthenticationFailedException
Authenticate a username and signature, retrieve user information and fetch the secure content model.

Parameters:
application - - The user will contain the permissions for the specified application.
Returns:
LoginCredentialsWithContentModelVo - Contains user and screen information.
Throws:
Throws - an AuthenticationFailedException if the UserSignature is invalid or a LockedUserAccountException if the user account has been locked.
AuthenticationFailedException

isUserNameValid

public boolean isUserNameValid(com.retek.platform.service.ClientContext context,
                               java.lang.String userName)
Validates that the userName is a valid user name on the authentication system.


retrievePublicKeyEncryptionStrategy

public PublicKeyEncryptionStrategyVo retrievePublicKeyEncryptionStrategy(com.retek.platform.service.ClientContext context)
Gets the public key encryption strategy value object.


findUserVos

public java.util.Set findUserVos(com.retek.platform.service.ClientContext context,
                                 UserSearchCriteria criteria)
                          throws com.retek.platform.exception.RetekBusinessException
Find a collection of users based on the UserSearchCriteria.

Throws:
com.retek.platform.exception.RetekBusinessException

findUserVosWithPermissions

public java.util.Set findUserVosWithPermissions(com.retek.platform.service.ClientContext clientContext,
                                                java.util.Set permissions,
                                                com.retek.platform.app.security.service.Application applicationName)
                                         throws com.retek.platform.exception.RetekBusinessException
Retrieve a set of users given a set of permissions

Parameters:
permissions - - A collection of Strings (permission names)
applicationName - - The application associated with the passed in permissions
Returns:
Set - A Set of UserVo objects.
Throws:
Throws - a RetekBusinessException if...
com.retek.platform.exception.RetekBusinessException

findDataPermissions

public java.util.Map findDataPermissions(com.retek.platform.service.ClientContext clientContext,
                                         java.util.Set userVos,
                                         com.retek.platform.app.security.service.Application applicationName)
                                  throws com.retek.platform.exception.RetekBusinessException
Retrieve a map of users to data permissions. Keys are UserVo objects. Value objects are Sets of IdentifiableReferences.

Parameters:
userVos - - A set of UserVo objects
applicationName - - The application associated with the passed in permissions
Returns:
Map - A Map of UserVo keys to Sets of IdentifiableReferences.
Throws:
Throws - a RetekBusinessException if...
com.retek.platform.exception.RetekBusinessException