Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.vasoftware.sf.soap44.webservices.sfmain
Interface ISourceForgeSoap

public interface ISourceForgeSoap

The web service providing the core SourceForge functionality, such as authentication, project and membership information, etc.

Change History
Version 4.4

Since:
4.1

Method Summary
 void addProjectMember(java.lang.String sessionId, java.lang.String projectId, java.lang.String userName)
          Make a user a member of a project.
 void createAssociation(java.lang.String sessionId, java.lang.String originId, java.lang.String targetId, java.lang.String description)
          Creates an association between two objects
 ProjectSoapDO createProject(java.lang.String sessionId, java.lang.String name, java.lang.String title, java.lang.String description)
          Create a project.
 ProjectSoapDO createProjectFromTemplate(java.lang.String sessionId, java.lang.String templateId, java.lang.String name, java.lang.String title, java.lang.String description)
          Create a project from template.
 UserSoapDO createUser(java.lang.String sessionId, java.lang.String userName, java.lang.String email, java.lang.String fullName, java.lang.String locale, java.lang.String timeZone, boolean isSuperUser, boolean isRestrictedUser, java.lang.String password)
          Creates a new user with the specified parameters.
 void deleteAssociation(java.lang.String sessionId, java.lang.String originId, java.lang.String targetId)
          Deletes an association between two objects
 void deleteProject(java.lang.String sessionId, java.lang.String projectId)
          Delete a project.
 ProjectSoapList findProjects(java.lang.String sessionId, java.lang.String queryString)
          Finds a list of projects matching a search string.
 UserSoapList findUsers(java.lang.String sessionId, java.lang.String queryString)
          Finds a list of users matching a search string.
 java.lang.String getApiVersion()
          Get SourceForge API version.
 AssociationSoapList getAssociationList(java.lang.String sessionId, java.lang.String objectId)
          List all of the associations for a given object.
 AuditHistorySoapList getAuditHistoryList(java.lang.String sessionId, java.lang.String objectId)
          Returns the list of changes made to the specified object in reverse chronological order.
 CommentSoapList getCommentList(java.lang.String sessionId, java.lang.String objectId)
          Gets list of comments for object.
 int getProjectAccessLevel(java.lang.String sessionId, java.lang.String projectId)
          Get the project's access level.
 ProjectSoapDO getProjectData(java.lang.String sessionId, java.lang.String projectId)
          Returns project data.
 long getProjectDiskUsage(java.lang.String sessionId, java.lang.String projectId)
          Get the filestorage disk utilization of a project specified by a project id
 ProjectSoapList getProjectList(java.lang.String sessionId)
          Returns a list of all projects visible to the user.
 ProjectMemberSoapList getProjectMemberList(java.lang.String sessionId, java.lang.String projectId)
          Returns project membership list.
 long getProjectQuota(java.lang.String sessionId, java.lang.String projectId)
          Get the disk quota for a project.
 UserSoapDO getUserData(java.lang.String sessionId, java.lang.String username)
          Returns the user information.
 UserSoapList getUserList(java.lang.String sessionId, SoapFilter filter)
          Get a list of all users on the system.
 ProjectSoapList getUserProjectList(java.lang.String sessionId)
          Returns a list of projects this user is a member of.
 java.lang.String getVersion(java.lang.String sessionId)
          Get SourceForge version.
 VersionInformationSoapList getVersionInformationList(java.lang.String sessionId, java.lang.String folderId)
          Obtains a list of versions and last modified dates for the objects residing in the specified folder.
 boolean hasPermission(java.lang.String sessionId, java.lang.String projectId, java.lang.String operationString, java.lang.String objectId)
          Check whether the current user has permission for an operation on a specified object
 boolean isHostedMode(java.lang.String sessionId)
          Verify if the SourceForge appserver is running in Hosted Mode.
 void keepAlive(java.lang.String sessionId)
          Keeps a session alive. this is a no-op that just validates the session and updates its last used time.
 ProjectSoapList listTemplates(java.lang.String sessionId)
          List project templates within the installation.
 java.lang.String login(java.lang.String userName, java.lang.String password)
          Logs in a user and creates a new session.
 java.lang.String loginAnonymous(java.lang.String anonSharedSecret)
          This method allows to login as anonymous to get CollabNet SourceForge Enterprise default acceess.
 java.lang.String loginWithToken(java.lang.String username, java.lang.String oneTimeToken)
          Logs in a user and creates a new session.
 void logoff(java.lang.String userName, java.lang.String sessionId)
          Ends a user's session.
 void reindexObject(java.lang.String sessionId, java.lang.String objectId)
          Re-indexes the contents of the specified project, folder, item or user.
 void removeProjectMember(java.lang.String sessionId, java.lang.String projectId, java.lang.String userName)
          Remove a user from a project.
 void setProjectAccessLevel(java.lang.String sessionId, java.lang.String projectId, int accessLevel)
          Set the project access level to public (all users can view the project).
 void setProjectQuota(java.lang.String sessionId, java.lang.String projectId, long quota)
          Get the disk quota for a project.
 void setUserData(java.lang.String sessionId, UserSoapDO userData)
          Sets the user information.
 

Method Detail

getVersion

java.lang.String getVersion(java.lang.String sessionId)
                            throws java.rmi.RemoteException
Get SourceForge version. NOTE: In earlier version of SourceForge, this call returned a symbolic name for the version. It is now replaced with the actual version of the product as seen in the "About SourceForge" dialog.

Returns:
Version as string.
Throws:
java.rmi.RemoteException
Since:
4.1

getApiVersion

java.lang.String getApiVersion()
                               throws java.rmi.RemoteException
Get SourceForge API version. This is different from the Sourceforge Version and can be changed independent of that. IMPORTANT: note that the api version string returned CAN be updated between releases. Therefore it is very important to perform proper version checking against the version returned. This is because we may introduce new API calls as additional features are added to our product. However we guarantee that subsequent releases will not change existing API signatures or SOAP structures. The version returned will be a period separated string with the following format: - The first two fields represent the SourceForge release version number. For example, "4.3" equates to SourceForge 4.3 - The third field, if present, will represent service pack version. - The fourth field, if present, will represent the hot fix version. Example: 4.3 => SourceForge 4.3 4.3.0.2 => SourceForge 4.3 Hotfix2 4.3.2 => SourceForge 4.3 SP2 So a call that existed in 4.3 is guaranteed to exist in 4.3.2. One in 4.3.0.2 will also work in 4.3.2.

Returns:
API version as string.
Throws:
java.rmi.RemoteException
Since:
4.1-HOTFIX2

keepAlive

void keepAlive(java.lang.String sessionId)
               throws java.rmi.RemoteException
Keeps a session alive. this is a no-op that just validates the session and updates its last used time.

Parameters:
sessionId - the session id.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
java.rmi.RemoteException
Since:
4.1

loginAnonymous

java.lang.String loginAnonymous(java.lang.String anonSharedSecret)
                                throws java.rmi.RemoteException
This method allows to login as anonymous to get CollabNet SourceForge Enterprise default acceess. To make sure this method does not really leave a security hole, a shared security is used. To use method, the following property must be added into sourceforge.properties sfmain.integration.security.shared_secret=aSecret

Parameters:
anonSharedSecret - Shared secret for anonymous login. Its value must match the value set for sfmain.integration.security.shared_secret property set in sourceforge.properties file.
Returns:
User session key.
Throws:
com.vasoftware.sf.soap44.fault.LoginFault - when the login information is incorrect.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.4

login

java.lang.String login(java.lang.String userName,
                       java.lang.String password)
                       throws java.rmi.RemoteException
Logs in a user and creates a new session.

Parameters:
userName - Name of the user.
password - User password.
Returns:
User session key.
Throws:
com.vasoftware.sf.soap44.fault.LoginFault - when the login information is incorrect.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

loginWithToken

java.lang.String loginWithToken(java.lang.String username,
                                java.lang.String oneTimeToken)
                                throws java.rmi.RemoteException
Logs in a user and creates a new session.

Parameters:
username - Name of the user.
oneTimeToken - a one time token for login.
Returns:
User session key.
Throws:
com.vasoftware.sf.soap44.fault.LoginFault - when the login information is incorrect.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.2

logoff

void logoff(java.lang.String userName,
            java.lang.String sessionId)
            throws java.rmi.RemoteException
Ends a user's session.

Parameters:
userName - User's name.
sessionId - Session id.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

hasPermission

boolean hasPermission(java.lang.String sessionId,
                      java.lang.String projectId,
                      java.lang.String operationString,
                      java.lang.String objectId)
                      throws java.rmi.RemoteException
Check whether the current user has permission for an operation on a specified object

Parameters:
sessionId - The current user session id
projectId - The project in which the operation is defined
operationString - The string representation of the operation. This should be in the format ... For a list of operation strings for various object types, see OperationConstants interface.
objectId - The object for which we are doing the permission check. Null if we're checking permission on the app folder of a project
Returns:
whether the current user has permission for an operation on a specified object
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - The specified projectId or folderId was invalid
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.
com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If the operationString is in an invalid format
java.rmi.RemoteException
Since:
4.1-HOTFIX2
See Also:
OperationConstants

getProjectList

ProjectSoapList getProjectList(java.lang.String sessionId)
                               throws java.rmi.RemoteException
Returns a list of all projects visible to the user. IMPORTANT: In 4.1, this call returned ONLY projects of which the user is a member of. Use getUserProjectList() for getting a list of projects in which the user is a member.

Parameters:
sessionId - User session key.
Returns:
List of projects
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.
java.rmi.RemoteException
Since:
4.1

getUserProjectList

ProjectSoapList getUserProjectList(java.lang.String sessionId)
                                   throws java.rmi.RemoteException
Returns a list of projects this user is a member of.

Parameters:
sessionId - User session key.
Returns:
List of user projects.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.
java.rmi.RemoteException
Since:
4.1-SP3

createProject

ProjectSoapDO createProject(java.lang.String sessionId,
                            java.lang.String name,
                            java.lang.String title,
                            java.lang.String description)
                            throws java.rmi.RemoteException
Create a project. NOTE: This method is only available in CollabNet SourceForge Enterprise.

Parameters:
sessionId - User session key.
name - The name of the project (can be null, will fall back to title or id)
title - The title of the project
description - The description of the project
Returns:
The project data
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - when the project with that name already exists.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.lang.IllegalArgumentException - Invalid data was passed in
java.rmi.RemoteException
Since:
4.2-SP1

createProjectFromTemplate

ProjectSoapDO createProjectFromTemplate(java.lang.String sessionId,
                                        java.lang.String templateId,
                                        java.lang.String name,
                                        java.lang.String title,
                                        java.lang.String description)
                                        throws java.rmi.RemoteException
Create a project from template. NOTE: This method is only available in CollabNet SourceForge Enterprise.

Parameters:
sessionId - User session key.
templateId - The template project id
name - The name of the project (can be null, will fall back to title or id)
title - The title of the project
description - The description of the project
Returns:
The project data
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - when the project with that name already exists.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.2-SP1

listTemplates

ProjectSoapList listTemplates(java.lang.String sessionId)
                              throws java.rmi.RemoteException
List project templates within the installation. NOTE: This method is only available in CollabNet SourceForge Enterprise.

Parameters:
sessionId - User session key.
Returns:
The list of template projects
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - when the project with that name already exists.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.2-SP1

findProjects

ProjectSoapList findProjects(java.lang.String sessionId,
                             java.lang.String queryString)
                             throws java.rmi.RemoteException
Finds a list of projects matching a search string.

Parameters:
sessionId - User session id.
queryString - Query string.
Returns:
List of projects matching search criteria.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.
com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when the query string is invalid.
java.rmi.RemoteException
Since:
4.1

getProjectData

ProjectSoapDO getProjectData(java.lang.String sessionId,
                             java.lang.String projectId)
                             throws java.rmi.RemoteException
Returns project data.

Parameters:
sessionId - User session key.
projectId - Project id.
Returns:
Project data.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

getProjectMemberList

ProjectMemberSoapList getProjectMemberList(java.lang.String sessionId,
                                           java.lang.String projectId)
                                           throws java.rmi.RemoteException
Returns project membership list.

Parameters:
sessionId - User session id.
projectId - Id of the project.
Returns:
Members of project.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

addProjectMember

void addProjectMember(java.lang.String sessionId,
                      java.lang.String projectId,
                      java.lang.String userName)
                      throws java.rmi.RemoteException
Make a user a member of a project. NOTE: This method is only available in CollabNet SourceForge Enterprise.

Parameters:
sessionId - User session id.
projectId - Id of the project.
userName - Name of the new user.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user doesn't have permission for this call.
java.rmi.RemoteException
Since:
4.3

removeProjectMember

void removeProjectMember(java.lang.String sessionId,
                         java.lang.String projectId,
                         java.lang.String userName)
                         throws java.rmi.RemoteException
Remove a user from a project. NOTE: This method is only available in CollabNet SourceForge Enterprise.

Parameters:
sessionId - User session id.
projectId - Id of the project.
userName - Name of the new user.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
com.vasoftware.sf.soap44.fault.RemoveOnlyProjectAdminFault - attempting to remove last project admin
java.rmi.RemoteException
Since:
4.3 hotfix5

createUser

UserSoapDO createUser(java.lang.String sessionId,
                      java.lang.String userName,
                      java.lang.String email,
                      java.lang.String fullName,
                      java.lang.String locale,
                      java.lang.String timeZone,
                      boolean isSuperUser,
                      boolean isRestrictedUser,
                      java.lang.String password)
                      throws java.rmi.RemoteException
Creates a new user with the specified parameters. NOTE: Only super-users are allowed to create users through SOAP interface.

Parameters:
sessionId - User's session id.
userName - Name of the new user.
email - Email of the new user.
fullName - Full name of the new user.
locale - Locale of the new user (currently supported locales are "en" for English, "ja" for Japanese).
timeZone - User's time zone. The ID for a TimeZone, either an abbreviation such as "PST", a full name such as "America/Los_Angeles", or a custom ID such as "GMT-8:00".
isSuperUser - Should user be given super-user privileges?
isRestrictedUser - Should user be given restricted privileges?
password - Password of the new user.
Returns:
Newly created user object.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - when the specified user already exists.
com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when one or more user parameters are invalid.
com.vasoftware.sf.soap44.fault.UserLimitExceededFault - The user limit was exceeded
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.1

getUserData

UserSoapDO getUserData(java.lang.String sessionId,
                       java.lang.String username)
                       throws java.rmi.RemoteException
Returns the user information.

Parameters:
sessionId - User session id.
username - User name (login name)
Returns:
User data.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.
com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If the username is invalid
java.rmi.RemoteException
Since:
4.2

setUserData

void setUserData(java.lang.String sessionId,
                 UserSoapDO userData)
                 throws java.rmi.RemoteException
Sets the user information. NOTE: Only super-users are allowed to set user data.

Parameters:
sessionId - User session id.
userData - User data
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.
com.vasoftware.sf.soap44.fault.VersionMismatchFault - The user version being edited is not the latest one
com.vasoftware.sf.soap44.fault.ActivationUserAlreadyRemovedFault - This user is a removed user and cannot be activated
com.vasoftware.sf.soap44.fault.LastSuperUserFault - The user being edited is th last super user and cannot be un-superusered
com.vasoftware.sf.soap44.fault.IllegalUserModificationFault - If someone tried to edit a restricted property on a special user (like the status on the admin user).
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - if the user does not have permission to do this (only site admins can perform this operation)
com.vasoftware.sf.soap44.fault.VersionMismatchFault - when object data is stale
java.rmi.RemoteException
Since:
4.3

findUsers

UserSoapList findUsers(java.lang.String sessionId,
                       java.lang.String queryString)
                       throws java.rmi.RemoteException
Finds a list of users matching a search string.

Parameters:
sessionId - User session id.
queryString - Query string.
Returns:
List of users matching search criteria.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.
com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when the query string is invalid.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.
java.rmi.RemoteException
Since:
4.1

getUserList

UserSoapList getUserList(java.lang.String sessionId,
                         SoapFilter filter)
                         throws java.rmi.RemoteException
Get a list of all users on the system. At this time, the filter parameters are ignured. In a future release, the lists will allow the results to be filtered.

Parameters:
sessionId - User session id.
filter - Search filter.
Returns:
List of users matching a filter.
Throws:
com.vasoftware.sf.soap44.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.
java.rmi.RemoteException
Since:
4.3

getProjectAccessLevel

int getProjectAccessLevel(java.lang.String sessionId,
                          java.lang.String projectId)
                          throws java.rmi.RemoteException
Get the project's access level. Need to be project or site admin. NOTE: This method is only available in CollabNet SourceForge Enterprise.

Parameters:
sessionId - User session Id
projectId - The project Id
Returns:
The project access level.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the project id is not a valid project id
java.rmi.RemoteException
Since:
4.1-HOTFIX6.1
See Also:
ProjectSoapDO.PUBLIC, ProjectSoapDO.GATED_COMMUNITY, ProjectSoapDO.PRIVATE

setProjectAccessLevel

void setProjectAccessLevel(java.lang.String sessionId,
                           java.lang.String projectId,
                           int accessLevel)
                           throws java.rmi.RemoteException
Set the project access level to public (all users can view the project). NOTE: This method is only available in CollabNet SourceForge Enterprise.

Parameters:
sessionId - User session Id
projectId - The project Id
accessLevel - The access level to set the project to
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is invalid
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the project id is not a valid project id
com.vasoftware.sf.soap44.fault.IllegalArgumentFault - When the accessLevel is invalid
java.rmi.RemoteException
Since:
4.1-HOTFIX6.1

getCommentList

CommentSoapList getCommentList(java.lang.String sessionId,
                               java.lang.String objectId)
                               throws java.rmi.RemoteException
Gets list of comments for object.

Parameters:
sessionId - User session id.
objectId - Object id.
Returns:
List of comments.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - When the specified session id is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - When the object id is not valid
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation
com.vasoftware.sf.soap44.fault.SystemFault - When an unexpected system level error occurs.
java.rmi.RemoteException
Since:
4.2

createAssociation

void createAssociation(java.lang.String sessionId,
                       java.lang.String originId,
                       java.lang.String targetId,
                       java.lang.String description)
                       throws java.rmi.RemoteException
Creates an association between two objects

Parameters:
sessionId - User session id.
originId - the origin object's id
targetId - the target object'd id
description - the description for the association
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - if the user's session is not valid
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - if the user does not have permission to create the association
com.vasoftware.sf.soap44.fault.SystemFault - if an unexpected system error occurs
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - if the origin or target objects do not exist
com.vasoftware.sf.soap44.fault.IllegalArgumentFault - if a valid association cannot be created between the given objects
java.rmi.RemoteException
Since:
4.1

deleteAssociation

void deleteAssociation(java.lang.String sessionId,
                       java.lang.String originId,
                       java.lang.String targetId)
                       throws java.rmi.RemoteException
Deletes an association between two objects

Parameters:
sessionId - User session id.
originId - the origin object's id
targetId - the target object'd id
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - if the user's session is not valid
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - if the user does not have permission to delete the association
com.vasoftware.sf.soap44.fault.SystemFault - if an unexpected system error occurs
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - if the origin or target objects do not exist
com.vasoftware.sf.soap44.fault.IllegalArgumentFault - if an association does not exist between the given objects
java.rmi.RemoteException
Since:
4.2

deleteProject

void deleteProject(java.lang.String sessionId,
                   java.lang.String projectId)
                   throws java.rmi.RemoteException
Delete a project. NOTE: This method is only available in CollabNet SourceForge Enterprise.

Parameters:
sessionId - User session key.
projectId - The id of the project to be deleted
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - if we can't find the project with the specified projectid
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.
java.rmi.RemoteException
Since:
4.3

getAssociationList

AssociationSoapList getAssociationList(java.lang.String sessionId,
                                       java.lang.String objectId)
                                       throws java.rmi.RemoteException
List all of the associations for a given object.

Parameters:
sessionId - The current session id.
objectId - The id of the object that has associations.
Returns:
A list of associations for the given object.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is not valid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - If the object does not exist or is deleted.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If you are not allowed to view the object or its associations.
com.vasoftware.sf.soap44.fault.SystemFault - If an unexpected error occurs.
java.rmi.RemoteException
Since:
4.2

getAuditHistoryList

AuditHistorySoapList getAuditHistoryList(java.lang.String sessionId,
                                         java.lang.String objectId)
                                         throws java.rmi.RemoteException
Returns the list of changes made to the specified object in reverse chronological order. The entries returned include all updates to an object but does not include the object creation itself. NOTE: The object must be either a task or an artifact. All other object types result in a IllegalArgumentFault.

Parameters:
sessionId - The current session id.
objectId - ID of the object.
Returns:
List of changes made to the specified object.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session is not valid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - If the object does not exist or is deleted.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If you are not allowed to view the object or its associations.
com.vasoftware.sf.soap44.fault.SystemFault - If an unexpected error occurs.
com.vasoftware.sf.soap44.fault.IllegalArgumentFault - If the objectId is not a task or an artifact.
java.rmi.RemoteException
Since:
4.1-SP3

getVersionInformationList

VersionInformationSoapList getVersionInformationList(java.lang.String sessionId,
                                                     java.lang.String folderId)
                                                     throws java.rmi.RemoteException
Obtains a list of versions and last modified dates for the objects residing in the specified folder.

Parameters:
sessionId - Soap session id
folderId - Folder to obtain the list for
Returns:
The version information
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when session id is invalid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the folder does not exist.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permissions are denied for the operation.
com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected error occurs.
java.rmi.RemoteException
Since:
4.2

reindexObject

void reindexObject(java.lang.String sessionId,
                   java.lang.String objectId)
                   throws java.rmi.RemoteException
Re-indexes the contents of the specified project, folder, item or user. CAUTION: Use this operation sparingly. Indiscriminate use can cause system overload.

Parameters:
sessionId - User session ID (must be a system administrator to perform this operation)
objectId - Project to re-index.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the user session ID is invalid or timed out.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user does not have sufficient privileges (must be a system admin).
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object ID is invalid.
java.rmi.RemoteException
Since:
4.1-SP3-HOTFIX9

isHostedMode

boolean isHostedMode(java.lang.String sessionId)
                     throws java.rmi.RemoteException
Verify if the SourceForge appserver is running in Hosted Mode.

Returns:
true if the appserver is running in Hosted Mode.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the user session ID is invalid or timed out.
java.rmi.RemoteException
Since:
4.3

getProjectDiskUsage

long getProjectDiskUsage(java.lang.String sessionId,
                         java.lang.String projectId)
                         throws java.rmi.RemoteException
Get the filestorage disk utilization of a project specified by a project id

Parameters:
sessionId - the soap session key
projectId - the id of the project
Returns:
the file storage disk usage of a project
Throws:
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - thrown if the project was not found.
com.vasoftware.sf.soap44.fault.InvalidSessionFault - thrown if the session id is not valid.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - thrown if sessionId is not a session started by an admin.
com.vasoftware.sf.soap44.fault.SystemFault - If there was a problem checking the permissions.
java.rmi.RemoteException
Since:
4.3

getProjectQuota

long getProjectQuota(java.lang.String sessionId,
                     java.lang.String projectId)
                     throws java.rmi.RemoteException
Get the disk quota for a project.

Parameters:
sessionId - The id of the current session.
projectId - The id of the project.
Returns:
The disk quota for the project.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session id is not valid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - If the project id does not exist.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user is not allowed to view this information.
com.vasoftware.sf.soap44.fault.SystemFault - If there was a problem checking the permissions.
java.rmi.RemoteException
Since:
4.3

setProjectQuota

void setProjectQuota(java.lang.String sessionId,
                     java.lang.String projectId,
                     long quota)
                     throws java.rmi.RemoteException
Get the disk quota for a project.

Parameters:
sessionId - The id of the current session.
projectId - The id of the project.
Throws:
com.vasoftware.sf.soap44.fault.InvalidSessionFault - If the session id is not valid.
com.vasoftware.sf.soap44.fault.NoSuchObjectFault - If the project id does not exist.
com.vasoftware.sf.soap44.fault.PermissionDeniedFault - If the user is not allowed to view this information.
java.rmi.RemoteException
Since:
4.3
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD