From be86cb21ae93628dc6f62e1ac878b3dafa8a5753 Mon Sep 17 00:00:00 2001
From: felmer <felmer>
Date: Tue, 6 Jul 2010 08:23:21 +0000
Subject: [PATCH] LMS-1616 new service introduced and documented with Javadoc.
SVN: 16852
---
.../api/v1/GeneralInformationService.java | 198 ++++++++++++++++++
.../v1/GeneralInformationServiceLogger.java | 74 +++++++
.../v1/GeneralInformationServiceServer.java | 64 ++++++
.../generic/server/api/v1/ResourceNames.java | 28 +++
.../generic/server/api/v1/Translator.java | 43 ++++
.../api/v1/IGeneralInformationService.java | 82 ++++++++
.../generic/shared/api/v1/dto/Project.java | 98 +++++++++
.../generic/shared/api/v1/dto/Role.java | 91 ++++++++
.../SpaceWithProjectsAndRoleAssignments.java | 97 +++++++++
9 files changed, 775 insertions(+)
create mode 100644 openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationService.java
create mode 100644 openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationServiceLogger.java
create mode 100644 openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationServiceServer.java
create mode 100644 openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/ResourceNames.java
create mode 100644 openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/Translator.java
create mode 100644 openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/IGeneralInformationService.java
create mode 100644 openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/Project.java
create mode 100644 openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/Role.java
create mode 100644 openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/SpaceWithProjectsAndRoleAssignments.java
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationService.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationService.java
new file mode 100644
index 00000000000..2f17f1b6483
--- /dev/null
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationService.java
@@ -0,0 +1,198 @@
+/*
+ * Copyright 2010 ETH Zuerich, CISD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.systemsx.cisd.openbis.generic.server.api.v1;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.springframework.stereotype.Component;
+
+import ch.systemsx.cisd.authentication.ISessionManager;
+import ch.systemsx.cisd.common.spring.IInvocationLoggerContext;
+import ch.systemsx.cisd.openbis.generic.server.AbstractServer;
+import ch.systemsx.cisd.openbis.generic.server.dataaccess.IDAOFactory;
+import ch.systemsx.cisd.openbis.generic.server.dataaccess.IDatabaseInstanceDAO;
+import ch.systemsx.cisd.openbis.generic.shared.ICommonServer;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.IGeneralInformationService;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Project;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Role;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SpaceWithProjectsAndRoleAssignments;
+import ch.systemsx.cisd.openbis.generic.shared.authorization.annotation.RoleSet;
+import ch.systemsx.cisd.openbis.generic.shared.dto.AuthorizationGroupPE;
+import ch.systemsx.cisd.openbis.generic.shared.dto.DatabaseInstancePE;
+import ch.systemsx.cisd.openbis.generic.shared.dto.GroupPE;
+import ch.systemsx.cisd.openbis.generic.shared.dto.PersonPE;
+import ch.systemsx.cisd.openbis.generic.shared.dto.ProjectPE;
+import ch.systemsx.cisd.openbis.generic.shared.dto.RoleAssignmentPE;
+import ch.systemsx.cisd.openbis.generic.shared.dto.Session;
+import ch.systemsx.cisd.openbis.generic.shared.dto.SessionContextDTO;
+
+/**
+ *
+ *
+ * @author Franz-Josef Elmer
+ */
+@Component(ResourceNames.GENERAL_INFORMATION_SERVICE_SERVER)
+public class GeneralInformationService extends AbstractServer<IGeneralInformationService> implements
+ IGeneralInformationService
+{
+ // Default constructor needed by Spring
+ public GeneralInformationService()
+ {
+ }
+
+ GeneralInformationService(ISessionManager<Session> sessionManager, IDAOFactory daoFactory,
+ ICommonServer commonServer)
+ {
+ super(sessionManager, daoFactory);
+ }
+
+ public IGeneralInformationService createLogger(IInvocationLoggerContext context)
+ {
+ return new GeneralInformationServiceLogger(sessionManager, context);
+ }
+
+ public String tryToAuthenticateForAllServices(String userID, String userPassword)
+ {
+ SessionContextDTO session = tryToAuthenticate(userID, userPassword);
+ return session == null ? null : session.getSessionToken();
+ }
+
+ public Map<String, Set<Role>> listNamedRoleSets(String sessionToken)
+ {
+ checkSession(sessionToken);
+
+ Map<String, Set<Role>> namedRoleSets = new LinkedHashMap<String, Set<Role>>();
+ RoleSet[] values = RoleSet.values();
+ for (RoleSet roleSet : values)
+ {
+ Set<ch.systemsx.cisd.openbis.generic.shared.authorization.Role> roles = roleSet.getRoles();
+ Set<Role> translatedRoles = new HashSet<Role>();
+ for (ch.systemsx.cisd.openbis.generic.shared.authorization.Role role : roles)
+ {
+ translatedRoles.add(Translator.translate(role));
+ }
+ namedRoleSets.put(roleSet.name(), translatedRoles);
+ }
+ return namedRoleSets;
+ }
+
+ public List<SpaceWithProjectsAndRoleAssignments> listSpacesWithProjectsAndRoleAssignments(
+ String sessionToken, String databaseInstanceCodeOrNull)
+ {
+ checkSession(sessionToken);
+
+ Map<String, List<RoleAssignmentPE>> roleAssignmentsPerSpace = getRoleAssignmentsPerSpace();
+ List<RoleAssignmentPE> instanceRoleAssignments = roleAssignmentsPerSpace.get(null);
+ List<GroupPE> spaces = listSpaces(databaseInstanceCodeOrNull);
+ List<SpaceWithProjectsAndRoleAssignments> result =
+ new ArrayList<SpaceWithProjectsAndRoleAssignments>();
+ for (GroupPE space : spaces)
+ {
+ SpaceWithProjectsAndRoleAssignments fullSpace =
+ new SpaceWithProjectsAndRoleAssignments(space.getCode());
+ addProjectsTo(fullSpace, space);
+ addRoles(fullSpace, instanceRoleAssignments);
+ List<RoleAssignmentPE> list = roleAssignmentsPerSpace.get(space.getCode());
+ if (list != null)
+ {
+ addRoles(fullSpace, list);
+ }
+ result.add(fullSpace);
+ }
+ return result;
+ }
+
+ public int getMajorVersion()
+ {
+ return 1;
+ }
+
+ public int getMinorVersion()
+ {
+ return 0;
+ }
+
+ private Map<String, List<RoleAssignmentPE>> getRoleAssignmentsPerSpace()
+ {
+ List<RoleAssignmentPE> roleAssignments = getDAOFactory().getRoleAssignmentDAO().listRoleAssignments();
+ Map<String, List<RoleAssignmentPE>> roleAssignmentsPerSpace = new HashMap<String, List<RoleAssignmentPE>>();
+ for (RoleAssignmentPE roleAssignment : roleAssignments)
+ {
+ GroupPE space = roleAssignment.getGroup();
+ String spaceCode = space == null ? null : space.getCode();
+ List<RoleAssignmentPE> list = roleAssignmentsPerSpace.get(spaceCode);
+ if (list == null)
+ {
+ list = new ArrayList<RoleAssignmentPE>();
+ roleAssignmentsPerSpace.put(spaceCode, list);
+ }
+ list.add(roleAssignment);
+ }
+ return roleAssignmentsPerSpace;
+ }
+
+ private List<GroupPE> listSpaces(String databaseInstanceCodeOrNull)
+ {
+ IDAOFactory daoFactory = getDAOFactory();
+ DatabaseInstancePE databaseInstance = daoFactory.getHomeDatabaseInstance();
+ if (databaseInstanceCodeOrNull != null)
+ {
+ IDatabaseInstanceDAO databaseInstanceDAO = daoFactory.getDatabaseInstanceDAO();
+ databaseInstance =
+ databaseInstanceDAO.tryFindDatabaseInstanceByCode(databaseInstanceCodeOrNull);
+ }
+ return daoFactory.getGroupDAO().listGroups(databaseInstance);
+ }
+
+ private void addProjectsTo(SpaceWithProjectsAndRoleAssignments fullSpace, GroupPE space)
+ {
+ List<ProjectPE> projects = getDAOFactory().getProjectDAO().listProjects(space);
+ for (ProjectPE project : projects)
+ {
+ fullSpace.add(new Project(fullSpace.getCode(), project.getCode()));
+ }
+ }
+
+ private void addRoles(SpaceWithProjectsAndRoleAssignments fullSpace, List<RoleAssignmentPE> list)
+ {
+ for (RoleAssignmentPE roleAssignment : list)
+ {
+ Role role = Translator.translate(roleAssignment.getRole(), roleAssignment.getGroup() != null);
+ Set<PersonPE> persons;
+ AuthorizationGroupPE authorizationGroup = roleAssignment.getAuthorizationGroup();
+ if (authorizationGroup != null)
+ {
+ persons = authorizationGroup.getPersons();
+ } else
+ {
+ persons = Collections.singleton(roleAssignment.getPerson());
+ }
+ for (PersonPE person : persons)
+ {
+ fullSpace.add(person.getUserId(), role);
+ }
+ }
+ }
+}
+
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationServiceLogger.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationServiceLogger.java
new file mode 100644
index 00000000000..1e39a4ad0ce
--- /dev/null
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationServiceLogger.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright 2010 ETH Zuerich, CISD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.systemsx.cisd.openbis.generic.server.api.v1;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import ch.systemsx.cisd.authentication.ISessionManager;
+import ch.systemsx.cisd.common.spring.IInvocationLoggerContext;
+import ch.systemsx.cisd.openbis.generic.server.AbstractServerLogger;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.IGeneralInformationService;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Role;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SpaceWithProjectsAndRoleAssignments;
+import ch.systemsx.cisd.openbis.generic.shared.dto.Session;
+
+/**
+ *
+ *
+ * @author Franz-Josef Elmer
+ */
+class GeneralInformationServiceLogger extends AbstractServerLogger implements
+ IGeneralInformationService
+{
+ public GeneralInformationServiceLogger(ISessionManager<Session> sessionManager,
+ IInvocationLoggerContext context)
+ {
+ super(sessionManager, context);
+ // TODO Auto-generated constructor stub
+ }
+
+ public String tryToAuthenticateForAllServices(String userID, String userPassword)
+ {
+ return null;
+ }
+
+ public Map<String, Set<Role>> listNamedRoleSets(String sessionToken)
+ {
+ logAccess(sessionToken, "list-role-sets");
+ return null;
+ }
+
+ public List<SpaceWithProjectsAndRoleAssignments> listSpacesWithProjectsAndRoleAssignments(
+ String sessionToken, String databaseInstanceCodeOrNull)
+ {
+ logAccess(sessionToken, "list-spaces", "DATABSE_INSTANCE(%s)", databaseInstanceCodeOrNull);
+ return null;
+ }
+
+ public int getMajorVersion()
+ {
+ return 0;
+ }
+
+ public int getMinorVersion()
+ {
+ return 0;
+ }
+
+}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationServiceServer.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationServiceServer.java
new file mode 100644
index 00000000000..f2e064c75b2
--- /dev/null
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/GeneralInformationServiceServer.java
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2010 ETH Zuerich, CISD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.systemsx.cisd.openbis.generic.server.api.v1;
+
+import javax.annotation.Resource;
+
+import org.springframework.remoting.httpinvoker.HttpInvokerServiceExporter;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+
+import ch.systemsx.cisd.common.api.IRpcServiceNameServer;
+import ch.systemsx.cisd.common.api.RpcServiceInterfaceVersionDTO;
+import ch.systemsx.cisd.common.api.server.RpcServiceNameServer;
+import ch.systemsx.cisd.common.spring.ServiceExceptionTranslator;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.IGeneralInformationService;
+
+/**
+ *
+ *
+ * @author Franz-Josef Elmer
+ */
+@Controller
+@RequestMapping(
+ { IGeneralInformationService.SERVICE_URL,
+ "/openbis" + IGeneralInformationService.SERVICE_URL })
+public class GeneralInformationServiceServer extends HttpInvokerServiceExporter
+{
+ @Resource(name = ResourceNames.GENERAL_INFORMATION_SERVICE_SERVER)
+ private IGeneralInformationService service;
+
+ @Resource(name = IRpcServiceNameServer.PREFFERED_BEAN_NAME)
+ private RpcServiceNameServer nameServer;
+
+ @Override
+ public void afterPropertiesSet()
+ {
+ setServiceInterface(IGeneralInformationService.class);
+ setService(service);
+ setInterceptors(new Object[]
+ { new ServiceExceptionTranslator() });
+
+ int majorVersion = service.getMajorVersion();
+ int minorVersion = service.getMinorVersion();
+ RpcServiceInterfaceVersionDTO ifaceVersion =
+ new RpcServiceInterfaceVersionDTO(IGeneralInformationService.SERVICE_NAME,
+ IGeneralInformationService.SERVICE_URL, majorVersion, minorVersion);
+ nameServer.addSupportedInterfaceVersion(ifaceVersion);
+ super.afterPropertiesSet();
+ }
+}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/ResourceNames.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/ResourceNames.java
new file mode 100644
index 00000000000..5ce924a871e
--- /dev/null
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/ResourceNames.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright 2010 ETH Zuerich, CISD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.systemsx.cisd.openbis.generic.server.api.v1;
+
+/**
+ *
+ *
+ * @author Franz-Josef Elmer
+ */
+public class ResourceNames
+{
+ public final static String GENERAL_INFORMATION_SERVICE_SERVER = "general-information-api-server-v1";
+
+}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/Translator.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/Translator.java
new file mode 100644
index 00000000000..f64b894e0e0
--- /dev/null
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/api/v1/Translator.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2010 ETH Zuerich, CISD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.systemsx.cisd.openbis.generic.server.api.v1;
+
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Role;
+import ch.systemsx.cisd.openbis.generic.shared.authorization.Role.RoleLevel;
+import ch.systemsx.cisd.openbis.generic.shared.dto.RoleCode;
+
+/**
+ *
+ *
+ * @author Franz-Josef Elmer
+ */
+class Translator
+{
+ static Role translate(ch.systemsx.cisd.openbis.generic.shared.authorization.Role role)
+ {
+ return translate(role.getRoleName(), role.getRoleLevel().equals(RoleLevel.SPACE));
+ }
+
+ static Role translate(RoleCode roleCode, boolean spaceLevel)
+ {
+ return new Role(roleCode.name(), spaceLevel);
+ }
+
+ private Translator()
+ {
+ }
+}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/IGeneralInformationService.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/IGeneralInformationService.java
new file mode 100644
index 00000000000..e1064da06ce
--- /dev/null
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/IGeneralInformationService.java
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2010 ETH Zuerich, CISD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.systemsx.cisd.openbis.generic.shared.api.v1;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import org.springframework.transaction.annotation.Transactional;
+
+import ch.systemsx.cisd.common.api.IRpcService;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.Role;
+import ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SpaceWithProjectsAndRoleAssignments;
+import ch.systemsx.cisd.openbis.generic.shared.authorization.annotation.RoleSet;
+import ch.systemsx.cisd.openbis.generic.shared.authorization.annotation.RolesAllowed;
+
+/**
+ * Service for retrieving general informations.
+ *
+ * @author Franz-Josef Elmer
+ */
+public interface IGeneralInformationService extends IRpcService
+{
+ /**
+ * Name of this service for which it is registered at the RPC name server.
+ */
+ public static final String SERVICE_NAME = "general-information";
+
+ /**
+ * Application part of the URL to access this service remotely.
+ */
+ public static final String SERVICE_URL = "/rmi-" + SERVICE_NAME + "-v1";
+
+ /**
+ * Tries to authenticate specified user with specified password. Returns session token if
+ * succeeded otherwise <code>null</code> is returned. The returned session token can be used for
+ * all methods and interfaces of the same openBIS server.
+ */
+ @Transactional
+ // this is not a readOnly transaction - it can create new users
+ public String tryToAuthenticateForAllServices(String userID, String userPassword);
+
+ /**
+ * Logout the session with the specified session token.
+ */
+ @Transactional(readOnly = true)
+ public void logout(String sessionToken);
+
+ /**
+ * Returns all named role sets. The name is the key of the returned map.
+ */
+ @Transactional(readOnly = true)
+ @RolesAllowed(RoleSet.INSTANCE_ADMIN_OBSERVER)
+ public Map<String, Set<Role>> listNamedRoleSets(String sessionToken);
+
+ /**
+ * Returns all spaces of specified database instance enriched with their projects and role
+ * assignments.
+ *
+ * @param databaseInstanceCodeOrNull Code of an imported database instance or <code>null</code>
+ * for the home database instance is meant.
+ */
+ @Transactional(readOnly = true)
+ @RolesAllowed(RoleSet.INSTANCE_ADMIN_OBSERVER)
+ public List<SpaceWithProjectsAndRoleAssignments> listSpacesWithProjectsAndRoleAssignments(
+ String sessionToken, String databaseInstanceCodeOrNull);
+
+}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/Project.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/Project.java
new file mode 100644
index 00000000000..71483b94b56
--- /dev/null
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/Project.java
@@ -0,0 +1,98 @@
+/*
+ * Copyright 2010 ETH Zuerich, CISD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.systemsx.cisd.openbis.generic.shared.api.v1.dto;
+
+import java.io.Serializable;
+
+/**
+ * Immutable value object representing a project. A project is specified by its code and the code
+ * of the space to which it belongs.
+ *
+ * @author Franz-Josef Elmer
+ */
+public final class Project implements Serializable
+{
+ private static final long serialVersionUID = 1L;
+
+ private final String spaceCode;
+
+ private final String code;
+
+ /**
+ * Creates a new instance for the specified space code and project code.
+ *
+ * @throws IllegalArgumentException if either the code or the space code is <code>null</code> or
+ * an empty string.
+ */
+ public Project(String spaceCode, String code)
+ {
+ if (spaceCode == null || spaceCode.length() == 0)
+ {
+ throw new IllegalArgumentException("Unspecified space code.");
+ }
+ this.spaceCode = spaceCode;
+ if (code == null || code.length() == 0)
+ {
+ throw new IllegalArgumentException("Unspecified code.");
+ }
+ this.code = code;
+ }
+
+ /**
+ * Returns the space code.
+ */
+ public String getSpaceCode()
+ {
+ return spaceCode;
+ }
+
+ /**
+ * Returns the project code.
+ */
+ public String getCode()
+ {
+ return code;
+ }
+
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (obj == this)
+ {
+ return false;
+ }
+ if (obj instanceof Project == false)
+ {
+ return false;
+ }
+ Project project = (Project) obj;
+ return project.spaceCode.equals(spaceCode) && project.code.equals(code);
+ }
+
+ @Override
+ public int hashCode()
+ {
+ return 37 * spaceCode.hashCode() + code.hashCode();
+ }
+
+ @Override
+ public String toString()
+ {
+ return "/" + spaceCode + "/" + code;
+ }
+
+}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/Role.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/Role.java
new file mode 100644
index 00000000000..5430ca293a6
--- /dev/null
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/Role.java
@@ -0,0 +1,91 @@
+/*
+ * Copyright 2010 ETH Zuerich, CISD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.systemsx.cisd.openbis.generic.shared.api.v1.dto;
+
+import java.io.Serializable;
+
+/**
+ * Immutable value object representing an authorization role. A role has a code and a flag
+ * which tells whether this role is for a certain space or for all spaces.
+ *
+ * @author Franz-Josef Elmer
+ */
+public final class Role implements Serializable
+{
+ private static final long serialVersionUID = 1L;
+
+ private final String code;
+ private final boolean spaceLevel;
+
+ /**
+ * Creates a new instance from specified code and space level flag.
+ *
+ * @throws IllegalArgumentException if specified code is <code>null</code> or an empty string.
+ */
+ public Role(String code, boolean spaceLevel)
+ {
+ if (code == null || code.length() == 0)
+ {
+ throw new IllegalArgumentException("Unspecified code.");
+ }
+ this.code = code;
+ this.spaceLevel = spaceLevel;
+ }
+
+ /**
+ * Returns role code.
+ */
+ public final String getCode()
+ {
+ return code;
+ }
+
+ /**
+ * Returns <code>true</code> if this role is for a particular space.
+ */
+ public final boolean isSpaceLevel()
+ {
+ return spaceLevel;
+ }
+
+ @Override
+ public boolean equals(Object obj)
+ {
+ if (obj == this)
+ {
+ return true;
+ }
+ if (obj instanceof Role == false)
+ {
+ return false;
+ }
+ Role role = (Role) obj;
+ return role.spaceLevel == spaceLevel && role.code.equals(code);
+ }
+
+ @Override
+ public int hashCode()
+ {
+ return 37 * code.hashCode() + (spaceLevel ? 1 : 0);
+ }
+
+ @Override
+ public String toString()
+ {
+ return code + "(" + (spaceLevel ? "space" : "instance") + ")";
+ }
+}
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/SpaceWithProjectsAndRoleAssignments.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/SpaceWithProjectsAndRoleAssignments.java
new file mode 100644
index 00000000000..36749382773
--- /dev/null
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/api/v1/dto/SpaceWithProjectsAndRoleAssignments.java
@@ -0,0 +1,97 @@
+/*
+ * Copyright 2010 ETH Zuerich, CISD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.systemsx.cisd.openbis.generic.shared.api.v1.dto;
+
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Bean which represents a space, all its projects, and all its relevant role assignments
+ *
+ * @author Franz-Josef Elmer
+ */
+public class SpaceWithProjectsAndRoleAssignments implements Serializable
+{
+ private static final long serialVersionUID = 1L;
+
+ private final String code;
+
+ private final List<Project> projects = new ArrayList<Project>();
+
+ private final Map<String, Set<Role>> rolesPerUser = new HashMap<String, Set<Role>>();
+
+ /**
+ * Creates a new instance for the specified code.
+ *
+ * @throws IllegalArgumentException if the code is <code>null</code> or an empty string.
+ */
+ public SpaceWithProjectsAndRoleAssignments(String code)
+ {
+ if (code == null || code.length() == 0)
+ {
+ throw new IllegalArgumentException("Unspecified code.");
+ }
+ this.code = code;
+ }
+
+ /**
+ * Returns the space code.
+ */
+ public String getCode()
+ {
+ return code;
+ }
+
+ public void add(Project project)
+ {
+ projects.add(project);
+ }
+
+ /**
+ * Returns all projects of this space.
+ */
+ public List<Project> getProjects()
+ {
+ return projects;
+ }
+
+ public void add(String user, Role role)
+ {
+ Set<Role> roles = rolesPerUser.get(user);
+ if (roles == null)
+ {
+ roles = new HashSet<Role>();
+ rolesPerUser.put(user, roles);
+ }
+ roles.add(role);
+ }
+
+ /**
+ * Returns all access roles the specified user has on this space.
+ */
+ public Set<Role> getRoles(String userID)
+ {
+ Set<Role> set = rolesPerUser.get(userID);
+ return set == null ? Collections.<Role>emptySet() : set;
+ }
+}
--
GitLab