From 5842c034b7b3c79c7fb1e90877b011cb94db03c0 Mon Sep 17 00:00:00 2001 From: brinn <brinn> Date: Fri, 3 Dec 2010 18:28:40 +0000 Subject: [PATCH] refactor: change name of some methods from xxxGroup -> xxxSpace SVN: 18999 --- .../authorization/PredicateExecutor.java | 6 +++--- .../IAuthorizationDataProvider.java | 10 +++++----- ...dicate.java => AbstractSpacePredicate.java} | 18 +++++++++--------- .../predicate/AbstractTechIdPredicate.java | 10 +++++----- .../DataSetCodeCollectionPredicate.java | 2 +- .../predicate/DataSetCodePredicate.java | 2 +- .../predicate/ListSampleCriteriaPredicate.java | 2 +- .../predicate/SpaceIdentifierPredicate.java | 2 +- .../authorization/AuthorizationTestCase.java | 8 ++++---- .../ListSampleCriteriaPredicateTest.java | 4 ++-- .../ExperimentIdentifierPredicate.java | 4 ++-- .../ScreeningPlateListReadOnlyPredicate.java | 4 ++-- 12 files changed, 36 insertions(+), 36 deletions(-) rename openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/{AbstractGroupPredicate.java => AbstractSpacePredicate.java} (89%) diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/authorization/PredicateExecutor.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/authorization/PredicateExecutor.java index fc8c539d598..351426859a0 100644 --- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/authorization/PredicateExecutor.java +++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/server/authorization/PredicateExecutor.java @@ -229,7 +229,7 @@ public final class PredicateExecutor } } - public List<SpacePE> listGroups() + public List<SpacePE> listSpaces() { return daoFactory.getSpaceDAO().listSpaces(); } @@ -265,7 +265,7 @@ public final class PredicateExecutor return uuidToDbInstanceMap.get(databaseInstanceUUID); } - public ProjectPE tryToGetProject(String dataSetCode) + public ProjectPE tryGetProject(String dataSetCode) { DataPE dataSet = daoFactory.getExternalDataDAO().tryToFindDataSetByCode(dataSetCode); if (dataSet != null && dataSet.getExperiment() != null) @@ -374,7 +374,7 @@ public final class PredicateExecutor return fullResults; } - public SpacePE tryToGetGroup(SpaceOwnerKind kind, TechId techId) + public SpacePE tryGetSpace(SpaceOwnerKind kind, TechId techId) { switch (kind) { diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/IAuthorizationDataProvider.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/IAuthorizationDataProvider.java index 10acf6b3a00..48d9b9e2cd4 100644 --- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/IAuthorizationDataProvider.java +++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/IAuthorizationDataProvider.java @@ -41,9 +41,9 @@ import ch.systemsx.cisd.openbis.generic.shared.dto.SamplePE; public interface IAuthorizationDataProvider extends IDatabaseInstanceFinder { /** - * Returns a list of all groups. + * Returns a list of all data spaces. */ - public List<SpacePE> listGroups(); + public List<SpacePE> listSpaces(); /** * Returns the space for the given <var>spaceCode</var> or <code>null</code>, if it does not @@ -68,7 +68,7 @@ public interface IAuthorizationDataProvider extends IDatabaseInstanceFinder * * @return <code>null</code> if no data set found. */ - public ProjectPE tryToGetProject(String dataSetCode); + public ProjectPE tryGetProject(String dataSetCode); /** * Returns the information necessary to determine if a user is allowed to access this data set. @@ -86,11 +86,11 @@ public interface IAuthorizationDataProvider extends IDatabaseInstanceFinder public Set<SampleAccessPE> getSampleCollectionAccessData(List<TechId> sampleIds); /** - * Returns the group of an entity with given <var>entityKind</var> and <var>techId</var> + * Returns the data space of an entity with given <var>entityKind</var> and <var>techId</var> * * @return <code>null</code> if entity has no group set. */ - public SpacePE tryToGetGroup(SpaceOwnerKind entityKind, TechId techId); + public SpacePE tryGetSpace(SpaceOwnerKind entityKind, TechId techId); /** * Returns the sample with given <var>techId</var>. diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractGroupPredicate.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractSpacePredicate.java similarity index 89% rename from openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractGroupPredicate.java rename to openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractSpacePredicate.java index 76a98b78b49..14e5f968645 100644 --- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractGroupPredicate.java +++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractSpacePredicate.java @@ -27,20 +27,20 @@ import ch.systemsx.cisd.openbis.generic.shared.dto.SpacePE; import ch.systemsx.cisd.openbis.generic.shared.dto.PersonPE; /** - * Abstract super class of predicates based on groups. + * Abstract super class of predicates based on data spaces. * * @author Franz-Josef Elmer */ -public abstract class AbstractGroupPredicate<T> extends AbstractDatabaseInstancePredicate<T> +public abstract class AbstractSpacePredicate<T> extends AbstractDatabaseInstancePredicate<T> { - protected List<SpacePE> groups; + protected List<SpacePE> spaces; @Override public void init(IAuthorizationDataProvider provider) { super.init(provider); - groups = provider.listGroups(); + spaces = provider.listSpaces(); } protected Status evaluate(final PersonPE person, final List<RoleWithIdentifier> allowedRoles, @@ -55,7 +55,7 @@ public abstract class AbstractGroupPredicate<T> extends AbstractDatabaseInstance final String databaseInstanceUUID, final String databaseInstanceCode, final String groupCodeOrNull) { - if (tryFindGroup(databaseInstanceUUID, groupCodeOrNull) == null) + if (tryFindSpace(databaseInstanceUUID, groupCodeOrNull) == null) { return Status.createError(String.format("User '%s' does not have enough privileges.", person.getUserId())); @@ -69,13 +69,13 @@ public abstract class AbstractGroupPredicate<T> extends AbstractDatabaseInstance person.getUserId())); } - private SpacePE tryFindGroup(final String databaseInstanceUUID, final String groupCode) + private SpacePE tryFindSpace(final String databaseInstanceUUID, final String groupCode) { - for (final SpacePE group : groups) + for (final SpacePE space : spaces) { - if (equalIdentifier(group, databaseInstanceUUID, groupCode)) + if (equalIdentifier(space, databaseInstanceUUID, groupCode)) { - return group; + return space; } } return null; diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractTechIdPredicate.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractTechIdPredicate.java index 990790a27d8..e70913c38e4 100644 --- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractTechIdPredicate.java +++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/AbstractTechIdPredicate.java @@ -33,7 +33,7 @@ import ch.systemsx.cisd.openbis.generic.shared.util.SpaceCodeHelper; * * @author Piotr Buczek */ -public abstract class AbstractTechIdPredicate extends AbstractGroupPredicate<TechId> +public abstract class AbstractTechIdPredicate extends AbstractSpacePredicate<TechId> { private final SpaceOwnerKind entityKind; @@ -106,15 +106,15 @@ public abstract class AbstractTechIdPredicate extends AbstractGroupPredicate<Tec { assert initialized : "Predicate has not been initialized"; - SpacePE groupOrNull = authorizationDataProvider.tryToGetGroup(entityKind, techId); - if (groupOrNull == null) + final SpacePE spaceOrNull = authorizationDataProvider.tryGetSpace(entityKind, techId); + if (spaceOrNull == null) { return Status.createError(String.format("User '%s' does not have enough privileges.", person.getUserId())); } - final String spaceCode = SpaceCodeHelper.getSpaceCode(person, groupOrNull); - final DatabaseInstancePE databaseInstance = groupOrNull.getDatabaseInstance(); + final String spaceCode = SpaceCodeHelper.getSpaceCode(person, spaceOrNull); + final DatabaseInstancePE databaseInstance = spaceOrNull.getDatabaseInstance(); return evaluate(person, allowedRoles, databaseInstance, spaceCode); } diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/DataSetCodeCollectionPredicate.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/DataSetCodeCollectionPredicate.java index 050d1d27147..fdc7728cf42 100644 --- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/DataSetCodeCollectionPredicate.java +++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/DataSetCodeCollectionPredicate.java @@ -31,7 +31,7 @@ import ch.systemsx.cisd.openbis.generic.shared.dto.PersonPE; * @author Chandrasekhar Ramakrishnan */ @ShouldFlattenCollections(value = false) -public class DataSetCodeCollectionPredicate extends AbstractGroupPredicate<List<String>> +public class DataSetCodeCollectionPredicate extends AbstractSpacePredicate<List<String>> { @Override public String getCandidateDescription() diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/DataSetCodePredicate.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/DataSetCodePredicate.java index 1b244ed0db6..51c016ef003 100644 --- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/DataSetCodePredicate.java +++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/DataSetCodePredicate.java @@ -28,7 +28,7 @@ import ch.systemsx.cisd.openbis.generic.shared.dto.PersonPE; * * @author Franz-Josef Elmer */ -public class DataSetCodePredicate extends AbstractGroupPredicate<String> +public class DataSetCodePredicate extends AbstractSpacePredicate<String> { @Override public String getCandidateDescription() diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/ListSampleCriteriaPredicate.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/ListSampleCriteriaPredicate.java index e3a56fe9d0c..098469c2c1b 100644 --- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/ListSampleCriteriaPredicate.java +++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/ListSampleCriteriaPredicate.java @@ -31,7 +31,7 @@ import ch.systemsx.cisd.openbis.generic.shared.dto.PersonPE; * * @author Bernd Rinn */ -public class ListSampleCriteriaPredicate extends AbstractGroupPredicate<ListSampleCriteria> +public class ListSampleCriteriaPredicate extends AbstractSpacePredicate<ListSampleCriteria> { private final ExperimentTechIdPredicate experimentTechIdPredicate = diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/SpaceIdentifierPredicate.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/SpaceIdentifierPredicate.java index f3c2f67f248..1144ac5a8c7 100644 --- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/SpaceIdentifierPredicate.java +++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/SpaceIdentifierPredicate.java @@ -30,7 +30,7 @@ import ch.systemsx.cisd.openbis.generic.shared.util.SpaceCodeHelper; * * @author Christian Ribeaud */ -public class SpaceIdentifierPredicate extends AbstractGroupPredicate<SpaceIdentifier> +public class SpaceIdentifierPredicate extends AbstractSpacePredicate<SpaceIdentifier> { public SpaceIdentifierPredicate() { diff --git a/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/shared/authorization/AuthorizationTestCase.java b/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/shared/authorization/AuthorizationTestCase.java index a1ec1648660..aac0e32ef37 100644 --- a/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/shared/authorization/AuthorizationTestCase.java +++ b/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/shared/authorization/AuthorizationTestCase.java @@ -345,7 +345,7 @@ public class AuthorizationTestCase extends AssertJUnit allowing(provider).getHomeDatabaseInstance(); will(returnValue(databaseInstance)); - allowing(provider).listGroups(); + allowing(provider).listSpaces(); will(returnValue(groups)); } }); @@ -379,7 +379,7 @@ public class AuthorizationTestCase extends AssertJUnit context.checking(new Expectations() { { - allowing(provider).listGroups(); + allowing(provider).listSpaces(); will(returnValue(groups)); } }); @@ -396,10 +396,10 @@ public class AuthorizationTestCase extends AssertJUnit context.checking(new Expectations() { { - one(provider).listGroups(); + one(provider).listSpaces(); will(returnValue(groups)); - one(provider).tryToGetGroup(entityKind, techId); + one(provider).tryGetSpace(entityKind, techId); will(returnValue(groupPE)); } }); diff --git a/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/ListSampleCriteriaPredicateTest.java b/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/ListSampleCriteriaPredicateTest.java index 8f9bd5f2e0b..254f7c7c83b 100644 --- a/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/ListSampleCriteriaPredicateTest.java +++ b/openbis/sourceTest/java/ch/systemsx/cisd/openbis/generic/shared/authorization/predicate/ListSampleCriteriaPredicateTest.java @@ -115,7 +115,7 @@ public class ListSampleCriteriaPredicateTest extends AuthorizationTestCase context.checking(new Expectations() { { - one(provider).tryToGetGroup(SpaceOwnerKind.EXPERIMENT, new TechId(17L)); + one(provider).tryGetSpace(SpaceOwnerKind.EXPERIMENT, new TechId(17L)); will(returnValue(createGroup())); } }); @@ -136,7 +136,7 @@ public class ListSampleCriteriaPredicateTest extends AuthorizationTestCase context.checking(new Expectations() { { - one(provider).tryToGetGroup(SpaceOwnerKind.EXPERIMENT, new TechId(17L)); + one(provider).tryGetSpace(SpaceOwnerKind.EXPERIMENT, new TechId(17L)); will(returnValue(createAnotherGroup())); } }); diff --git a/screening/source/java/ch/systemsx/cisd/openbis/plugin/screening/shared/api/authorization/ExperimentIdentifierPredicate.java b/screening/source/java/ch/systemsx/cisd/openbis/plugin/screening/shared/api/authorization/ExperimentIdentifierPredicate.java index 87a7029d5d1..f775a7c38e2 100644 --- a/screening/source/java/ch/systemsx/cisd/openbis/plugin/screening/shared/api/authorization/ExperimentIdentifierPredicate.java +++ b/screening/source/java/ch/systemsx/cisd/openbis/plugin/screening/shared/api/authorization/ExperimentIdentifierPredicate.java @@ -20,7 +20,7 @@ import java.util.List; import ch.systemsx.cisd.common.exceptions.Status; import ch.systemsx.cisd.openbis.generic.shared.authorization.RoleWithIdentifier; -import ch.systemsx.cisd.openbis.generic.shared.authorization.predicate.AbstractGroupPredicate; +import ch.systemsx.cisd.openbis.generic.shared.authorization.predicate.AbstractSpacePredicate; import ch.systemsx.cisd.openbis.generic.shared.dto.ExperimentPE; import ch.systemsx.cisd.openbis.generic.shared.dto.SpacePE; import ch.systemsx.cisd.openbis.generic.shared.dto.PersonPE; @@ -32,7 +32,7 @@ import ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto.ExperimentIde * * @author Bernd Rinn */ -public class ExperimentIdentifierPredicate extends AbstractGroupPredicate<ExperimentIdentifier> +public class ExperimentIdentifierPredicate extends AbstractSpacePredicate<ExperimentIdentifier> { @Override diff --git a/screening/source/java/ch/systemsx/cisd/openbis/plugin/screening/shared/api/authorization/ScreeningPlateListReadOnlyPredicate.java b/screening/source/java/ch/systemsx/cisd/openbis/plugin/screening/shared/api/authorization/ScreeningPlateListReadOnlyPredicate.java index 6803373da24..dc0fc3689bb 100644 --- a/screening/source/java/ch/systemsx/cisd/openbis/plugin/screening/shared/api/authorization/ScreeningPlateListReadOnlyPredicate.java +++ b/screening/source/java/ch/systemsx/cisd/openbis/plugin/screening/shared/api/authorization/ScreeningPlateListReadOnlyPredicate.java @@ -21,7 +21,7 @@ import java.util.List; import ch.systemsx.cisd.common.exceptions.Status; import ch.systemsx.cisd.openbis.generic.shared.authorization.RoleWithIdentifier; import ch.systemsx.cisd.openbis.generic.shared.authorization.annotation.ShouldFlattenCollections; -import ch.systemsx.cisd.openbis.generic.shared.authorization.predicate.AbstractGroupPredicate; +import ch.systemsx.cisd.openbis.generic.shared.authorization.predicate.AbstractSpacePredicate; import ch.systemsx.cisd.openbis.generic.shared.dto.SpacePE; import ch.systemsx.cisd.openbis.generic.shared.dto.PersonPE; import ch.systemsx.cisd.openbis.generic.shared.dto.SamplePE; @@ -37,7 +37,7 @@ import ch.systemsx.cisd.openbis.plugin.screening.shared.api.v1.dto.PlateIdentifi */ @ShouldFlattenCollections(value = false) public class ScreeningPlateListReadOnlyPredicate extends - AbstractGroupPredicate<List<? extends PlateIdentifier>> + AbstractSpacePredicate<List<? extends PlateIdentifier>> { @Override -- GitLab