Merge pull request #1939 from stavamichal/getFacilityAttributesByListOfAttributes

New method getAttributes for facility by list of attr names

Author: zlamalp

perun-core/src/main/java/cz/metacentrum/perun/core/api/AttributesManager.java

@@ -123,6 +123,22 @@ public interface AttributesManager {
 	 */
 	List<Attribute> getAttributes(PerunSession sess, Facility facility) throws PrivilegeException, FacilityNotExistsException, InternalErrorException;
 
+	/**
+	 * Get all attributes associated with the facility which have name in list attrNames (empty too).
+	 * Virtual attribute too.
+	 *
+	 * PRIVILEGE: Get only those attributes the principal has access to.
+	 *
+	 * @param sess      perun session
+	 * @param facility    to get the attributes from
+	 * @param attrNames list of attributes' names
+	 * @return list of attributes
+	 * @throws PrivilegeException       if privileges are not given
+	 * @throws InternalErrorException   if an exception raise in concrete implementation, the exception is wrapped in InternalErrorException
+	 * @throws FacilityNotExistsException if the facility not exists in Perun
+	 */
+	List<Attribute> getAttributes(PerunSession sess, Facility facility, List<String> attrNames) throws PrivilegeException, InternalErrorException, FacilityNotExistsException;
+
 	/**
 	 * Get all <b>non-empty</b> attributes associated with the vo.
 	 * PRIVILEGE: Get only those attributes the principal has access to.

perun-core/src/main/java/cz/metacentrum/perun/core/bl/AttributesManagerBl.java

@@ -58,6 +58,18 @@ public interface AttributesManagerBl {
 	 */
 	List<Attribute> getAttributes(PerunSession sess, Facility facility) throws InternalErrorException;
 
+	/**
+	 * Get all attributes associated with the facility which have name in list attrNames (empty too).
+	 * Virtual attribute too.
+	 *
+	 * @param sess      perun session
+	 * @param facility    to get the attributes from
+	 * @param attrNames list of attributes' names
+	 * @return list of attributes
+	 * @throws InternalErrorException   if an exception raise in concrete implementation, the exception is wrapped in InternalErrorException
+	 */
+	List<Attribute> getAttributes(PerunSession sess, Facility facility, List<String> attrNames) throws InternalErrorException;
+
 	/**
 	 * Get all <b>non-empty</b> attributes associated with the vo.
 	 *

perun-core/src/main/java/cz/metacentrum/perun/core/blImpl/AttributesManagerBlImpl.java

@@ -122,6 +122,12 @@ public List<Attribute> getAttributes(PerunSession sess, Facility facility) throw
 		return attributes;
 	}
 
+	public List<Attribute> getAttributes(PerunSession sess, Facility facility, List<String> attrNames) throws InternalErrorException {
+		if (attrNames.isEmpty()) return new ArrayList<>();
+
+		return getAttributesManagerImpl().getAttributes(sess, facility, attrNames);
+	}
+
 	public List<Attribute> getAttributes(PerunSession sess, Vo vo) throws InternalErrorException {
 		//get virtual attributes
 		List<Attribute> attributes = getAttributesManagerImpl().getVirtualAttributes(sess, vo);

perun-core/src/main/java/cz/metacentrum/perun/core/entry/AttributesManagerEntry.java

@@ -64,6 +64,20 @@ public List<Attribute> getAttributes(PerunSession sess, Facility facility) throw
 		return attributes;
 	}
 
+	public List<Attribute> getAttributes(PerunSession sess, Facility facility, List<String> attrNames) throws PrivilegeException, InternalErrorException, FacilityNotExistsException {
+		Utils.checkPerunSession(sess);
+		getPerunBl().getFacilitiesManagerBl().checkFacilityExists(sess, facility);
+		List<Attribute> attributes = getAttributesManagerBl().getAttributes(sess, facility, attrNames);
+		Iterator<Attribute> attrIter = attributes.iterator();
+		//Choose to which attributes has the principal access
+		while(attrIter.hasNext()) {
+			Attribute attrNext = attrIter.next();
+			if(!AuthzResolver.isAuthorizedForAttribute(sess, ActionType.READ, new AttributeDefinition(attrNext), facility, null)) attrIter.remove();
+			else attrNext.setWritable(AuthzResolver.isAuthorizedForAttribute(sess, ActionType.WRITE, attrNext, facility, null));
+		}
+		return attributes;
+	}
+
 	public List<Attribute> getAttributes(PerunSession sess, Vo vo) throws PrivilegeException, VoNotExistsException, InternalErrorException {
 		Utils.checkPerunSession(sess);
 		getPerunBl().getVosManagerBl().checkVoExists(sess, vo);

perun-core/src/main/java/cz/metacentrum/perun/core/impl/AttributesManagerImpl.java

@@ -687,6 +687,27 @@ public List<Attribute> getAttributes(PerunSession sess, Facility facility) throw
 		}
 	}
 
+	public List<Attribute> getAttributes(PerunSession sess, Facility facility, List<String> attrNames) throws InternalErrorException {
+		MapSqlParameterSource parameters = new MapSqlParameterSource();
+		parameters.addValue("fId", facility.getId());
+		parameters.addValue("nSC", AttributesManager.NS_FACILITY_ATTR_CORE);
+		parameters.addValue("nSO", AttributesManager.NS_FACILITY_ATTR_OPT);
+		parameters.addValue("nSD", AttributesManager.NS_FACILITY_ATTR_DEF);
+		parameters.addValue("nSV", AttributesManager.NS_FACILITY_ATTR_VIRT);
+		parameters.addValue("attrNames", attrNames);
+
+		try {
+			return namedParameterJdbcTemplate.query("select " + getAttributeMappingSelectQuery("fav") + " from attr_names " +
+							"left join facility_attr_values fav on id=fav.attr_id and facility_id=:fId " +
+							"where namespace in ( :nSC,:nSO,:nSD,:nSV ) and attr_names.attr_name in ( :attrNames )",
+					parameters, new SingleBeanAttributeRowMapper<>(sess, this, facility));
+		} catch (EmptyResultDataAccessException ex) {
+			return new ArrayList<>();
+		} catch (RuntimeException ex) {
+			throw new InternalErrorException(ex);
+		}
+	}
+
 	private List<Attribute> getVirtualAttributes(RowMapper<Attribute> rowMapper, String namespace) throws InternalErrorException {
 		try {
 			return jdbc.query("SELECT " + attributeDefinitionMappingSelectQuery + ", NULL AS attr_value FROM attr_names WHERE namespace=?", rowMapper, namespace);

perun-core/src/main/java/cz/metacentrum/perun/core/implApi/AttributesManagerImplApi.java

@@ -57,6 +57,18 @@ public interface AttributesManagerImplApi {
 	 */
 	List<Attribute> getAttributes(PerunSession sess, Facility facility) throws InternalErrorException;
 
+	/**
+	 * Get all attributes associated with the facility which have name in list attrNames (empty too).
+	 * Virtual attribute too.
+	 *
+	 * @param sess      perun session
+	 * @param facility    to get the attributes from
+	 * @param attrNames list of attributes' names
+	 * @return list of attributes
+	 * @throws InternalErrorException   if an exception raise in concrete implementation, the exception is wrapped in InternalErrorException
+	 */
+	List<Attribute> getAttributes(PerunSession sess, Facility facility, List<String> attrNames) throws InternalErrorException;
+
 	/**
 	 * Get all virtual attributes associated with the facility.
 	 *

perun-core/src/test/java/cz/metacentrum/perun/core/entry/AttributesManagerEntryIntegrationTest.java

@@ -57,6 +57,7 @@
 import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
@@ -515,7 +516,7 @@ public void setGroupNameWillProduceSettingMoreThanOneGIDAtOnce() throws Exceptio
 		perun.getAttributesManagerBl().setAttribute(sess, f1, GIDNamespaceForFacilities);
 		GIDNamespaceForFacilities.setValue(namespaceBBB);
 		perun.getAttributesManagerBl().setAttribute(sess, f2, GIDNamespaceForFacilities);
-		
+
 		//create new service and assigne it to resources
 		Service s1 = new Service(0, "testService01", null);
 		s1 = perun.getServicesManagerBl().createService(sess, s1);
@@ -931,6 +932,33 @@ public void getFacilityAttributes() throws Exception {
 
 	}
 
+	@Test
+	public void getFacilityAttributesByListOfAttrNames() throws Exception {
+		System.out.println(CLASS_NAME + "getFacilityAttributesByListOfAttrNames");
+
+		facility = setUpFacility();
+		attributes = setUpFacilityAttribute();
+		attributesManager.setAttribute(sess, facility, attributes.get(0));
+
+		List<Attribute> retAttr = attributesManager.getAttributes(sess, facility, Collections.singletonList(attributes.get(0).getName()));
+
+		assertTrue("our atttribute not returned",retAttr.contains(attributes.get(0)));
+		assertTrue("returned more than 1 attribute",retAttr.size() == 1);
+	}
+
+	@Test
+	public void getFacilityAttributesByEmptyListOfAttrNames() throws Exception {
+		System.out.println(CLASS_NAME + "getFacilityAttributesByEmptyListOfAttrNames");
+
+		facility = setUpFacility();
+		attributes = setUpFacilityAttribute();
+		attributesManager.setAttribute(sess, facility, attributes.get(0));
+
+		List<Attribute> retAttr = attributesManager.getAttributes(sess, facility, Collections.EMPTY_LIST);
+
+		assertTrue("our list of attributes is not empty",retAttr.isEmpty());
+	}
+
 	@Test (expected=FacilityNotExistsException.class)
 	public void getFacilityAttributesWhenFacilityNotExists() throws Exception {
 		System.out.println(CLASS_NAME + "getFacilityAttributesWhenFacilityNotExists");

perun-rpc/src/main/java/cz/metacentrum/perun/rpc/methods/AttributesManagerMethod.java

@@ -32,6 +32,15 @@ public enum AttributesManagerMethod implements ManagerMethod {
 	 * @return List<Attribute> All non-empty Facility attributes
 	 * @throw FacilityNotExistsException When Facility with <code>id</code> doesn't exist.
 	 */
+	/*#
+	 * Returns all specified Facility attributes for selected Facility
+	 * If <code>attrNames</code> is empty, it returns empty list of attributes
+	 *
+	 * @param facility int Facility <code>id</code>
+	 * @param attrNames List<String> Attribute names
+	 * @return List<Attribute> Specified Facility attributes
+	 * @throw FacilityNotExistsException When Facility with <code>id</code> doesn't exist.
+	 */
 	/*#
 	 * Returns all non-empty Vo attributes for selected Vo.
 	 *
@@ -254,8 +263,14 @@ public List<Attribute> call(ApiCaller ac, Deserializer parms) throws PerunExcept
 								ac.getUserById(parms.readInt("user")));
 					}
 				} else {
-					return ac.getAttributesManager().getAttributes(ac.getSession(),
-							ac.getFacilityById(parms.readInt("facility")));
+					if (parms.contains("attrNames")) {
+						return ac.getAttributesManager().getAttributes(ac.getSession(),
+								ac.getFacilityById(parms.readInt("facility")),
+								parms.readList("attrNames", String.class));
+					} else {
+						return ac.getAttributesManager().getAttributes(ac.getSession(),
+								ac.getFacilityById(parms.readInt("facility")));
+					}
 				}
 			} else if (parms.contains("vo")) {
 				if (parms.contains("attrNames")) {