From fea9f5836c4a13e2024c2f678061268ab7421b8d Mon Sep 17 00:00:00 2001 From: Andrew Branson Date: Mon, 30 Jul 2012 22:09:32 +0200 Subject: Predefined steps audit, including new steps for collection management Fixes #19 --- .../instance/predefined/AddMemberToCollection.java | 107 ++++++++++++++++++ .../lifecycle/instance/predefined/AddNewSlot.java | 122 +++++++++++++++++++++ .../instance/predefined/AssignItemToSlot.java | 28 +++-- .../lifecycle/instance/predefined/ClearSlot.java | 110 +++++++++++++++++++ .../predefined/PredefinedStepContainer.java | 9 +- .../predefined/RemoveSlotFromCollection.java | 121 ++++++++++++++++++++ 6 files changed, 484 insertions(+), 13 deletions(-) create mode 100644 src/main/java/com/c2kernel/lifecycle/instance/predefined/AddMemberToCollection.java create mode 100644 src/main/java/com/c2kernel/lifecycle/instance/predefined/AddNewSlot.java create mode 100644 src/main/java/com/c2kernel/lifecycle/instance/predefined/ClearSlot.java create mode 100644 src/main/java/com/c2kernel/lifecycle/instance/predefined/RemoveSlotFromCollection.java (limited to 'src/main/java/com/c2kernel/lifecycle') diff --git a/src/main/java/com/c2kernel/lifecycle/instance/predefined/AddMemberToCollection.java b/src/main/java/com/c2kernel/lifecycle/instance/predefined/AddMemberToCollection.java new file mode 100644 index 0000000..106a9aa --- /dev/null +++ b/src/main/java/com/c2kernel/lifecycle/instance/predefined/AddMemberToCollection.java @@ -0,0 +1,107 @@ +/************************************************************************** + * AssignItemToSlot + * + * $Workfile$ + * $Revision: 1.8 $ + * $Date: 2004/10/21 08:02:19 $ + * + * Copyright (C) 2001 CERN - European Organization for Nuclear Research + * All rights reserved. + **************************************************************************/ + +package com.c2kernel.lifecycle.instance.predefined; + + +import com.c2kernel.collection.Dependency; +import com.c2kernel.collection.MembershipException; +import com.c2kernel.common.AccessRightsException; +import com.c2kernel.common.InvalidDataException; +import com.c2kernel.common.InvalidTransitionException; +import com.c2kernel.common.ObjectNotFoundException; +import com.c2kernel.entity.C2KLocalObject; +import com.c2kernel.lookup.AgentPath; +import com.c2kernel.lookup.EntityPath; +import com.c2kernel.persistency.ClusterStorage; +import com.c2kernel.persistency.ClusterStorageException; +import com.c2kernel.process.Gateway; +import com.c2kernel.utils.Logger; + +/************************************************************************** + * + * @author $Author: abranson $ $Date: 2004/10/21 08:02:19 $ + * @version $Revision: 1.8 $ + **************************************************************************/ +public class AddMemberToCollection extends PredefinedStep +{ + /************************************************************************** + * Constructor for Castor + **************************************************************************/ + public AddMemberToCollection() + { + super(); + } + + + /** + * Generates a new slot in a Dependency for the given item + * + * Params: + * 0 - collection name + * 1 - target entity key + */ + @Override + public void request(AgentPath agent, int transitionID, String requestData) + throws AccessRightsException, + InvalidTransitionException, + InvalidDataException + { + EntityPath entityPath = getItemEntityPath(); + String collName; + int entityKey; + Dependency dep; + + Logger.msg(1, "AddMemberToCollection::request() - Starting."); + + checkAccessRights(agent); + + // extract parameters + try { + entityPath = getItemEntityPath(); + String[] params = getDataList(requestData); + collName = params[0]; + entityKey = Integer.parseInt(params[1]); + } catch (Exception e) { + throw new InvalidDataException("Invalid parameters", ""); + } + + // load collection + C2KLocalObject collObj; + try { + collObj = Gateway.getStorage().get(entityPath.getSysKey(), ClusterStorage.COLLECTION+"/"+collName, null); + } catch (ObjectNotFoundException ex) { + throw new InvalidDataException("Collection '"+collName+"' not found in this Item", ""); + } catch (ClusterStorageException ex) { + Logger.error(ex); + throw new InvalidDataException("Error loading collection '\"+collName+\"': "+ex.getMessage(), ""); + } + if (!(collObj instanceof Dependency)) throw new InvalidDataException("AddMemberToCollection operates on Dependency collections only.", ""); + dep = (Dependency)collObj; + + // find member and assign entity + try { + dep.addMember(entityKey); + } catch (MembershipException e) { + throw new InvalidDataException("Entity "+entityKey+" is the wrong type for this collection", ""); + } + + try { + Gateway.getStorage().put(entityPath.getSysKey(), dep, null); + } catch (ClusterStorageException e) { + Logger.error(e); + throw new InvalidDataException("Error storing collection", ""); + } + sendEventStoreOutcome(transitionID, requestData, agent); + + Logger.msg(1, "AddMemberToCollection::request() - DONE."); + } +} diff --git a/src/main/java/com/c2kernel/lifecycle/instance/predefined/AddNewSlot.java b/src/main/java/com/c2kernel/lifecycle/instance/predefined/AddNewSlot.java new file mode 100644 index 0000000..1bc13ef --- /dev/null +++ b/src/main/java/com/c2kernel/lifecycle/instance/predefined/AddNewSlot.java @@ -0,0 +1,122 @@ +/************************************************************************** + * AssignItemToSlot + * + * $Workfile$ + * $Revision: 1.8 $ + * $Date: 2004/10/21 08:02:19 $ + * + * Copyright (C) 2001 CERN - European Organization for Nuclear Research + * All rights reserved. + **************************************************************************/ + +package com.c2kernel.lifecycle.instance.predefined; + + +import com.c2kernel.collection.Aggregation; +import com.c2kernel.common.AccessRightsException; +import com.c2kernel.common.InvalidDataException; +import com.c2kernel.common.InvalidTransitionException; +import com.c2kernel.common.ObjectNotFoundException; +import com.c2kernel.entity.C2KLocalObject; +import com.c2kernel.lookup.AgentPath; +import com.c2kernel.lookup.EntityPath; +import com.c2kernel.persistency.ClusterStorage; +import com.c2kernel.persistency.ClusterStorageException; +import com.c2kernel.process.Gateway; +import com.c2kernel.property.PropertyDescription; +import com.c2kernel.property.PropertyDescriptionList; +import com.c2kernel.property.PropertyUtility; +import com.c2kernel.utils.CastorHashMap; +import com.c2kernel.utils.Logger; + +/************************************************************************** + * + * @author $Author: abranson $ $Date: 2004/10/21 08:02:19 $ + * @version $Revision: 1.8 $ + **************************************************************************/ +public class AddNewSlot extends PredefinedStep +{ + /************************************************************************** + * Constructor for Castor + **************************************************************************/ + public AddNewSlot() + { + super(); + } + + + /** + * Creates a new slot in the given aggregation, that holds instances of the given item description + * + * Params: + * 0 - collection name + * 1 - Item Description key (optional) + */ + @Override + public void request(AgentPath agent, int transitionID, String requestData) + throws AccessRightsException, + InvalidTransitionException, + InvalidDataException + { + EntityPath entityPath = getItemEntityPath(); + String collName; + int descKey=-1; + Aggregation agg; + + Logger.msg(1, "AddNewSlot::request() - Starting."); + + checkAccessRights(agent); + + // extract parameters + try { + entityPath = getItemEntityPath(); + String[] params = getDataList(requestData); + collName = params[0]; + if (params.length > 1) descKey = Integer.parseInt(params[1]); + } catch (Exception e) { + throw new InvalidDataException("Invalid parameters", ""); + } + + // load collection + C2KLocalObject collObj; + try { + collObj = Gateway.getStorage().get(entityPath.getSysKey(), ClusterStorage.COLLECTION+"/"+collName, null); + } catch (ObjectNotFoundException ex) { + throw new InvalidDataException("Collection '"+collName+"' not found in this Item", ""); + } catch (ClusterStorageException ex) { + Logger.error(ex); + throw new InvalidDataException("Error loading collection '\"+collName+\"': "+ex.getMessage(), ""); + } + if (!(collObj instanceof Aggregation)) throw new InvalidDataException("AddNewSlot operates on Aggregation collections only.", ""); + agg = (Aggregation)collObj; + + // get props + CastorHashMap props = new CastorHashMap(); + StringBuffer classProps = new StringBuffer(); + if (descKey > -1) { + PropertyDescriptionList propList; + try { + propList = PropertyUtility.getPropertyDescriptionOutcome(descKey); + } catch (ObjectNotFoundException e) { + throw new InvalidDataException("Item "+descKey+" does not contain a PropertyDescription outcome to define a slot", ""); + } + for (PropertyDescription pd : propList.list) { + props.put(pd.getName(), pd.getDefaultValue()); + if (pd.getIsClassIdentifier()) + classProps.append((classProps.length()>0?",":"")).append(pd.getName()); + } + } + + agg.addSlot(props, classProps.toString()); + + try { + Gateway.getStorage().put(entityPath.getSysKey(), agg, null); + } catch (ClusterStorageException e) { + Logger.error(e); + throw new InvalidDataException("Error storing collection", ""); + } + sendEventStoreOutcome(transitionID, requestData, agent); + + Logger.msg(1, "AddNewSlot::request() - DONE."); + } +} diff --git a/src/main/java/com/c2kernel/lifecycle/instance/predefined/AssignItemToSlot.java b/src/main/java/com/c2kernel/lifecycle/instance/predefined/AssignItemToSlot.java index 0ad5adc..f16d76d 100644 --- a/src/main/java/com/c2kernel/lifecycle/instance/predefined/AssignItemToSlot.java +++ b/src/main/java/com/c2kernel/lifecycle/instance/predefined/AssignItemToSlot.java @@ -12,12 +12,14 @@ package com.c2kernel.lifecycle.instance.predefined; -import com.c2kernel.collection.Collection; -import com.c2kernel.collection.CollectionMember; +import com.c2kernel.collection.Aggregation; +import com.c2kernel.collection.AggregationMember; import com.c2kernel.collection.MembershipException; import com.c2kernel.common.AccessRightsException; import com.c2kernel.common.InvalidDataException; import com.c2kernel.common.InvalidTransitionException; +import com.c2kernel.common.ObjectNotFoundException; +import com.c2kernel.entity.C2KLocalObject; import com.c2kernel.lookup.AgentPath; import com.c2kernel.lookup.EntityPath; import com.c2kernel.persistency.ClusterStorage; @@ -57,7 +59,7 @@ public class AssignItemToSlot extends PredefinedStep String collName; int slotNo; int entityKey; - Collection coll; + Aggregation agg; Logger.msg(1, "AssignItemToSlot::request() - Starting."); @@ -75,17 +77,21 @@ public class AssignItemToSlot extends PredefinedStep } // load collection + C2KLocalObject collObj; try { - coll = (Collection)Gateway.getStorage().get(entityPath.getSysKey(), ClusterStorage.COLLECTION+"/"+collName, null); - } catch (Exception e) { - Logger.error(e); - throw new InvalidDataException("Error loading collection "+collName, ""); - } + collObj = Gateway.getStorage().get(entityPath.getSysKey(), ClusterStorage.COLLECTION+"/"+collName, null); + } catch (ObjectNotFoundException ex) { + throw new InvalidDataException("Collection '"+collName+"' not found in this Item", ""); + } catch (ClusterStorageException ex) { + Logger.error(ex); + throw new InvalidDataException("Error loading collection '\"+collName+\"': "+ex.getMessage(), ""); + } + if (!(collObj instanceof Aggregation)) throw new InvalidDataException("AssignItemToSlot operates on Aggregation collections only.", ""); + agg = (Aggregation)collObj; // find member and assign entity boolean stored = false; - for (Object name : coll.getMembers().list) { - CollectionMember member = (CollectionMember)name; + for (AggregationMember member : agg.getMembers().list) { if (member.getID() == slotNo) { if (member.getEntityKey() > -1) throw new InvalidDataException("Member slot not empty", ""); @@ -104,7 +110,7 @@ public class AssignItemToSlot extends PredefinedStep try { - Gateway.getStorage().put(entityPath.getSysKey(), coll, null); + Gateway.getStorage().put(entityPath.getSysKey(), agg, null); } catch (ClusterStorageException e) { Logger.error(e); throw new InvalidDataException("Error storing collection", ""); diff --git a/src/main/java/com/c2kernel/lifecycle/instance/predefined/ClearSlot.java b/src/main/java/com/c2kernel/lifecycle/instance/predefined/ClearSlot.java new file mode 100644 index 0000000..66df3b2 --- /dev/null +++ b/src/main/java/com/c2kernel/lifecycle/instance/predefined/ClearSlot.java @@ -0,0 +1,110 @@ +/************************************************************************** + * AssignItemToSlot + * + * $Workfile$ + * $Revision: 1.8 $ + * $Date: 2004/10/21 08:02:19 $ + * + * Copyright (C) 2001 CERN - European Organization for Nuclear Research + * All rights reserved. + **************************************************************************/ + +package com.c2kernel.lifecycle.instance.predefined; + + +import com.c2kernel.collection.Aggregation; +import com.c2kernel.collection.AggregationMember; +import com.c2kernel.common.AccessRightsException; +import com.c2kernel.common.InvalidDataException; +import com.c2kernel.common.InvalidTransitionException; +import com.c2kernel.common.ObjectNotFoundException; +import com.c2kernel.lookup.AgentPath; +import com.c2kernel.lookup.EntityPath; +import com.c2kernel.persistency.ClusterStorage; +import com.c2kernel.persistency.ClusterStorageException; +import com.c2kernel.process.Gateway; +import com.c2kernel.utils.Logger; + +/************************************************************************** + * + * @author $Author: abranson $ $Date: 2004/10/21 08:02:19 $ + * @version $Revision: 1.8 $ + **************************************************************************/ +public class ClearSlot extends PredefinedStep +{ + /************************************************************************** + * Constructor for Castor + **************************************************************************/ + public ClearSlot() + { + super(); + } + + + /** + * Params: + * 0 - collection name + * 1 - slot number + */ + @Override + public void request(AgentPath agent, int transitionID, String requestData) + throws AccessRightsException, + InvalidTransitionException, + InvalidDataException + { + EntityPath entityPath = getItemEntityPath(); + String collName; + int slotNo; + Aggregation agg; + + Logger.msg(1, "ClearSlot::request() - Starting."); + + checkAccessRights(agent); + + // extract parameters + try { + entityPath = getItemEntityPath(); + String[] params = getDataList(requestData); + collName = params[0]; + slotNo = Integer.parseInt(params[1]); + } catch (Exception e) { + throw new InvalidDataException("Invalid parameters", ""); + } + + // load collection + try { + agg = (Aggregation)Gateway.getStorage().get(entityPath.getSysKey(), ClusterStorage.COLLECTION+"/"+collName, null); + } catch (ObjectNotFoundException ex) { + throw new InvalidDataException("Collection '"+collName+"' not found in this Item", ""); + } catch (ClusterStorageException ex) { + Logger.error(ex); + throw new InvalidDataException("Error loading collection '\"+collName+\"': "+ex.getMessage(), ""); + } + + // find member and clear + boolean stored = false; + for (AggregationMember member : agg.getMembers().list) { + if (member.getID() == slotNo) { + if (member.getEntityKey() > -1) + throw new InvalidDataException("Member slot already empty", ""); + member.clearEntity(); + stored = true; + break; + } + } + if (!stored) { + throw new InvalidDataException("Member slot "+slotNo+" not found.", ""); + } + + + try { + Gateway.getStorage().put(entityPath.getSysKey(), agg, null); + } catch (ClusterStorageException e) { + Logger.error(e); + throw new InvalidDataException("Error storing collection", ""); + } + sendEventStoreOutcome(transitionID, requestData, agent); + + Logger.msg(1, "ClearSlot::request() - DONE."); + } +} diff --git a/src/main/java/com/c2kernel/lifecycle/instance/predefined/PredefinedStepContainer.java b/src/main/java/com/c2kernel/lifecycle/instance/predefined/PredefinedStepContainer.java index 7ea73e4..f17e5e8 100644 --- a/src/main/java/com/c2kernel/lifecycle/instance/predefined/PredefinedStepContainer.java +++ b/src/main/java/com/c2kernel/lifecycle/instance/predefined/PredefinedStepContainer.java @@ -20,11 +20,16 @@ public class PredefinedStepContainer extends CompositeActivity predInit("AddStepsFromDescription", "Creates the domain-specific LifeCycle from a description", new AddStepsFromDescription()); predInit("ReplaceDomainWorkflow", "Replaces the domain CA with the supplied one. Used by the GUI to save new Wf layout", new ReplaceDomainWorkflow()); predInit("AddC2KObject", "Adds or overwrites a C2Kernel object for this Item", new AddC2KObject()); - predInit("WriteProperty", "Writes a property to the Item", new WriteProperty()); predInit("RemoveC2KObject", "Removes the named C2Kernel object from this Item.", new RemoveC2KObject()); - predInit("AssignItemToSlot", "Assigns the referenced entity to a pre-existing slot in a collection of this one", new AssignItemToSlot()); + predInit("WriteProperty", "Writes a property to the Item", new WriteProperty()); + predInit("AddNewSlot", "Creates a new slot in the given aggregation, that holds instances of the item description of the given key", new AddNewSlot()); + predInit("AssignItemToSlot", "Assigns the referenced entity to a pre-existing slot in an aggregation", new AssignItemToSlot()); + predInit("ClearSlot", "Clears an aggregation member slot, given a slot no or entity key", new ClearSlot()); + predInit("RemoveSlotFromCollection", "Removed the given slot from the aggregation", new RemoveSlotFromCollection()); + predInit("AddMemberToCollection", "Creates a new member slot for the given item in a dependency, and assigns the item", new AddMemberToCollection()); predInit("Erase", "Deletes all objects and domain paths for this item.", new Erase()); predInit("Import", "Imports an outcome into the Item, with a given schema and viewpoint", new Import()); + } public void predInit(String alias, String Description, PredefinedStep act) diff --git a/src/main/java/com/c2kernel/lifecycle/instance/predefined/RemoveSlotFromCollection.java b/src/main/java/com/c2kernel/lifecycle/instance/predefined/RemoveSlotFromCollection.java new file mode 100644 index 0000000..897183d --- /dev/null +++ b/src/main/java/com/c2kernel/lifecycle/instance/predefined/RemoveSlotFromCollection.java @@ -0,0 +1,121 @@ +/************************************************************************** + * AssignItemToSlot + * + * $Workfile$ + * $Revision: 1.8 $ + * $Date: 2004/10/21 08:02:19 $ + * + * Copyright (C) 2001 CERN - European Organization for Nuclear Research + * All rights reserved. + **************************************************************************/ + +package com.c2kernel.lifecycle.instance.predefined; + + +import com.c2kernel.collection.Collection; +import com.c2kernel.collection.CollectionMember; +import com.c2kernel.collection.MembershipException; +import com.c2kernel.common.AccessRightsException; +import com.c2kernel.common.InvalidDataException; +import com.c2kernel.common.InvalidTransitionException; +import com.c2kernel.common.ObjectNotFoundException; +import com.c2kernel.lookup.AgentPath; +import com.c2kernel.lookup.EntityPath; +import com.c2kernel.persistency.ClusterStorage; +import com.c2kernel.persistency.ClusterStorageException; +import com.c2kernel.process.Gateway; +import com.c2kernel.utils.Logger; + +/************************************************************************** + * + * @author $Author: abranson $ $Date: 2004/10/21 08:02:19 $ + * @version $Revision: 1.8 $ + **************************************************************************/ +public class RemoveSlotFromCollection extends PredefinedStep +{ + /************************************************************************** + * Constructor for Castor + **************************************************************************/ + public RemoveSlotFromCollection() + { + super(); + } + + + /** + * Params: + * 0 - collection name + * 1 - slot number OR if null: + * 2 - target entity key + */ + @Override + public void request(AgentPath agent, int transitionID, String requestData) + throws AccessRightsException, + InvalidTransitionException, + InvalidDataException + { + EntityPath entityPath = getItemEntityPath(); + String collName; + int slotNo; + int entityKey = -1; + Collection coll; + + Logger.msg(1, "RemoveSlotFromCollection::request() - Starting."); + + checkAccessRights(agent); + + // extract parameters + try { + entityPath = getItemEntityPath(); + String[] params = getDataList(requestData); + collName = params[0]; + slotNo = params[1].length()>0?Integer.parseInt(params[1]):-1; + if (params.length>2) entityKey = params[2].length()>0?Integer.parseInt(params[2]):-1; + } catch (Exception e) { + throw new InvalidDataException("Invalid parameters", ""); + } + + if (slotNo == -1 && entityKey == -1) + throw new InvalidDataException("Must give either slot number or entity key", ""); + + // load collection + try { + coll = (Collection)Gateway.getStorage().get(entityPath.getSysKey(), ClusterStorage.COLLECTION+"/"+collName, null); + } catch (ObjectNotFoundException ex) { + throw new InvalidDataException("Collection '"+collName+"' not found in this Item", ""); + } catch (ClusterStorageException ex) { + Logger.error(ex); + throw new InvalidDataException("Error loading collection '\"+collName+\"': "+ex.getMessage(), ""); + } + + if (slotNo == -1) { // find slot from entity key + for (CollectionMember member : coll.getMembers().list) { + if (member.getEntityKey() == entityKey) { + slotNo = member.getID(); + break; + } + } + } + if (slotNo == -1) { + throw new InvalidDataException("No match", ""); + } + + // Remove the slot + try { + coll.removeMember(slotNo); + } catch (MembershipException e) { + throw new InvalidDataException(e.getMessage(), ""); + } + + // Store the collection + try { + Gateway.getStorage().put(entityPath.getSysKey(), coll, null); + } catch (ClusterStorageException e) { + Logger.error(e); + throw new InvalidDataException("Error storing collection", ""); + } + sendEventStoreOutcome(transitionID, requestData, agent); + + Logger.msg(1, "RemoveSlotFromCollection::request() - DONE."); + } +} -- cgit v1.2.3