org.rbtdata.rbt.security
Interface SecurityInterface

All Known Implementing Classes:
JdbcSecurity

public interface SecurityInterface


Method Summary
 boolean authenticate(javax.xml.soap.SOAPHeader sh)
          evaluates incoming SOAP header to determine access
 void deleteDocument(java.lang.String docGroup, java.lang.String docOwner, java.lang.String docName)
           
 void deleteForeignKey(java.lang.String foreignKeyName)
           
 void deleteGroup(java.lang.String groupName)
           
 void deleteRole(java.lang.String roleName)
           
 void deleteUser(java.lang.String userName)
           
 java.util.List<SecurityObject> getAllDatasources()
           
 java.util.List<SecurityObject> getAllForeignKeys()
           
 java.util.List<SecurityObject> getAllGroups()
           
 java.util.List<SecurityObject> getAllRoles()
           
 java.util.List<SecurityObject> getAllUsers()
           
 java.lang.String getCurrentUserName()
           
 SecurityObject getDatasource(java.lang.String jndiName)
           
 RbtDocument getDocument(java.lang.String docGroup, java.lang.String docOwner, java.lang.String docName)
           
 java.util.List<QueryParameters> getDrillDownDocumentConfig(java.lang.String drillDownDocumentList, java.lang.String documentColumnValues)
           
 SecurityObject getForeignKey(java.lang.String foreignKeyName)
           
 SecurityObject getGroup(java.lang.String groupName)
           
 java.util.List<SecurityObject> getGroupRoles(java.lang.String groupName)
           
 SecurityObject getRole(java.lang.String roleName)
           
 MembersType getTableColumns(java.lang.String jndiName, java.lang.String tableName)
           
 SecurityObject getTableSetup(java.lang.String jndiName, java.lang.String tableName)
           
 SecurityObject getUser(java.lang.String userName)
           
 java.util.List<UserDocument> getUserDocuments(java.lang.String userName)
           
 java.util.List<SecurityObject> getUserGroups(java.lang.String userName)
           
 void init(java.util.Map initparams)
          Used to pass configuration parameters to the specific SecurityInterface implementation.
 boolean isAdministrator(java.lang.String userName)
           
 boolean isDesigner(java.lang.String userName)
           
 boolean isMember(java.lang.String parentType, java.lang.String parentName, java.lang.String memberType, java.lang.String memberName)
           
 RbtDocument saveDocument(RbtDocument docData)
           
 SecurityObject saveForeignKey(SecurityObject foreignKeyData)
           
 SecurityObject saveGroup(SecurityObject groupData)
           
 SecurityObject saveRole(SecurityObject roleData)
           
 void saveTableSetup(MemberType tableData)
           
 SecurityObject saveUser(SecurityObject userData)
           
 

Method Detail

init

void init(java.util.Map initparams)
          throws BaseException
Used to pass configuration parameters to the specific SecurityInterface implementation.

Parameters:
map - containing initialization parameters
Throws:
BaseException

authenticate

boolean authenticate(javax.xml.soap.SOAPHeader sh)
                     throws BaseException
evaluates incoming SOAP header to determine access

Parameters:
sh -
Returns:
true if SOAP header credentials are granted access
Throws:
BaseException

isAdministrator

boolean isAdministrator(java.lang.String userName)
                        throws BaseException
Parameters:
userName -
Returns:
true if the input username is in the administrators group
Throws:
BaseException

isDesigner

boolean isDesigner(java.lang.String userName)
                   throws BaseException
Parameters:
userName -
Returns:
true if input username is member of the designers group
Throws:
BaseException

getCurrentUserName

java.lang.String getCurrentUserName()
Returns:
the username of the currently logged in user

getAllUsers

java.util.List<SecurityObject> getAllUsers()
                                           throws BaseException
Returns:
SecurityObjects list of all RBT users
Throws:
BaseException

getAllGroups

java.util.List<SecurityObject> getAllGroups()
                                            throws BaseException
Returns:
SecurityObject list of all RBT groups.
Throws:
BaseException

getAllRoles

java.util.List<SecurityObject> getAllRoles()
                                           throws BaseException
Returns:
SecurityObject list of all RBT roles.
Throws:
BaseException

getAllForeignKeys

java.util.List<SecurityObject> getAllForeignKeys()
                                                 throws BaseException
Returns:
SecurityObject list of all custom-created foreign key relationships
Throws:
BaseException

getAllDatasources

java.util.List<SecurityObject> getAllDatasources()
                                                 throws BaseException
Returns:
SecuritObject list of all datasources available to the RBT application - does not include the security datasource containing RBT security tables.
Throws:
BaseException

getTableColumns

MembersType getTableColumns(java.lang.String jndiName,
                            java.lang.String tableName)
                            throws BaseException
Parameters:
jndiName - - datasource JNDI name for RBT database connection
tableName - - desired table name
Returns:
MembersType object containing a MemberType list of column information.
Throws:
BaseException

getUser

SecurityObject getUser(java.lang.String userName)
                       throws BaseException
Parameters:
userName -
Returns:
SecurityObject containing user record for input userName or null if no data found.
Throws:
BaseException

getUserGroups

java.util.List<SecurityObject> getUserGroups(java.lang.String userName)
                                             throws BaseException
Parameters:
userName -
Returns:
SecurityObject list of groups in which input user is a member.
Throws:
BaseException

getGroup

SecurityObject getGroup(java.lang.String groupName)
                        throws BaseException
Parameters:
groupName -
Returns:
SecurityObject containing group record for input groupName or null if no data found
Throws:
BaseException

getGroupRoles

java.util.List<SecurityObject> getGroupRoles(java.lang.String groupName)
                                             throws BaseException
Parameters:
groupName -
Returns:
SecurityObject list of roles in which input group is a member
Throws:
BaseException

getRole

SecurityObject getRole(java.lang.String roleName)
                       throws BaseException
Parameters:
roleName -
Returns:
SecurityObject containing role record for input roleName or null if no data found
Throws:
BaseException

getForeignKey

SecurityObject getForeignKey(java.lang.String foreignKeyName)
                             throws BaseException
Parameters:
foreignKeyName -
Returns:
SecurityObject containing foreignKey record for input foreignKeyName or null if no data found
Throws:
BaseException

getDatasource

SecurityObject getDatasource(java.lang.String jndiName)
                             throws BaseException
Parameters:
jndiName -
Returns:
datasource record associated with input JNDI name
Throws:
BaseException

getTableSetup

SecurityObject getTableSetup(java.lang.String jndiName,
                             java.lang.String tableName)
                             throws BaseException
Parameters:
jndiName -
tableName -
Returns:
table record associated with input JNDI datasource and tableName
Throws:
BaseException

isMember

boolean isMember(java.lang.String parentType,
                 java.lang.String parentName,
                 java.lang.String memberType,
                 java.lang.String memberName)
                 throws BaseException
Parameters:
parentType -
parentName -
memberType -
memberName -
Returns:
true if entity defined by memberType (user, group, table etc) and memberName is a child of the entity defined by parentType and parentName
Throws:
BaseException

saveUser

SecurityObject saveUser(SecurityObject userData)
                        throws BaseException
Parameters:
userData - input user record
Returns:
SecurityObject with updated user information after save.
Throws:
BaseException

saveGroup

SecurityObject saveGroup(SecurityObject groupData)
                         throws BaseException
Parameters:
groupData -
Returns:
SecurityObject with updated group information after save.
Throws:
BaseException

saveRole

SecurityObject saveRole(SecurityObject roleData)
                        throws BaseException
Parameters:
roleData -
Returns:
SecurityObject with updated role information after save.
Throws:
BaseException

saveForeignKey

SecurityObject saveForeignKey(SecurityObject foreignKeyData)
                              throws BaseException
Parameters:
foreignKeyData -
Returns:
SecurityObject with updated foreignKey information after save.
Throws:
BaseException

saveTableSetup

void saveTableSetup(MemberType tableData)
                    throws BaseException
Parameters:
tableData - MemberType record containing table and column display name setup
Throws:
BaseException

deleteUser

void deleteUser(java.lang.String userName)
                throws BaseException
Parameters:
userName - user to delete
Throws:
BaseException

deleteGroup

void deleteGroup(java.lang.String groupName)
                 throws BaseException
Parameters:
groupName - group to delete
Throws:
BaseException

deleteRole

void deleteRole(java.lang.String roleName)
                throws BaseException
Parameters:
roleName - role to delete
Throws:
BaseException

deleteForeignKey

void deleteForeignKey(java.lang.String foreignKeyName)
                      throws BaseException
Parameters:
foreignKeyName - foreign key to delete
Throws:
BaseException

getDocument

RbtDocument getDocument(java.lang.String docGroup,
                        java.lang.String docOwner,
                        java.lang.String docName)
                        throws BaseException
Parameters:
docGroup -
docOwner -
docName -
Returns:
Throws:
BaseException

getUserDocuments

java.util.List<UserDocument> getUserDocuments(java.lang.String userName)
                                              throws BaseException
Parameters:
userName -
Returns:
RbtDocument defined by key docGroup, docOwner and docName
Throws:
BaseException

deleteDocument

void deleteDocument(java.lang.String docGroup,
                    java.lang.String docOwner,
                    java.lang.String docName)
                    throws BaseException
Parameters:
docGroup -
docOwner -
docName -
Throws:
BaseException

saveDocument

RbtDocument saveDocument(RbtDocument docData)
                         throws BaseException
Parameters:
docData -
Returns:
save an RbtDocument
Throws:
BaseException

getDrillDownDocumentConfig

java.util.List<QueryParameters> getDrillDownDocumentConfig(java.lang.String drillDownDocumentList,
                                                           java.lang.String documentColumnValues)
                                                           throws BaseException
Parameters:
drillDownDocumentList -
documentColumnValues -
Returns:
QueryParameter list containing available documents and their input parameters that are available for drilldown
Throws:
BaseException