Package com.collabnet.ce.soap60.webservices.rbac

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

  • Constructor Details

    • RbacAppSoapStub

      public RbacAppSoapStub(String soapServerUrl)

  • Method Details

    • createRole

      public RoleSoapDO createRole(String sessionId, String projectOrProjectGroupId, String title, String description, boolean preventInheritance, boolean requestable, boolean autoGrant) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Creates a role in a given project
      Specified by:
      createRole in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      projectOrProjectGroupId - The project /project group Id to create the role in
      title - The title of the role
      description - A description of the role
      preventInheritance - If the role's permission is prevented from applying to private subprojects.
      requestable - If the role is available upon request
      autoGrant - If the role is granted automatically on request
      Returns:
      The Role2SoapDO that was created
      Throws:
      RemoteException

    • createSiteWideRole

      public RoleSoapDO createSiteWideRole(String sessionId, String title, String description, boolean preventInheritance) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Creates a site-wide role. Users with site-admin permissions
      Specified by:
      createSiteWideRole in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      title - The title of the site-wide role
      description - A description of the role
      preventInheritance - If the role's permission is prevented from applying to private projects.
      Returns:
      The Role2SoapDO that was created
      Throws:
      RemoteException

    • createGlobalRole

      public RoleSoapDO createGlobalRole(String sessionId, String title, String description, boolean preventInheritance, boolean requestable) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Creates a global role. Only Super-users or users having Role-Create permission can create global role.
      Specified by:
      createGlobalRole in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      title - The title of the global role
      description - The description of the global role
      preventInheritance - 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:
      RemoteException

    • setRoleData

      public void setRoleData(String sessionId, RoleSoapDO roleData) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Saves a role object.
      Specified by:
      setRoleData in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleData - the role object to save
      Throws:
      RemoteException

    • getRoleData

      public RoleSoapDO getRoleData(String sessionId, String roleId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Get a role data.
      Specified by:
      getRoleData in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - The id of the role to be fetch
      Returns:
      The RoleSoapDO that was fetched
      Throws:
      RemoteException

    • deleteRole

      public void deleteRole(String sessionId, String roleId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Deletes a role.
      Specified by:
      deleteRole in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - The id of the role to be deleted
      Throws:
      RemoteException

    • addCluster

      public void addCluster(String sessionId, String roleId, String operationCluster, String folderId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Adds an operation cluster to a role, expanding the permission set that the role grants access to.
      Specified by:
      addCluster in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - The role id to add the cluster to
      operationCluster - The cluster name to add to the role. See OperationClusterConstants.
      folderId - the folder id for the specified cluster.
      Throws:
      RemoteException

    • addIntegratedApplicationPermission

      public void addIntegratedApplicationPermission(String sessionId, String roleId, String integratedAppName, String permission) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Adds an integrated application permission to a role, expanding the permission set that the role grants access to.
      Specified by:
      addIntegratedApplicationPermission in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - The role id to add the integrated application permission to
      integratedAppName - The integrated application name (e.g: 'Pebble Blog')
      permission - The integrated application permission name to add to the role.
      Throws:
      RemoteException

    • removeIntegratedApplicationPermission

      public void removeIntegratedApplicationPermission(String sessionId, String roleId, String integratedAppName, String permission) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Removes an integrated application permission from the given role.
      Specified by:
      removeIntegratedApplicationPermission in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - The role id from which the integrated application permission to be removed
      integratedAppName - The integrated application name (e.g: 'Pebble Blog')
      permission - The integrated application permission to be removed from the role.
      Throws:
      RemoteException

    • removeCluster

      public void removeCluster(String sessionId, String roleId, String operationCluster, String folderId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Removes an operation cluster to a role, removing the permission set.
      Specified by:
      removeCluster in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - The role id to remove the cluster to
      operationCluster - The cluster name to add to the role
      folderId - the folder id for the specified cluster.
      Throws:
      RemoteException

    • listClusters

      public RoleClusterSoapList listClusters(String sessionId, String roleId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Gets the list of operation cluster assigned to a role.
      Specified by:
      listClusters in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - The ID of the role for which clusters will be listed
      Returns:
      list of clusters for a role
      Throws:
      RemoteException

    • listClusterForDefaultAccessPermissions

      public RoleCluster2SoapList listClusterForDefaultAccessPermissions(String sessionId, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Gets the list of operation cluster with default access permission.
      Specified by:
      listClusterForDefaultAccessPermissions in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      projectId - The ID of the project for which clusters will be listed
      Returns:
      list of clusters for a project
      Throws:
      RemoteException

    • addUser

      public void addUser(String sessionId, String roleId, String username) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Adds a user to the role, giving them all of the permissions of that role
      Specified by:
      addUser in interface IRbacAppSoap
      Parameters:
      sessionId - User sessionId
      roleId - The role id to add the user to
      username - The username of the user to add to the role
      Throws:
      RemoteException

    • grantRolesToMembers

      public void grantRolesToMembers(String sessionId, UserRolesSoapDO[] userRolesSoapDOs, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Grants roles to list of users in a given project and user is made as member of the project if not already.
      Specified by:
      grantRolesToMembers in interface IRbacAppSoap
      Parameters:
      sessionId - User sessionId
      userRolesSoapDOs - user to roles data container
      projectId - project to which users would be the members with the given roles.
      Throws:
      RemoteException

    • removeUser

      public void removeUser(String sessionId, String roleId, String username) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Removes a user from a role
      Specified by:
      removeUser in interface IRbacAppSoap
      Parameters:
      sessionId - User sessionId
      roleId - The role id to add the user to
      username - The username of the user to add to the role
      Throws:
      RemoteException

    • revokeRolesFromMembers

      public void revokeRolesFromMembers(String sessionId, UserRolesSoapDO[] userRolesSoapDOs, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Removes roles from users in the project
      Specified by:
      revokeRolesFromMembers in interface IRbacAppSoap
      Parameters:
      sessionId - User sessionId
      userRolesSoapDOs - user to roles data container
      projectId - project in which roles would be removed from the users.
      Throws:
      RemoteException

    • addUserToProjectRole

      public void addUserToProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Adds a user to the role in the given project context
      Specified by:
      addUserToProjectRole in interface IRbacAppSoap
      Parameters:
      sessionId - User sessionId
      roleId - The role id to add the user to
      username - The username of the user to add to the role
      projectOrProjectGroupId - projectId (or) Project group ID.
      Throws:
      RemoteException
      See Also:

    • removeUserFromProjectRole

      public void removeUserFromProjectRole(String sessionId, String roleId, String username, String projectOrProjectGroupId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Removes a user from a role in the given project
      Specified by:
      removeUserFromProjectRole in interface IRbacAppSoap
      Parameters:
      sessionId - User sessionId
      roleId - The role id to add the user to
      username - The username of the user to add to the role
      projectOrProjectGroupId - projectId (or) Project group ID.
      Throws:
      RemoteException
      See Also:

    • addGroup

      public void addGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Adds a user group to a role, within the Project/ProjectGroup scope.
      Specified by:
      addGroup in interface IRbacAppSoap
      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:
      RemoteException

    • removeGroup

      public void removeGroup(String sessionId, String groupId, String roleId, String projectOrProjectGroupId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Removes the user group for the role, within the Project/ProjectGroup scope
      Specified by:
      removeGroup in interface IRbacAppSoap
      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:
      RemoteException

    • getRoleList

      public RoleSoapList getRoleList(String sessionId, String projectOrProjectGroupId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Gets a list of Roles in a project context. This call required project admin permissions.
      Specified by:
      getRoleList in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      projectOrProjectGroupId - The Project/Project Group Id to list roles from
      Returns:
      The RoleSoapList describing all roles in the project
      Throws:
      RemoteException

    • getInheritedRoleList

      public RoleSoapList getInheritedRoleList(String sessionId, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Gets a list of roles inherited from any of the parent projects. This call requires project admin permission.
      Specified by:
      getInheritedRoleList in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      projectId - The project Id to list the inherited roles from
      Returns:
      The Role2SoapList describing all inherited roles in the project
      Throws:
      RemoteException

    • getRoleMemberList

      public UserSoapList getRoleMemberList(String sessionId, String roleId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of users that are assigned to the specified role.
      Specified by:
      getRoleMemberList in interface IRbacAppSoap
      Parameters:
      sessionId - User session id.
      roleId - Role id.
      Returns:
      List of users in the specified role.
      Throws:
      RemoteException

    • getProjectRoleMemberList

      public UserSoapList getProjectRoleMemberList(String sessionId, String roleId, String projectOrProjectGroupId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of users that are in a specified role in the given project or project group.
      Specified by:
      getProjectRoleMemberList in interface IRbacAppSoap
      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:
      RemoteException

    • getUserRoleList

      public RoleSoapList getUserRoleList(String sessionId, String projectOrProjectGroupId, String username) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of roles that a user is a member of in the specified project or project group.
      Specified by:
      getUserRoleList in interface IRbacAppSoap
      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:
      RemoteException

    • getUserSiteWideRoleList

      public RoleSoapList getUserSiteWideRoleList(String sessionId, String username) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of roles that a user is a member of site wide role.
      Specified by:
      getUserSiteWideRoleList in interface IRbacAppSoap
      Parameters:
      sessionId - User session id.
      username - Name of the user.
      Returns:
      List of site-wide roles that a user is a member of.
      Throws:
      RemoteException

    • getSiteWideRoleList

      public RoleSoapList getSiteWideRoleList(String sessionId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of all the site-wide roles available on the site.
      Specified by:
      getSiteWideRoleList in interface IRbacAppSoap
      Parameters:
      sessionId - User session id.
      Returns:
      List of site-wide roles available
      Throws:
      RemoteException

    • getGlobalRoleList

      public RoleSoapList getGlobalRoleList(String sessionId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of all the global roles available on the site.
      Specified by:
      getGlobalRoleList in interface IRbacAppSoap
      Parameters:
      sessionId - User session id.
      Returns:
      List of global roles available
      Throws:
      RemoteException

    • getGlobalRolesForAssignment

      public RoleSoapList getGlobalRolesForAssignment(String sessionId, String projectOrProjectGroupId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of global roles available in the project or project group for user/user group assignment.
      Specified by:
      getGlobalRolesForAssignment in interface IRbacAppSoap
      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:
      RemoteException

    • getGroupRoleList

      public RoleSoapList getGroupRoleList(String sessionId, String groupId, String projectIdOrProjectGroupId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of roles the user group is associated with in a project or projectGroup.
      Specified by:
      getGroupRoleList in interface IRbacAppSoap
      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:
      RemoteException

    • getRoleGroupList

      public UserGroupSoapList getRoleGroupList(String sessionId, String roleId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of user groups that belong to the specified role.
      Specified by:
      getRoleGroupList in interface IRbacAppSoap
      Parameters:
      sessionId - User session id.
      roleId - Role id.
      Returns:
      List of user groups associated with a role.
      Throws:
      RemoteException

    • listGroupRolesByProject

      public RoleGroupSoapList listGroupRolesByProject(String sessionId, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of user groups and the roles it is associated with in a project.
      Specified by:
      listGroupRolesByProject in interface IRbacAppSoap
      Parameters:
      sessionId - User session id.
      projectId - Project id.
      Returns:
      list of user groups and the roles it is associated with
      Throws:
      RemoteException

    • getRoleGroupUsers

      public UserSoapList getRoleGroupUsers(String sessionId, String projectIdOrProjectGroupId, String roleId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of users who are part of a group and associated with the specified role.
      Specified by:
      getRoleGroupUsers in interface IRbacAppSoap
      Parameters:
      sessionId - User session id.
      projectIdOrProjectGroupId - Project or Project Group's id.
      roleId - Role id.
      Returns:
      List of users in the specified role.
      Throws:
      RemoteException

    • listRolePaths

      public SoapNamedValues listRolePaths(String sessionId, String roleId, String repositoryId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Gets the list of paths for a role.
      Specified by:
      listRolePaths in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - the key of the role the role paths belongs to
      repositoryId - the repository id
      Returns:
      role path in soap named values format
      Throws:
      RemoteException

    • setRolePaths

      public void setRolePaths(String sessionId, String roleId, String repositoryId, SoapNamedValues rolePaths) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Sets the list of paths for a role.
      Specified by:
      setRolePaths in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - the key of the role the role paths belongs to
      repositoryId - the repository id
      rolePaths - list of role paths
      Throws:
      RemoteException

    • getProjectsForAction

      public ProjectSoapList getProjectsForAction(String sessionId, String operationString, String userName) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Gets the list of all projects in which the given user has given permission.
      Specified by:
      getProjectsForAction in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      operationString - Operation in format type.category.name
      userName - the user who would have cluster permission in the returned project list
      Returns:
      List of projects
      Throws:
      RemoteException

    • requestRole

      public void requestRole(String sessionId, String roleId, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Requests a role
      Specified by:
      requestRole in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - the role id
      projectId - project in which to make the request
      Throws:
      RemoteException

    • setAutomaticallyGrantOnRequest

      public void setAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId, boolean autoGrant) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Sets the role's Automatically Grant On Request for the given project.
      Specified by:
      setAutomaticallyGrantOnRequest in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - the role id
      projectId - the project to which automatically grant property to be set
      autoGrant - true to set it available upon request
      Throws:
      RemoteException

    • getAutomaticallyGrantOnRequest

      public boolean getAutomaticallyGrantOnRequest(String sessionId, String roleId, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Gets the role's Automatically Grant On Request for the given project.
      Specified by:
      getAutomaticallyGrantOnRequest in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      roleId - the role id
      projectId - the project to which automatically grant property to be set
      Returns:
      Auto grant flag of role
      Throws:
      RemoteException

    • getPendingRequestedRoles

      public RoleRequestSoapList getPendingRequestedRoles(String sessionId, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Lists the pending requested roles for the given projectId
      Specified by:
      getPendingRequestedRoles in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      projectId - project in which the pending requested roles needs to be retrieved
      Returns:
      List of pending requested roles.
      Throws:
      RemoteException

    • approveRoleRequest

      public void approveRoleRequest(String sessionId, String requestId, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Approves a role request
      Specified by:
      approveRoleRequest in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      requestId - Role request Id
      projectId - project in which the role request was raised
      Throws:
      RemoteException

    • rejectRoleRequest

      public void rejectRoleRequest(String sessionId, String requestId, String projectId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Rejects a role request
      Specified by:
      rejectRoleRequest in interface IRbacAppSoap
      Parameters:
      sessionId - User session Id
      requestId - Role request Id
      projectId - project in which the role request was raised
      Throws:
      RemoteException

    • listGroupRolesByProjectGroup

      public RoleGroupSoapList listGroupRolesByProjectGroup(String sessionId, String projectGroupId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns a list of user groups and the roles it is associated with in a project group.
      Specified by:
      listGroupRolesByProjectGroup in interface IRbacAppSoap
      Parameters:
      sessionId - User session id.
      projectGroupId - Project group id.
      Returns:
      list of user groups and the roles it is associated with
      Throws:
      RemoteException

    • getProjectsByIntegratedAppPermission

      public String[] getProjectsByIntegratedAppPermission(String sessionId, String perm, String integratedAppName) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns the list of projects by integratedApp permission.
      Specified by:
      getProjectsByIntegratedAppPermission in interface IRbacAppSoap
      Parameters:
      sessionId - User session key.
      perm - permission criteria
      integratedAppName - the IntegratedApp plugName.
      Returns:
      string array of id of projects in which the current user has given permission to given integrated app.
      Throws:
      RemoteException

    • getIntegratedAppPermissionsForProject

      public String[] getIntegratedAppPermissionsForProject(String sessionId, String projectId, String linkId) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns integratedApp permissions for the user associated with a project
      Specified by:
      getIntegratedAppPermissionsForProject in interface IRbacAppSoap
      Parameters:
      sessionId - User session key.
      projectId - the projectId
      linkId - the linkId between integrated app and project
      Returns:
      String array of permissions for given integrated application
      Throws:
      RemoteException

    • getIntegratedAppPermissions

      public IntegratedAppProjectPermissionSoapList getIntegratedAppPermissions(String sessionId, String[] projectIds, String baseUrl) throws RemoteException
      Description copied from interface: IRbacAppSoap
      Returns list of integratedApp permissions for the user associated with specified projects
      Specified by:
      getIntegratedAppPermissions in interface IRbacAppSoap
      Parameters:
      sessionId - User session key.
      projectIds - the projectIds
      baseUrl - the base url of the integrated application
      Returns:
      List of integrated application permission on the specified projects for current user
      Throws:
      RemoteException