com.collabnet.helm.ws.membership
Class MembershipBindingStub

java.lang.Object
  org.apache.axis.client.Stub
      com.collabnet.helm.ws.membership.MembershipBindingStub

All Implemented Interfaces:

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

public class MembershipBindingStub
extends org.apache.axis.client.Stub
implements Membership

Field Summary

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

MembershipBindingStub()

MembershipBindingStub(javax.xml.rpc.Service service)

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

Method Summary

void	addMembers(java.lang.String[] usernames, java.lang.String[] roles) Adds the list of given usernames to the project on the context, granting, for each of them, all the roles given on the roles container.
void	approvePendingRolesRequests(UsernameRolesType[] members) Approves the roles for the given list of members who had requested roles on the project in the context.
void	disapprovePendingRolesRequests(UsernameRolesType[] members, java.lang.String reason) Disapproves the roles for the given list of members who had requested roles on the project in the context, specifying the reason for such decision.
MemberInfoType	getMemberInfo(java.lang.String username) Adds the list of given usernames to the project on the context, granting, for each of them, all the roles given on the roles container.
MembersContainer	getMembers(PaginationType pagination) Gets the lists of the members of the project in the context.
MembersContainer	getOwners(PaginationType pagination) Gets the lists of the members of the project in the context.
MemberRolesType[]	getPendingRolesRequests() Gets the lists of the users who requested roles on the project in the context, wrapped up in the class MembersContainer.
void	grantRolesToMembers(UsernameRolesType[] members) Grants the roles related to each member of the members list, which are on the project in the context.
void	revokeRolesFromMembers(UsernameRolesType[] members) Revokes the roles related to each member of the members list, which are on the project in the context.

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

MembershipBindingStub

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

Throws:

org.apache.axis.AxisFault

MembershipBindingStub

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

Throws:

org.apache.axis.AxisFault

MembershipBindingStub

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

Throws:

org.apache.axis.AxisFault

Method Detail

addMembers

public void addMembers(java.lang.String[] usernames,
                       java.lang.String[] roles)
                throws java.rmi.RemoteException,
                       WSException

Description copied from interface: Membership

Adds the list of given usernames to the project on the context, granting, for each of them, all the roles given on the roles container.

Pre-conditions:

• All the usernames provided must exist on the current domain in the context;
• The caller of this operation must have the permission "Role - Grant" on the project in the context.

Specified by:

addMembers in interface Membership

Parameters:

usernames - is the container for the list of usernames wrapped up on the class SimpleUsersContainer.

roles - is the container for the list of roles wrapped up on the class SimpleRolesContainer.

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.

getMemberInfo

public MemberInfoType getMemberInfo(java.lang.String username)
                             throws java.rmi.RemoteException,
                                    WSException

Description copied from interface: Membership

Adds the list of given usernames to the project on the context, granting, for each of them, all the roles given on the roles container.

Pre-conditions:

• All the usernames provided must exist on the current domain in the context;
• The caller of this operation must have the permission "Role - Grant" on the project in the context.

Specified by:

getMemberInfo in interface Membership

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.

getMembers

public MembersContainer getMembers(PaginationType pagination)
                            throws java.rmi.RemoteException,
                                   WSException

Description copied from interface: Membership

Gets the lists of the members of the project in the context. The result will be a reflection to the given pagination information PaginationType provided.

Pre-conditions:

• The pagination request is provided;
• The caller of this operation must have the permission "Project Content - View" on the project in the context.

Specified by:

getMembers in interface Membership

Parameters:

pagination - is the request that controls the list of members returned.

Returns:

a new instance of the MembersContainer, which wraps up the list of the project's members in the context.

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.

getOwners

public MembersContainer getOwners(PaginationType pagination)
                           throws java.rmi.RemoteException,
                                  WSException

Description copied from interface: Membership

Gets the lists of the members of the project in the context. The result will be a reflection to the given pagination information PaginationType provided.

Pre-conditions:

• The pagination request is provided;
• The caller of this operation must have the permission "Project Content - View" on the project in the context.

Specified by:

getOwners in interface Membership

Parameters:

pagination - is the request that controls the list of members returned.

Returns:

a new instance of the MembersContainer, which wraps up the list of the project's members in the context.

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.

getPendingRolesRequests

public MemberRolesType[] getPendingRolesRequests()
                                          throws java.rmi.RemoteException,
                                                 WSException

Description copied from interface: Membership

Gets the lists of the users who requested roles on the project in the context, wrapped up in the class MembersContainer.

Pre-conditions:

• The caller of this operation must have the permission "Role - Grant" on the project in the context.

Specified by:

getPendingRolesRequests in interface Membership

Returns:

a new instance of the MembersRolesContainer, which wraps up the list of the project's members in the context that have requested a role.

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.

approvePendingRolesRequests

public void approvePendingRolesRequests(UsernameRolesType[] members)
                                 throws java.rmi.RemoteException,
                                        WSException

Description copied from interface: Membership

Approves the roles for the given list of members who had requested roles on the project in the context.

Pre-conditions:

• The members list is provided and each username of the list must be valid on the current domain;
• The caller of this operation must have the permission "Role - Grant" on the project in the context.

Specified by:

approvePendingRolesRequests in interface Membership

Parameters:

members - is the list of the members and their requested roles to the project in the context. The list is represented by the class UsernamesRolesContainer.

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.

disapprovePendingRolesRequests

public void disapprovePendingRolesRequests(UsernameRolesType[] members,
                                           java.lang.String reason)
                                    throws java.rmi.RemoteException,
                                           WSException

Description copied from interface: Membership

Disapproves the roles for the given list of members who had requested roles on the project in the context, specifying the reason for such decision.

Pre-conditions:

• The members list is provided and each username of the list must be valid on the current domain;
• The reason for this decision is specified;
• The caller of this operation must have the permission "Role - Grant" on the project in the context.

Specified by:

disapprovePendingRolesRequests in interface Membership

Parameters:

members - is the list of the members and their requested roles to the project in the context. The list is represented by the class UsernamesRolesContainer.

reason - is the request that controls the list of members returned.

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.

grantRolesToMembers

public void grantRolesToMembers(UsernameRolesType[] members)
                         throws java.rmi.RemoteException,
                                WSException

Description copied from interface: Membership

Grants the roles related to each member of the members list, which are on the project in the context.

Pre-conditions:

• The members list is provided and each username of the list must be valid on the current domain;
• The caller of this operation must have the permission "Role - Grant" on the project in the context.

Specified by:

grantRolesToMembers in interface Membership

Parameters:

members - is the list of the members and the roles, wrapped by UsernamesRolesContainer, to be granted on the project in the context.

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.

revokeRolesFromMembers

public void revokeRolesFromMembers(UsernameRolesType[] members)
                            throws java.rmi.RemoteException,
                                   WSException

Description copied from interface: Membership

Revokes the roles related to each member of the members list, which are on the project in the context.

Pre-conditions:

• The members list is provided and each username of the list must be valid on the current domain;
• The reason for this decision is specified;
• The caller of this operation must have the permission "Role - Grant" on the project in the context.

Specified by:

revokeRolesFromMembers in interface Membership

Parameters:

members - is the list of the members and the roles, wrapped by UsernamesRolesContainer, to be granted on the project in the context.

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.