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

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

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

The internal admin service API. This interface should be used by the RSM client to perform User/Role/Permission maintenance.


Field Summary
 
Fields inherited from interface com.retek.platform.service.Service
serialVersionUID
 
Method Summary
 com.retek.platform.bo.IdentifiableReference createApplicationLaunchParameterReference(com.retek.platform.service.ClientContext clientContext)
          Reads the next available application launch parameter reference.
 com.retek.platform.bo.IdentifiableReference createRoleNamedPermissionReference(com.retek.platform.service.ClientContext clientContext)
          Reads the next available role permission reference.
 com.retek.platform.bo.IdentifiableReference createRoleReference(com.retek.platform.service.ClientContext clientContext)
          Reads the next available role reference.
 com.retek.platform.bo.IdentifiableReference createUserRoleReference(com.retek.platform.service.ClientContext clientContext)
          Reads the next available user role reference.
 void deleteApplicationLaunchParameters(com.retek.platform.service.ClientContext context, java.util.Set applicationLaunchParameterReferences)
          Deletes ApplicationLaunchParameter objects from the system.
 void deleteRoleNamedPermissions(com.retek.platform.service.ClientContext clientContext, java.util.Set roleNamedPermissionReferences)
          Removes the RoleNamedPermissions by deleting all RoleNamedPermission objects by using the IdentifiableReference objects contained in the roleNamedPermissionReferences.
 void deleteRoles(com.retek.platform.service.ClientContext context, java.util.Set roleReferences)
          Deletes the roles from the system.
 void deleteUserRoles(com.retek.platform.service.ClientContext clientContext, java.util.Set userRoleReferences)
          Removes the relationship between a User and Role.
 java.util.Set findApplicationLaunchParameters(com.retek.platform.service.ClientContext clientContext, AppLaunchParameterSearchCriteria criteria, PublicKeyEncryptionStrategyVo publicEncryptionKey)
          Find a collection of ApplicationLaunchParameterVo(s).
 java.util.Set findNamedPermissions(com.retek.platform.service.ClientContext clientContext, NamedPermissionSearchCriteria criteria)
          Find a collection of PermissionVos RoleNamedPermissionSearchCriteria.
 java.util.Set findRoleNamedPermissions(com.retek.platform.service.ClientContext clientContext, RoleNamedPermissionSearchCriteria criteria)
          Find a collection of NamedPermissionVo NamedPermissionSearchCriteria.
 java.util.Set findRoleVos(com.retek.platform.service.ClientContext context, java.util.Set roles)
          Find a collection of RoleVo's based on a set of Role name descriptions (Strings)
 java.util.Set findUserRoleVos(com.retek.platform.service.ClientContext clientContext, UserRoleSearchCriteria criteria)
           
 com.retek.platform.util.type.RDate getSystemTime(com.retek.platform.service.ClientContext clientContext)
          Reads the current system vdate time.
 void saveRole(com.retek.platform.service.ClientContext context, RoleVo roleVo)
          Saves the role in the system.
 void saveRoleNamedPermissions(com.retek.platform.service.ClientContext clientContext, com.retek.platform.bo.IdentifiableReference roleReference, java.util.Set roleNamedPermissions)
          Saves the role named permission in the system.
 void saveUserRoles(com.retek.platform.service.ClientContext context, java.util.Set userRoleVo)
          Establishes the relationship between a User and Role.
 void updateApplicationLaunchParameters(com.retek.platform.service.ClientContext clientContext, java.util.Set updatedApplicationLaunchParameterVos)
          Update a collection of ApplicationLaunchParameterVo(s).
 
Methods inherited from interface com.retek.platform.service.Service
attachFallbackHandler
 

Method Detail

saveRole

public void saveRole(com.retek.platform.service.ClientContext context,
                     RoleVo roleVo)
              throws com.retek.platform.exception.RetekBusinessException
Saves the role in the system.

Throws:
com.retek.platform.exception.RetekBusinessException

deleteRoles

public void deleteRoles(com.retek.platform.service.ClientContext context,
                        java.util.Set roleReferences)
                 throws com.retek.platform.exception.RetekBusinessException
Deletes the roles from the system.

Parameters:
roleReferences - - Contains a Set of Role IdentifiableReferences to delete.
Throws:
com.retek.platform.exception.RetekBusinessException

findRoleVos

public java.util.Set findRoleVos(com.retek.platform.service.ClientContext context,
                                 java.util.Set roles)
                          throws com.retek.platform.exception.RetekBusinessException
Find a collection of RoleVo's based on a set of Role name descriptions (Strings)

Throws:
com.retek.platform.exception.RetekBusinessException

deleteUserRoles

public void deleteUserRoles(com.retek.platform.service.ClientContext clientContext,
                            java.util.Set userRoleReferences)
                     throws com.retek.platform.exception.RetekBusinessException
Removes the relationship between a User and Role.

Throws:
com.retek.platform.exception.RetekBusinessException

saveUserRoles

public void saveUserRoles(com.retek.platform.service.ClientContext context,
                          java.util.Set userRoleVo)
                   throws com.retek.platform.exception.RetekBusinessException
Establishes the relationship between a User and Role.

Throws:
com.retek.platform.exception.RetekBusinessException

createRoleReference

public com.retek.platform.bo.IdentifiableReference createRoleReference(com.retek.platform.service.ClientContext clientContext)
                                                                throws com.retek.platform.exception.RetekBusinessException
Reads the next available role reference.

Throws:
com.retek.platform.exception.RetekBusinessException

createRoleNamedPermissionReference

public com.retek.platform.bo.IdentifiableReference createRoleNamedPermissionReference(com.retek.platform.service.ClientContext clientContext)
                                                                               throws com.retek.platform.exception.RetekBusinessException
Reads the next available role permission reference.

Throws:
com.retek.platform.exception.RetekBusinessException

createUserRoleReference

public com.retek.platform.bo.IdentifiableReference createUserRoleReference(com.retek.platform.service.ClientContext clientContext)
                                                                    throws com.retek.platform.exception.RetekBusinessException
Reads the next available user role reference.

Throws:
com.retek.platform.exception.RetekBusinessException

findNamedPermissions

public java.util.Set findNamedPermissions(com.retek.platform.service.ClientContext clientContext,
                                          NamedPermissionSearchCriteria criteria)
                                   throws com.retek.platform.exception.RetekBusinessException
Find a collection of PermissionVos RoleNamedPermissionSearchCriteria.

Throws:
com.retek.platform.exception.RetekBusinessException

findRoleNamedPermissions

public java.util.Set findRoleNamedPermissions(com.retek.platform.service.ClientContext clientContext,
                                              RoleNamedPermissionSearchCriteria criteria)
                                       throws com.retek.platform.exception.RetekBusinessException
Find a collection of NamedPermissionVo NamedPermissionSearchCriteria.

Throws:
com.retek.platform.exception.RetekBusinessException

deleteRoleNamedPermissions

public void deleteRoleNamedPermissions(com.retek.platform.service.ClientContext clientContext,
                                       java.util.Set roleNamedPermissionReferences)
                                throws com.retek.platform.exception.RetekBusinessException
Removes the RoleNamedPermissions by deleting all RoleNamedPermission objects by using the IdentifiableReference objects contained in the roleNamedPermissionReferences.

Throws:
com.retek.platform.exception.RetekBusinessException

saveRoleNamedPermissions

public void saveRoleNamedPermissions(com.retek.platform.service.ClientContext clientContext,
                                     com.retek.platform.bo.IdentifiableReference roleReference,
                                     java.util.Set roleNamedPermissions)
                              throws com.retek.platform.exception.RetekBusinessException
Saves the role named permission in the system.

Throws:
com.retek.platform.exception.RetekBusinessException

findApplicationLaunchParameters

public java.util.Set findApplicationLaunchParameters(com.retek.platform.service.ClientContext clientContext,
                                                     AppLaunchParameterSearchCriteria criteria,
                                                     PublicKeyEncryptionStrategyVo publicEncryptionKey)
                                              throws com.retek.platform.exception.RetekBusinessException
Find a collection of ApplicationLaunchParameterVo(s).

Throws:
com.retek.platform.exception.RetekBusinessException

updateApplicationLaunchParameters

public void updateApplicationLaunchParameters(com.retek.platform.service.ClientContext clientContext,
                                              java.util.Set updatedApplicationLaunchParameterVos)
                                       throws com.retek.platform.exception.RetekBusinessException
Update a collection of ApplicationLaunchParameterVo(s).

Throws:
com.retek.platform.exception.RetekBusinessException

deleteApplicationLaunchParameters

public void deleteApplicationLaunchParameters(com.retek.platform.service.ClientContext context,
                                              java.util.Set applicationLaunchParameterReferences)
                                       throws com.retek.platform.exception.RetekBusinessException
Deletes ApplicationLaunchParameter objects from the system.

Parameters:
context - - The client context of the calling app.
applicationLaunchParameterReferences - - Contains a Set of ApplicationLauchParameter IdentifiableReferences to delete.
Throws:
com.retek.platform.exception.RetekBusinessException

createApplicationLaunchParameterReference

public com.retek.platform.bo.IdentifiableReference createApplicationLaunchParameterReference(com.retek.platform.service.ClientContext clientContext)
                                                                                      throws com.retek.platform.exception.RetekBusinessException
Reads the next available application launch parameter reference.

Throws:
com.retek.platform.exception.RetekBusinessException

findUserRoleVos

public java.util.Set findUserRoleVos(com.retek.platform.service.ClientContext clientContext,
                                     UserRoleSearchCriteria criteria)
                              throws com.retek.platform.exception.RetekBusinessException
Throws:
com.retek.platform.exception.RetekBusinessException

getSystemTime

public com.retek.platform.util.type.RDate getSystemTime(com.retek.platform.service.ClientContext clientContext)
                                                 throws com.retek.platform.exception.RetekBusinessException
Reads the current system vdate time.

Throws:
com.retek.platform.exception.RetekBusinessException