org.eclipse.emf.emfstore.internal.server

Interface AdminEmfStore

All Superinterfaces:

EMFStoreInterface

All Known Subinterfaces:

AdminConnectionManager

All Known Implementing Classes:

AdminEmfStoreImpl, XmlRpcAdminConnectionManager, XmlRpcAdminEmfStoreImpl

public interface AdminEmfStore
extends EMFStoreInterface

AdminEmfStore offers an interface for administrating the users and their rights.

Author:

Hodaie, Wesendonk

Method Summary

Modifier and Type	Method and Description
void	addInitialParticipant(SessionId sessionId, ProjectId projectId, ACOrgUnitId participantId, org.eclipse.emf.ecore.EClass roleClass) Adds an organization unit to a project.
void	addMember(SessionId sessionId, ACOrgUnitId group, ACOrgUnitId member) Adds an orgUnit to a group.
void	addParticipant(SessionId sessionId, ProjectId projectId, ACOrgUnitId participantId, org.eclipse.emf.ecore.EClass roleClass) Adds an organization unit to a project.
void	assignRole(SessionId sessionId, ACOrgUnitId orgUnitId, org.eclipse.emf.ecore.EClass roleClass) Assigns a role for an orgUnit without a project.
void	changeOrgUnit(SessionId sessionId, ACOrgUnitId orgUnitId, String name, String description) Changes the orgUnit's name and description.
void	changeRole(SessionId sessionId, ProjectId projectId, ACOrgUnitId orgUnit, org.eclipse.emf.ecore.EClass role) Changes the role for an orgUnit in a specified project.
void	changeUser(SessionId sessionId, ACOrgUnitId userId, String name, String password) Changes the name and password of an ACUser.
ACOrgUnitId	createGroup(SessionId sessionId, String name) Creates a group on the server.
ACOrgUnitId	createUser(SessionId sessionId, String name) Creates a user on the server.
void	deleteGroup(SessionId sessionId, ACOrgUnitId group) Deletes a group on the server.
void	deleteUser(SessionId sessionId, ACOrgUnitId user) Deletes a user from the server.
List<ACGroup>	getGroups(SessionId sessionId) Returns all groups on the server.
List<ACGroup>	getGroups(SessionId sessionId, ACOrgUnitId user) Returns a list of all groups in which the specified user is member of.
List<ACOrgUnit>	getMembers(SessionId sessionId, ACOrgUnitId groupId) Returns all members from a group.
ACOrgUnit	getOrgUnit(SessionId sessionId, ACOrgUnitId orgUnitId) Returns an orgUnit with the specified orgUnitId.
List<ACOrgUnit>	getOrgUnits(SessionId sessionId) Returns all orgUnits on the server.
List<ACOrgUnit>	getParticipants(SessionId sessionId, ProjectId projectId) Returns all orgUnits which are attached to the given project.
List<ProjectInfo>	getProjectInfos(SessionId sessionId) Returns a list of available project.
Role	getRole(SessionId sessionId, ProjectId projectId, ACOrgUnitId orgUnit) Returns an orgUnit's role for a specified project.
List<ACUser>	getUsers(SessionId sessionId) Returns all users on the server.
void	removeGroup(SessionId sessionId, ACOrgUnitId user, ACOrgUnitId group) Removes a user from a group.
void	removeMember(SessionId sessionId, ACOrgUnitId group, ACOrgUnitId member) Removes a orgUnit from a group.
void	removeParticipant(SessionId sessionId, ProjectId projectId, ACOrgUnitId participant) Removes an orgUnits from a project.

Method Detail

getProjectInfos

List<ProjectInfo> getProjectInfos(SessionId sessionId)
                           throws ESException

Returns a list of available project.

Parameters:

sessionId - the session id for authentication

Returns:

list of project infos

Throws:

ESException - if any error in the EmfStore occurs

getGroups

List<ACGroup> getGroups(SessionId sessionId)
                 throws ESException

Returns all groups on the server.

Parameters:

sessionId - the session id for authentication

Returns:

list of groups

Throws:

ESException - if any error in the EmfStore occurs

getUsers

List<ACUser> getUsers(SessionId sessionId)
               throws ESException

Returns all users on the server.

Parameters:

sessionId - the session id for authentication

Returns:

list of user

Throws:

ESException - if any error in the EmfStore occurs

getOrgUnits

List<ACOrgUnit> getOrgUnits(SessionId sessionId)
                     throws ESException

Returns all orgUnits on the server.

Parameters:

sessionId - the session id for authentication

Returns:

list of orgUnits

Throws:

ESException - if any error in the EmfStore occurs

getOrgUnit

ACOrgUnit getOrgUnit(SessionId sessionId,
                     ACOrgUnitId orgUnitId)
              throws ESException

Returns an orgUnit with the specified orgUnitId.

Parameters:

orgUnitId - the orgUnitId

sessionId - the session id for authentication

Returns:

an orgUnit

Throws:

ESException - if any error in the EmfStore occurs

createGroup

ACOrgUnitId createGroup(SessionId sessionId,
                        String name)
                 throws ESException

Creates a group on the server.

Parameters:

sessionId - the session id for authentication

name - the name for the group

Returns:

ACOrgUnitId

Throws:

ESException - if any error in the EmfStore occurs

deleteGroup

void deleteGroup(SessionId sessionId,
                 ACOrgUnitId group)
          throws ESException

Deletes a group on the server.

Parameters:

sessionId - the session id for authentication

group - orgUnitId of the group

Throws:

ESException - if any error in the EmfStore occurs

getGroups

List<ACGroup> getGroups(SessionId sessionId,
                        ACOrgUnitId user)
                 throws ESException

Returns a list of all groups in which the specified user is member of.

Parameters:

sessionId - the session id for authentication

user - the users orgUnitId

Returns:

a list of groups

Throws:

ESException - if any error in the EmfStore occurs

removeGroup

void removeGroup(SessionId sessionId,
                 ACOrgUnitId user,
                 ACOrgUnitId group)
          throws ESException

Removes a user from a group.

Parameters:

sessionId - the session id for authentication

user - the user's orgUnitId

group - the group's orgUnitId

Throws:

ESException - if any error in the EmfStore occurs

getMembers

List<ACOrgUnit> getMembers(SessionId sessionId,
                           ACOrgUnitId groupId)
                    throws ESException

Returns all members from a group.

Parameters:

sessionId - the session id for authentication

groupId - the group's orgUnitId

Returns:

a list of orgUnits

Throws:

ESException - if any error in the EmfStore occurs.

addMember

void addMember(SessionId sessionId,
               ACOrgUnitId group,
               ACOrgUnitId member)
        throws ESException

Adds an orgUnit to a group.

Parameters:

sessionId - the session id for authentication

group - the group's orgUnitId

member - the members orgUnitId

Throws:

ESException - if any error in the EmfStore occurs

removeMember

void removeMember(SessionId sessionId,
                  ACOrgUnitId group,
                  ACOrgUnitId member)
           throws ESException

Removes a orgUnit from a group.

Parameters:

sessionId - the session id for authentication

group - the group's orgUnitId

member - the members orgUnitId

Throws:

ESException - if any error in the EmfStore occurs

createUser

ACOrgUnitId createUser(SessionId sessionId,
                       String name)
                throws ESException

Creates a user on the server.

Parameters:

sessionId - the session id for authentication

name - the user's name

Returns:

ACOrgUnitId the ACOrgUnitId of the created user

Throws:

ESException - if any error occurred while creating the user

deleteUser

void deleteUser(SessionId sessionId,
                ACOrgUnitId user)
         throws ESException

Deletes a user from the server.

Parameters:

sessionId - the session id for authentication

user - the user's orgUnitId

Throws:

ESException - if any error in the EmfStore occurs

changeOrgUnit

void changeOrgUnit(SessionId sessionId,
                   ACOrgUnitId orgUnitId,
                   String name,
                   String description)
            throws ESException

Changes the orgUnit's name and description.

Parameters:

sessionId - the session id for authentication.

orgUnitId - the orgUnitId

name - the new name

description - the new description

Throws:

ESException - if any error in the EmfStore occurs

changeUser

void changeUser(SessionId sessionId,
                ACOrgUnitId userId,
                String name,
                String password)
         throws ESException

Changes the name and password of an ACUser.

Parameters:

sessionId - the session id for authentication.

userId - the ID of the user

name - the new name

password - the new password

Throws:

ESException - if any error in the EmfStore occurs

getParticipants

List<ACOrgUnit> getParticipants(SessionId sessionId,
                                ProjectId projectId)
                         throws ESException

Returns all orgUnits which are attached to the given project.

Parameters:

sessionId - the session id for authentication

projectId - project's id

Returns:

a list of orgUnits

Throws:

ESException - if any error in the EmfStore occurs

addParticipant

void addParticipant(SessionId sessionId,
                    ProjectId projectId,
                    ACOrgUnitId participantId,
                    org.eclipse.emf.ecore.EClass roleClass)
             throws ESException

Adds an organization unit to a project.

Parameters:

sessionId - the SessionId for authentication

projectId - the ProjectId of the project

participantId - the ACOrgUnitId of the participant

roleClass - the role to be assigned to the participant

Throws:

ESException - if any error in the EmfStore occurs

addInitialParticipant

void addInitialParticipant(SessionId sessionId,
                           ProjectId projectId,
                           ACOrgUnitId participantId,
                           org.eclipse.emf.ecore.EClass roleClass)
                    throws ESException

Adds an organization unit to a project.

Parameters:

sessionId - the SessionId for authentication

projectId - the ProjectId of the project

participantId - the ACOrgUnitId of the participant

roleClass - the role to be assigned to the participant

Throws:

ESException - if any error in the EmfStore occurs

removeParticipant

void removeParticipant(SessionId sessionId,
                       ProjectId projectId,
                       ACOrgUnitId participant)
                throws ESException

Removes an orgUnits from a project.

Parameters:

sessionId - the session id for authentication

projectId - the project's id

participant - the orgUnit's id

Throws:

ESException - if any error in the EmfStore occurs

getRole

Role getRole(SessionId sessionId,
             ProjectId projectId,
             ACOrgUnitId orgUnit)
      throws ESException

Returns an orgUnit's role for a specified project.

Parameters:

sessionId - the session id for authentication

projectId - the project's id

orgUnit - the orgUnit's id

Returns:

a role the user's role

Throws:

ESException - if any error in the EmfStore occurs

changeRole

void changeRole(SessionId sessionId,
                ProjectId projectId,
                ACOrgUnitId orgUnit,
                org.eclipse.emf.ecore.EClass role)
         throws ESException

Changes the role for an orgUnit in a specified project.

Parameters:

sessionId - the session id for authentication

projectId - the project's id

orgUnit - the orgUnit

role - new role for orgUnit

Throws:

ESException - if any error in the EmfStore occurs.

assignRole

void assignRole(SessionId sessionId,
                ACOrgUnitId orgUnitId,
                org.eclipse.emf.ecore.EClass roleClass)
         throws ESException

Assigns a role for an orgUnit without a project.

Parameters:

sessionId - the SessionId for authentication

orgUnitId - the ID of an organizational unit

roleClass - the role to be assigned

Throws:

ESException - if an exceptions occurs on the server or on transport