Class RbacAppSoapStub
- java.lang.Object
-
- com.collabnet.ce.soap60.webservices.ClientSoapStub
-
- com.collabnet.ce.soap60.webservices.rbac.RbacAppSoapStub
-
- All Implemented Interfaces:
IRbacAppSoap
public class RbacAppSoapStub extends ClientSoapStub implements IRbacAppSoap
-
-
Field Summary
-
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT
-
-
Constructor Summary
Constructors Constructor Description RbacAppSoapStub(String soapServerUrl)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCluster(String sessionId, String roleId, String operationCluster, String folderId)Adds an operation cluster to a role, expanding the permission set that the role grants access to.voidaddGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId)Adds a user group to a role, within the Project/ProjectGroup scope.voidaddIntegratedApplicationPermission(String sessionId, String roleId, String integratedAppName, String permission)Adds an integrated application permission to a role, expanding the permission set that the role grants access to.voidaddUser(String sessionId, String roleId, String username)Adds a user to the role, giving them all of the permissions of that rolevoidaddUserToProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId)Adds a user to the role in the given project contextvoidapproveRoleRequest(String sessionId, String requestId, String projectId)Approves a role requestRoleSoapDOcreateGlobalRole(String sessionId, String title, String description, boolean preventInheritance, boolean requestable)Creates a global role.RoleSoapDOcreateRole(String sessionId, String projectOrProjectGroupId, String title, String description, boolean preventInheritance, boolean requestable, boolean autoGrant)Creates a role in a given projectRoleSoapDOcreateSiteWideRole(String sessionId, String title, String description, boolean preventInheritance)Creates a site-wide role.voiddeleteRole(String sessionId, String roleId)Deletes a role.booleangetAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId)Gets the role's Automatically Grant On Request for the given project.RoleSoapListgetGlobalRoleList(String sessionId)Returns a list of all the global roles available on the site.RoleSoapListgetGlobalRolesForAssignment(String sessionId, String projectOrProjectGroupId)Returns a list of global roles available in the project or project group for user/user group assignment.RoleSoapListgetGroupRoleList(String sessionId, String groupId, String projectIdOrProjectGroupId)Returns a list of roles the user group is associated with in a project or projectGroup.RoleSoapListgetInheritedRoleList(String sessionId, String projectId)Gets a list of roles inherited from any of the parent projects.IntegratedAppProjectPermissionSoapListgetIntegratedAppPermissions(String sessionId, String[] projectIds, String baseUrl)Returns list of integratedApp permissions for the user associated with specified projectsString[]getIntegratedAppPermissionsForProject(String sessionId, String projectId, String linkId)Returns integratedApp permissions for the user associated with a projectRoleRequestSoapListgetPendingRequestedRoles(String sessionId, String projectId)Lists the pending requested roles for the given projectIdUserSoapListgetProjectRoleMemberList(String sessionId, String roleId, String projectOrProjectGroupId)Returns a list of users that are in a specified role in the given project or project group.String[]getProjectsByIntegratedAppPermission(String sessionId, String perm, String integratedAppName)Returns the list of projects by integratedApp permission.ProjectSoapListgetProjectsForAction(String sessionId, String operationString, String userName)Gets the list of all projects in which the given user has given permission.RoleSoapDOgetRoleData(String sessionId, String roleId)Get a role data.UserGroupSoapListgetRoleGroupList(String sessionId, String roleId)Returns a list of user groups that belong to the specified role.UserSoapListgetRoleGroupUsers(String sessionId, String projectIdOrProjectGroupId, String roleId)Returns a list of users who are part of a group and associated with the specified role.RoleSoapListgetRoleList(String sessionId, String projectOrProjectGroupId)Gets a list of Roles in a project context.UserSoapListgetRoleMemberList(String sessionId, String roleId)Returns a list of users that are assigned to the specified role.RoleSoapListgetSiteWideRoleList(String sessionId)Returns a list of all the site-wide roles available on the site.RoleSoapListgetUserRoleList(String sessionId, String projectOrProjectGroupId, String username)Returns a list of roles that a user is a member of in the specified project or project group.RoleSoapListgetUserSiteWideRoleList(String sessionId, String username)Returns a list of roles that a user is a member of site wide role.voidgrantRolesToMembers(String sessionId, UserRolesSoapDO[] userRolesSoapDOs, String projectId)Grants roles to list of users in a given project and user is made as member of the project if not already.RoleCluster2SoapListlistClusterForDefaultAccessPermissions(String sessionId, String projectId)Gets the list of operation cluster with default access permission.RoleClusterSoapListlistClusters(String sessionId, String roleId)Gets the list of operation cluster assigned to a role.RoleGroupSoapListlistGroupRolesByProject(String sessionId, String projectId)Returns a list of user groups and the roles it is associated with in a project.RoleGroupSoapListlistGroupRolesByProjectGroup(String sessionId, String projectGroupId)Returns a list of user groups and the roles it is associated with in a project group.SoapNamedValueslistRolePaths(String sessionId, String roleId, String repositoryId)Gets the list of paths for a role.voidrejectRoleRequest(String sessionId, String requestId, String projectId)Rejects a role requestvoidremoveCluster(String sessionId, String roleId, String operationCluster, String folderId)Removes an operation cluster to a role, removing the permission set.voidremoveGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId)Removes the user group for the role, within the Project/ProjectGroup scopevoidremoveIntegratedApplicationPermission(String sessionId, String roleId, String integratedAppName, String permission)Removes an integrated application permission from the given role.voidremoveUser(String sessionId, String roleId, String username)Removes a user from a rolevoidremoveUserFromProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId)Removes a user from a role in the given projectvoidrequestRole(String sessionId, String roleId, String projectId)Requests a rolevoidrevokeRolesFromMembers(String sessionId, UserRolesSoapDO[] userRolesSoapDOs, String projectId)Removes roles from users in the projectvoidsetAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId, boolean autoGrant)Sets the role's Automatically Grant On Request for the given project.voidsetRoleData(String sessionId, RoleSoapDO roleData)Saves a role object.voidsetRolePaths(String sessionId, String roleId, String repositoryId, SoapNamedValues rolePaths)Sets the list of paths for a role.-
Methods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam
-
-
-
-
Constructor Detail
-
RbacAppSoapStub
public RbacAppSoapStub(String soapServerUrl)
-
-
Method Detail
-
createRole
public RoleSoapDO createRole(String sessionId, String projectOrProjectGroupId, String title, String description, boolean preventInheritance, boolean requestable, boolean autoGrant) throws RemoteException
Description copied from interface:IRbacAppSoapCreates a role in a given project- Specified by:
createRolein interfaceIRbacAppSoap- Parameters:
sessionId- User session IdprojectOrProjectGroupId- The project /project group Id to create the role intitle- The title of the roledescription- A description of the rolepreventInheritance- If the role's permission is prevented from applying to private subprojects.requestable- If the role is available upon requestautoGrant- If the role is granted automatically on request- Returns:
- The Role2SoapDO that was created
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the projectId is invalid or the created roleId is invalid.ObjectAlreadyExistsFault- If the role exists with the specified title in the projectIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
createSiteWideRole
public RoleSoapDO createSiteWideRole(String sessionId, String title, String description, boolean preventInheritance) throws RemoteException
Description copied from interface:IRbacAppSoapCreates a site-wide role. Users with site-admin permissions- Specified by:
createSiteWideRolein interfaceIRbacAppSoap- Parameters:
sessionId- User session Idtitle- The title of the site-wide roledescription- A description of the rolepreventInheritance- If the role's permission is prevented from applying to private projects.- Returns:
- The Role2SoapDO that was created
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the created roleId is invalidObjectAlreadyExistsFault- If the role exists with the specified title in the projectIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
createGlobalRole
public RoleSoapDO createGlobalRole(String sessionId, String title, String description, boolean preventInheritance, boolean requestable) throws RemoteException
Description copied from interface:IRbacAppSoapCreates a global role. Only Super-users or users having Role-Create permission can create global role.- Specified by:
createGlobalRolein interfaceIRbacAppSoap- Parameters:
sessionId- User session Idtitle- The title of the global roledescription- The description of the global rolepreventInheritance- If the role's permission is prevented from applying to private projects.requestable- If the role is available upon request- Returns:
- The Role2SoapDO that was created
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the created roleId is invalidObjectAlreadyExistsFault- If the global role exists with the specified titleIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
setRoleData
public void setRoleData(String sessionId, RoleSoapDO roleData) throws RemoteException
Description copied from interface:IRbacAppSoapSaves a role object.- Specified by:
setRoleDatain interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleData- the role object to save- Throws:
InvalidSessionFault- If the session is invalidVersionMismatchFault- The role version being edited is not the latest onePermissionDeniedFault- If the user doesn't have permission to perform the operationIllegalArgumentFault- If one of the parameters is invalidNoSuchObjectFault- When the roleId is invalidSystemFault- when an unexpected system level error occurs.RemoteException
-
getRoleData
public RoleSoapDO getRoleData(String sessionId, String roleId) throws RemoteException
Description copied from interface:IRbacAppSoapGet a role data.- Specified by:
getRoleDatain interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- The id of the role to be fetch- Returns:
- The RoleSoapDO that was fetched
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the roleId is invalidSystemFault- when an unexpected system level error occurs.IllegalArgumentFault- When the roleId is invalidRemoteException
-
deleteRole
public void deleteRole(String sessionId, String roleId) throws RemoteException
Description copied from interface:IRbacAppSoapDeletes a role.- Specified by:
deleteRolein interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- The id of the role to be deleted- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the projectId is invalidRemoteException
-
addCluster
public void addCluster(String sessionId, String roleId, String operationCluster, String folderId) throws RemoteException
Description copied from interface:IRbacAppSoapAdds an operation cluster to a role, expanding the permission set that the role grants access to.- Specified by:
addClusterin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- The role id to add the cluster tooperationCluster- The cluster name to add to the role. See OperationClusterConstants.folderId- the folder id for the specified cluster.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the cluster already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
addIntegratedApplicationPermission
public void addIntegratedApplicationPermission(String sessionId, String roleId, String integratedAppName, String permission) throws RemoteException
Description copied from interface:IRbacAppSoapAdds an integrated application permission to a role, expanding the permission set that the role grants access to.- Specified by:
addIntegratedApplicationPermissionin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- The role id to add the integrated application permission tointegratedAppName- The integrated application name (e.g: 'Pebble Blog')permission- The integrated application permission name to add to the role.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the cluster already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
removeIntegratedApplicationPermission
public void removeIntegratedApplicationPermission(String sessionId, String roleId, String integratedAppName, String permission) throws RemoteException
Description copied from interface:IRbacAppSoapRemoves an integrated application permission from the given role.- Specified by:
removeIntegratedApplicationPermissionin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- The role id from which the integrated application permission to be removedintegratedAppName- The integrated application name (e.g: 'Pebble Blog')permission- The integrated application permission to be removed from the role.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the cluster already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
removeCluster
public void removeCluster(String sessionId, String roleId, String operationCluster, String folderId) throws RemoteException
Description copied from interface:IRbacAppSoapRemoves an operation cluster to a role, removing the permission set.- Specified by:
removeClusterin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- The role id to remove the cluster tooperationCluster- The cluster name to add to the rolefolderId- the folder id for the specified cluster.- Throws:
InvalidSessionFault- If the session is invalidIllegalArgumentFault- If one of the parameters is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidRemoteException
-
listClusters
public RoleClusterSoapList listClusters(String sessionId, String roleId) throws RemoteException
Description copied from interface:IRbacAppSoapGets the list of operation cluster assigned to a role.- Specified by:
listClustersin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- The ID of the role for which clusters will be listed- Returns:
- list of clusters for a role
- Throws:
InvalidSessionFault- If the session is invalidIllegalArgumentFault- If one of the parameters is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidRemoteException
-
listClusterForDefaultAccessPermissions
public RoleCluster2SoapList listClusterForDefaultAccessPermissions(String sessionId, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapGets the list of operation cluster with default access permission.- Specified by:
listClusterForDefaultAccessPermissionsin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdprojectId- The ID of the project for which clusters will be listed- Returns:
- list of clusters for a project
- Throws:
InvalidSessionFault- If the session is invalidIllegalArgumentFault- If one of the parameters is invalidNoSuchObjectFault- When the roleId is invalidSystemFaultPermissionDeniedFaultRemoteException
-
addUser
public void addUser(String sessionId, String roleId, String username) throws RemoteException
Description copied from interface:IRbacAppSoapAdds a user to the role, giving them all of the permissions of that role- Specified by:
addUserin interfaceIRbacAppSoap- Parameters:
sessionId- User sessionIdroleId- The role id to add the user tousername- The username of the user to add to the role- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the user already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
grantRolesToMembers
public void grantRolesToMembers(String sessionId, UserRolesSoapDO[] userRolesSoapDOs, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapGrants roles to list of users in a given project and user is made as member of the project if not already.- Specified by:
grantRolesToMembersin interfaceIRbacAppSoap- Parameters:
sessionId- User sessionIduserRolesSoapDOs- user to roles data containerprojectId- project to which users would be the members with the given roles.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the user already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
removeUser
public void removeUser(String sessionId, String roleId, String username) throws RemoteException
Description copied from interface:IRbacAppSoapRemoves a user from a role- Specified by:
removeUserin interfaceIRbacAppSoap- Parameters:
sessionId- User sessionIdroleId- The role id to add the user tousername- The username of the user to add to the role- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
revokeRolesFromMembers
public void revokeRolesFromMembers(String sessionId, UserRolesSoapDO[] userRolesSoapDOs, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapRemoves roles from users in the project- Specified by:
revokeRolesFromMembersin interfaceIRbacAppSoap- Parameters:
sessionId- User sessionIduserRolesSoapDOs- user to roles data containerprojectId- project in which roles would be removed from the users.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
addUserToProjectRole
public void addUserToProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId) throws RemoteException
Description copied from interface:IRbacAppSoapAdds a user to the role in the given project context- Specified by:
addUserToProjectRolein interfaceIRbacAppSoap- Parameters:
sessionId- User sessionIdroleId- The role id to add the user tousername- The username of the user to add to the roleprojectOrProjectGroupId- projectId (or) Project group ID.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidObjectAlreadyExistsFault- If the user already exists in the roleIllegalArgumentFault- If one of the parameters is invalidRemoteException- See Also:
IRbacAppSoap.addUser(String, String, String)
-
removeUserFromProjectRole
public void removeUserFromProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId) throws RemoteException
Description copied from interface:IRbacAppSoapRemoves a user from a role in the given project- Specified by:
removeUserFromProjectRolein interfaceIRbacAppSoap- Parameters:
sessionId- User sessionIdroleId- The role id to add the user tousername- The username of the user to add to the roleprojectOrProjectGroupId- projectId (or) Project group ID.- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException- See Also:
IRbacAppSoap.removeUser(String, String, String)
-
addGroup
public void addGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId) throws RemoteException
Description copied from interface:IRbacAppSoapAdds a user group to a role, within the Project/ProjectGroup scope.- Specified by:
addGroupin interfaceIRbacAppSoap- Parameters:
sessionId- User sessionId.groupId- the user group to be added.roleId- The role to which the user group is to be added.projectOrProjectGroupId- The project/projectgroup id to which the role belongs.- Throws:
IllegalArgumentFault- If one of the parameters is invalid.InvalidSessionFault- If the session is invalid.PermissionDeniedFault- If the user does not have permission to perform the operation.SystemFault- When an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalid.ObjectAlreadyExistsFault- If the user group already exists in the role.RemoteException
-
removeGroup
public void removeGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId) throws RemoteException
Description copied from interface:IRbacAppSoapRemoves the user group for the role, within the Project/ProjectGroup scope- Specified by:
removeGroupin interfaceIRbacAppSoap- Parameters:
sessionId- User sessionId.groupId- the user group to be added.roleId- The role to which the user group is to be added.projectOrProjectGroupId- The project/projectgroup id to which the role belongs.- Throws:
IllegalArgumentFault- If one of the parameters is invalid.InvalidSessionFault- If the session is invalid.NoSuchObjectFault- When the roleId is invalid.PermissionDeniedFault- If the user does not have permission to perform the operation.SystemFault- When an unexpected system level error occurs.RemoteException
-
getRoleList
public RoleSoapList getRoleList(String sessionId, String projectOrProjectGroupId) throws RemoteException
Description copied from interface:IRbacAppSoapGets a list of Roles in a project context. This call required project admin permissions.- Specified by:
getRoleListin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdprojectOrProjectGroupId- The Project/Project Group Id to list roles from- Returns:
- The RoleSoapList describing all roles in the project
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the projectId is invalidObjectAlreadyExistsFault- If the role exists with the specified title in the projectIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
getInheritedRoleList
public RoleSoapList getInheritedRoleList(String sessionId, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapGets a list of roles inherited from any of the parent projects. This call requires project admin permission.- Specified by:
getInheritedRoleListin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdprojectId- The project Id to list the inherited roles from- Returns:
- The Role2SoapList describing all inherited roles in the project
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the projectId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
getRoleMemberList
public UserSoapList getRoleMemberList(String sessionId, String roleId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of users that are assigned to the specified role.- Specified by:
getRoleMemberListin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.roleId- Role id.- Returns:
- List of users in the specified role.
- Throws:
IllegalArgumentFault- Role id is not specified or invalid.InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have permission to perform the operationNoSuchObjectFault- when the specified role id is invalidSystemFault- when an unexpected system level error occurs.RemoteException
-
getProjectRoleMemberList
public UserSoapList getProjectRoleMemberList(String sessionId, String roleId, String projectOrProjectGroupId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of users that are in a specified role in the given project or project group.- Specified by:
getProjectRoleMemberListin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.roleId- Role id.projectOrProjectGroupId- Project or Project Group Id- Returns:
- List of users in the specified role in the given project or project group.
- Throws:
IllegalArgumentFault- Role id is not specified or invalid.InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have permission to perform the operationNoSuchObjectFault- when the specified role id is invalidSystemFault- when an unexpected system level error occurs.RemoteException
-
getUserRoleList
public RoleSoapList getUserRoleList(String sessionId, String projectOrProjectGroupId, String username) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of roles that a user is a member of in the specified project or project group.- Specified by:
getUserRoleListin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.projectOrProjectGroupId- Project or Project Group id.username- Name of the user.- Returns:
- List of roles that a user is a member of.
- Throws:
IllegalArgumentFault- Username is not specified or invalid.InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have permission to perform the operationNoSuchObjectFault- when the specified project or project group id is invalidSystemFault- when an unexpected system level error occurs.RemoteException
-
getUserSiteWideRoleList
public RoleSoapList getUserSiteWideRoleList(String sessionId, String username) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of roles that a user is a member of site wide role.- Specified by:
getUserSiteWideRoleListin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.username- Name of the user.- Returns:
- List of site-wide roles that a user is a member of.
- Throws:
IllegalArgumentFault- Username is not specified or invalid.InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have permission to perform the operationNoSuchObjectFault- when the specified project id is invalidSystemFault- when an unexpected system level error occurs.RemoteException
-
getSiteWideRoleList
public RoleSoapList getSiteWideRoleList(String sessionId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of all the site-wide roles available on the site.- Specified by:
getSiteWideRoleListin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.- Returns:
- List of site-wide roles available
- Throws:
InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have the permission to perform the operationSystemFault- when an unexpected system level error occurs.RemoteException
-
getGlobalRoleList
public RoleSoapList getGlobalRoleList(String sessionId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of all the global roles available on the site.- Specified by:
getGlobalRoleListin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.- Returns:
- List of global roles available
- Throws:
InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have the permission to perform the operationSystemFault- when an unexpected system level error occurs.RemoteException
-
getGlobalRolesForAssignment
public RoleSoapList getGlobalRolesForAssignment(String sessionId, String projectOrProjectGroupId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of global roles available in the project or project group for user/user group assignment.- Specified by:
getGlobalRolesForAssignmentin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.projectOrProjectGroupId- the project or project group from which to get the global roles list- Returns:
- List of global roles available
- Throws:
InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have the permission to perform the operationNoSuchObjectFault- when the specified project or project group id is invalidSystemFault- when an unexpected system level error occurs.RemoteException
-
getGroupRoleList
public RoleSoapList getGroupRoleList(String sessionId, String groupId, String projectIdOrProjectGroupId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of roles the user group is associated with in a project or projectGroup.- Specified by:
getGroupRoleListin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.groupId- User Group id.projectIdOrProjectGroupId- Project id or project group id.- Returns:
- List of roles the user group is associated with.
- Throws:
InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have permission to perform the operation.SystemFault- when an unexpected system level error occurs.NoSuchObjectFault- when the specified project id or project group id is invalid.IllegalArgumentFault- If one of the parameters is invalid.RemoteException
-
getRoleGroupList
public UserGroupSoapList getRoleGroupList(String sessionId, String roleId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of user groups that belong to the specified role.- Specified by:
getRoleGroupListin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.roleId- Role id.- Returns:
- List of user groups associated with a role.
- Throws:
IllegalArgumentFault- roleId is not specified or invalid.InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have permission to perform the operation.SystemFault- when an unexpected system level error occurs.NoSuchObjectFault- when the specified project id is invalid.RemoteException
-
listGroupRolesByProject
public RoleGroupSoapList listGroupRolesByProject(String sessionId, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of user groups and the roles it is associated with in a project.- Specified by:
listGroupRolesByProjectin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.projectId- Project id.- Returns:
- list of user groups and the roles it is associated with
- Throws:
IllegalArgumentFault- projectId is not specified or invalid.InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have permission to perform the operation.SystemFault- when an unexpected system level error occurs.NoSuchObjectFault- when the specified project id is invalid.RemoteException
-
getRoleGroupUsers
public UserSoapList getRoleGroupUsers(String sessionId, String projectIdOrProjectGroupId, String roleId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of users who are part of a group and associated with the specified role.- Specified by:
getRoleGroupUsersin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.projectIdOrProjectGroupId- Project or Project Group's id.roleId- Role id.- Returns:
- List of users in the specified role.
- Throws:
IllegalArgumentFault- Role id is not specified or invalid.InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have permission to perform the operationNoSuchObjectFault- when the specified role id is invalidSystemFault- when an unexpected system level error occurs.RemoteException
-
listRolePaths
public SoapNamedValues listRolePaths(String sessionId, String roleId, String repositoryId) throws RemoteException
Description copied from interface:IRbacAppSoapGets the list of paths for a role.- Specified by:
listRolePathsin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- the key of the role the role paths belongs torepositoryId- the repository id- Returns:
- role path in soap named values format
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
setRolePaths
public void setRolePaths(String sessionId, String roleId, String repositoryId, SoapNamedValues rolePaths) throws RemoteException
Description copied from interface:IRbacAppSoapSets the list of paths for a role.- Specified by:
setRolePathsin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- the key of the role the role paths belongs torepositoryId- the repository idrolePaths- list of role paths- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationSystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the roleId is invalidIllegalArgumentFault- If one of the parameters is invalidRemoteException
-
getProjectsForAction
public ProjectSoapList getProjectsForAction(String sessionId, String operationString, String userName) throws RemoteException
Description copied from interface:IRbacAppSoapGets the list of all projects in which the given user has given permission.- Specified by:
getProjectsForActionin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdoperationString- Operation in format type.category.nameuserName- the user who would have cluster permission in the returned project list- Returns:
- List of projects
- Throws:
InvalidSessionFault- when the session is invalidPermissionDeniedFault- when the user doesn't have permission to perform the operationIllegalArgumentFault- when the arguments are null or empty.SystemFault- when an unexpected system level error occurs.NoSuchObjectFault- when the userName doesn't exist.RemoteException
-
requestRole
public void requestRole(String sessionId, String roleId, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapRequests a role- Specified by:
requestRolein interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- the role idprojectId- project in which to make the request- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the roleId or projectId is invalidIllegalArgumentFault- incorrect parametersSystemFault- when an unexpected system level error occurs.RemoteException
-
setAutomaticallyGrantOnRequest
public void setAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId, boolean autoGrant) throws RemoteException
Description copied from interface:IRbacAppSoapSets the role's Automatically Grant On Request for the given project.- Specified by:
setAutomaticallyGrantOnRequestin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- the role idprojectId- the project to which automatically grant property to be setautoGrant- true to set it available upon request- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the projectId is invalidSystemFault- when an unexpected system level error occurs.IllegalArgumentFault- when the role is not available upon requestRemoteException
-
getAutomaticallyGrantOnRequest
public boolean getAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapGets the role's Automatically Grant On Request for the given project.- Specified by:
getAutomaticallyGrantOnRequestin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdroleId- the role idprojectId- the project to which automatically grant property to be set- Returns:
- Auto grant flag of role
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the projectId is invalidSystemFault- when an unexpected system level error occurs.IllegalArgumentFault- when there is a request for global role with Projects project id.RemoteException
-
getPendingRequestedRoles
public RoleRequestSoapList getPendingRequestedRoles(String sessionId, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapLists the pending requested roles for the given projectId- Specified by:
getPendingRequestedRolesin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdprojectId- project in which the pending requested roles needs to be retrieved- Returns:
- List of pending requested roles.
- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When projectId is invalidIllegalArgumentFault- incorrect parametersSystemFault- unexpected error occursRemoteException
-
approveRoleRequest
public void approveRoleRequest(String sessionId, String requestId, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapApproves a role request- Specified by:
approveRoleRequestin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdrequestId- Role request IdprojectId- project in which the role request was raised- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the projectId is invalidIllegalArgumentFault- incorrect parametersSystemFault- unexpected error occursRemoteException
-
rejectRoleRequest
public void rejectRoleRequest(String sessionId, String requestId, String projectId) throws RemoteException
Description copied from interface:IRbacAppSoapRejects a role request- Specified by:
rejectRoleRequestin interfaceIRbacAppSoap- Parameters:
sessionId- User session IdrequestId- Role request IdprojectId- project in which the role request was raised- Throws:
InvalidSessionFault- If the session is invalidPermissionDeniedFault- If the user doesn't have permission to perform the operationNoSuchObjectFault- When the projectId is invalidIllegalArgumentFault- incorrect parametersSystemFault- unexpected error occursRemoteException
-
listGroupRolesByProjectGroup
public RoleGroupSoapList listGroupRolesByProjectGroup(String sessionId, String projectGroupId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns a list of user groups and the roles it is associated with in a project group.- Specified by:
listGroupRolesByProjectGroupin interfaceIRbacAppSoap- Parameters:
sessionId- User session id.projectGroupId- Project group id.- Returns:
- list of user groups and the roles it is associated with
- Throws:
IllegalArgumentFault- projectGroupId is not specified or invalid.InvalidSessionFault- if the session is invalid.PermissionDeniedFault- if the user does not have permission to perform the operation.SystemFault- when an unexpected system level error occurs.NoSuchObjectFault- when the specified project group id is invalid.RemoteException
-
getProjectsByIntegratedAppPermission
public String[] getProjectsByIntegratedAppPermission(String sessionId, String perm, String integratedAppName) throws RemoteException
Description copied from interface:IRbacAppSoapReturns the list of projects by integratedApp permission.- Specified by:
getProjectsByIntegratedAppPermissionin interfaceIRbacAppSoap- Parameters:
sessionId- User session key.perm- permission criteriaintegratedAppName- the IntegratedApp plugName.- Returns:
- string array of id of projects in which the current user has given permission to given integrated app.
- Throws:
InvalidSessionFault- when the specified session id is invalid.SystemFault- when an unexpected system level error occurs.NoSuchObjectFault- When the plugName is invalidIllegalArgumentFault- When the userId is invalidRemoteException
-
getIntegratedAppPermissionsForProject
public String[] getIntegratedAppPermissionsForProject(String sessionId, String projectId, String linkId) throws RemoteException
Description copied from interface:IRbacAppSoapReturns integratedApp permissions for the user associated with a project- Specified by:
getIntegratedAppPermissionsForProjectin interfaceIRbacAppSoap- Parameters:
sessionId- User session key.projectId- the projectIdlinkId- the linkId between integrated app and project- Returns:
- String array of permissions for given integrated application
- Throws:
InvalidSessionFault- when the specified session id is invalid.NoSuchObjectFaultRemoteException
-
getIntegratedAppPermissions
public IntegratedAppProjectPermissionSoapList getIntegratedAppPermissions(String sessionId, String[] projectIds, String baseUrl) throws RemoteException
Description copied from interface:IRbacAppSoapReturns list of integratedApp permissions for the user associated with specified projects- Specified by:
getIntegratedAppPermissionsin interfaceIRbacAppSoap- Parameters:
sessionId- User session key.projectIds- the projectIdsbaseUrl- the base url of the integrated application- Returns:
- List of integrated application permission on the specified projects for current user
- Throws:
IllegalArgumentFault- when baseUrl is null or emptyInvalidSessionFault- when the specified session id is invalid.NoSuchObjectFault- when the specified baseUrl is invalidSystemFault- when an unexpected system error occursRemoteException
-
-