com.collabnet.helm.ws.domain
Class DomainBindingStub

java.lang.Object
  org.apache.axis.client.Stub
      com.collabnet.helm.ws.domain.DomainBindingStub

All Implemented Interfaces:

Domain, java.rmi.Remote, javax.xml.rpc.Stub

public class DomainBindingStub
extends org.apache.axis.client.Stub
implements Domain

Field Summary

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

DomainBindingStub()

DomainBindingStub(javax.xml.rpc.Service service)

DomainBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)

Method Summary

ProjectsForActionContainer	getProjectsForAction(java.lang.String action, java.lang.String username, PaginationType pagination) Returns a simple the list of projects that has the action, identified by the given action name, in one of the roles from the project's members.
ProjectsForUserContainer	getProjectsForUser(java.lang.String username, PaginationType pagination) Returns a simple the list of projects that the user, identified by the given username, has direct roles on the current domain.
ResourcesForActionContainer	getResourcesForAction(java.lang.String action, java.lang.String username, java.lang.String project) Returns a list resources associated with the given action on the given project for a given username.
UserInfoType	getUserByEmail(java.lang.String userEmail) Returns the information of a domain user by a email.
UserInfoType	getUserByName(java.lang.String userFullName) Returns the information of a domain user by a given full name.
UserInfoType	getUserByUsername(java.lang.String username) Returns the information of a domain user by a given username.
SimpleUsernameStatusType	isUserValid(java.lang.String username, java.lang.String password) Returns the status information for a given username and password.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getTimeout, getUsername, removeProperty, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setTimeout, setUsername

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DomainBindingStub

public DomainBindingStub()
                  throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

DomainBindingStub

public DomainBindingStub(java.net.URL endpointURL,
                         javax.xml.rpc.Service service)
                  throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

DomainBindingStub

public DomainBindingStub(javax.xml.rpc.Service service)
                  throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

getUserByUsername

public UserInfoType getUserByUsername(java.lang.String username)
                               throws java.rmi.RemoteException,
                                      WSException

Description copied from interface: Domain

Returns the information of a domain user by a given username.

Pre-conditions:

• The username must be valid in the current domain;
• The caller of this operation must have the permission "Project - Edit" on the project in the context.

Specified by:

getUserByUsername in interface Domain

Parameters:

username - is is the username of an existing user on the current domain.

Returns:

an instance of the user information UserInfoType

Throws:

java.rmi.RemoteException

WSException -

• 1 - if an unknown/runtime error occurs during execution
• 2 - if the webservice framework is unable to retrieve the current webservice context. This indicates a serious system error.
• 3 - if the user does not have the necessary permissions.

getUserByName

public UserInfoType getUserByName(java.lang.String userFullName)
                           throws java.rmi.RemoteException,
                                  WSException

Description copied from interface: Domain

Returns the information of a domain user by a given full name.

Pre-conditions:

• The full name matches exactly the one used by the user in the current domain;
• The caller of this operation must have the permission "Project - Edit" on the project in the context.

Specified by:

getUserByName in interface Domain

Parameters:

userFullName - is the full name of an existing user on the current domain.

Returns:

an instance of the user information UserInfoType

Throws:

java.rmi.RemoteException

WSException -

• 1 - if an unknown/runtime error occurs during execution
• 2 - if the webservice framework is unable to retrieve the current webservice context. This indicates a serious system error.
• 3 - if the user does not have the necessary permissions.

getUserByEmail

public UserInfoType getUserByEmail(java.lang.String userEmail)
                            throws java.rmi.RemoteException,
                                   WSException

Description copied from interface: Domain

Returns the information of a domain user by a email. This must be the main email address used by the user.

Pre-conditions:

• The email address matches exactly the one used by the user in the current domain;
• The caller of this operation must have the permission "Project - Edit" on the project in the context.

Specified by:

getUserByEmail in interface Domain

Parameters:

userEmail - is the email from an existing user on the current domain.

Returns:

an instance of the user information UserInfoType

Throws:

java.rmi.RemoteException

WSException -

• 1 - if an unknown/runtime error occurs during execution
• 2 - if the webservice framework is unable to retrieve the current webservice context. This indicates a serious system error.
• 3 - if the user does not have the necessary permissions.

isUserValid

public SimpleUsernameStatusType isUserValid(java.lang.String username,
                                            java.lang.String password)
                                     throws java.rmi.RemoteException,
                                            WSException

Description copied from interface: Domain

Returns the status information for a given username and password. It follows the same rules for username and password used on the current domain.

Pre-conditions:

• The username is valid on the current domain;
• The caller of this operation must have the permission "Domain - Administer" on the project in the context.

Specified by:

isUserValid in interface Domain

Parameters:

username - is the username from an existing user on the current domain.

password - is the password matching exactly the one from the given username from an existing user on the current domain.

Returns:

an instance of the user status information SimpleUsernameStatusType

Throws:

java.rmi.RemoteException

WSException -

• 1 - if an unknown/runtime error occurs during execution
• 2 - if the webservice framework is unable to retrieve the current webservice context. This indicates a serious system error.
• 3 - if the user does not have the necessary permissions.

getProjectsForUser

public ProjectsForUserContainer getProjectsForUser(java.lang.String username,
                                                   PaginationType pagination)
                                            throws java.rmi.RemoteException,
                                                   WSException

Description copied from interface: Domain

Returns a simple the list of projects that the user, identified by the given username, has direct roles on the current domain.
Additionally, a pagination information can be provided in order to return results for larger datasets. Check the documentation of PaginationType.

Pre-conditions:

• The username is valid on the current domain;
• The pagination is provided;
• The caller of this operation must have the permission "Domain - Administer" on the project in the context or is the user itself making the call for its own projects.

Specified by:

getProjectsForUser in interface Domain

Parameters:

username - is the username from an existing user on the current domain.

Returns:

an instance of he user information ProjectsForUserContainer

Throws:

java.rmi.RemoteException

WSException -

• 1 - if an unknown/runtime error occurs during execution
• 2 - if the webservice framework is unable to retrieve the current webservice context. This indicates a serious system error.
• 3 - if the user does not have the necessary permissions.

getProjectsForAction

public ProjectsForActionContainer getProjectsForAction(java.lang.String action,
                                                       java.lang.String username,
                                                       PaginationType pagination)
                                                throws java.rmi.RemoteException,
                                                       WSException

Description copied from interface: Domain

Returns a simple the list of projects that has the action, identified by the given action name, in one of the roles from the project's members. At least one user must have at last one role with the given action name on its list of permissions.
Additionally, a pagination information can be provided in order to return results for larger datasets. Check the documentation of PaginationType.

Pre-conditions:

• The username is valid on the current domain;
• The pagination is provided;
• The caller of this operation must have the permission "Domain - Administer" on the project in the context.

Specified by:

getProjectsForAction in interface Domain

Parameters:

action - is the action name on the current domain.

username - is the username of the user to be verified.

Returns:

an instance of he user information ProjectsForActionContainer

Throws:

java.rmi.RemoteException

WSException -

• 1 - if an unknown/runtime error occurs during execution
• 2 - if the webservice framework is unable to retrieve the current webservice context. This indicates a serious system error.
• 3 - if the user does not have the necessary permissions.

getResourcesForAction

public ResourcesForActionContainer getResourcesForAction(java.lang.String action,
                                                         java.lang.String username,
                                                         java.lang.String project)
                                                  throws java.rmi.RemoteException,
                                                         WSException

Description copied from interface: Domain

Returns a list resources associated with the given action on the given project for a given username.

Pre-conditions:

• The username is valid on the current domain;
• The pagination is provided;
• The caller of this operation must have the permission "Domain - Administer" on the project in the context.

Specified by:

getResourcesForAction in interface Domain

Parameters:

action - is the action name on the current domain.

Returns:

an instance of the list of resouces for the given action and project ResourcesForActionContainer

Throws:

java.rmi.RemoteException

WSException -

• 1 - if an unknown/runtime error occurs during execution
• 2 - if the webservice framework is unable to retrieve the current webservice context. This indicates a serious system error.
• 3 - if the user does not have the necessary permissions.