inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-31 17:39:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

RM-664 (Not possible to edit event without changing the name)

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/BRANCHES/V2.0@48749 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tuna Aksoy
2013-04-02 22:21:56 +00:00
parent 48383b497e
commit ccf4f1cd54
7 changed files with 542 additions and 377 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
rm-server/config/alfresco/module/org_alfresco_module_rm/rm-service-context.xml
View File

@@ -606,7 +606,8 @@
org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService.addEvent=RM_ALLOW
org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService.removeEvent=RM_ALLOW
org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService.existsEvent=RM_ALLOW
org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService.existsEventDisplayLabel=RM_ALLOW
org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService.canCreateEvent=RM_ALLOW
org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService.canEditEvent=RM_ALLOW
org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService.*=RM_DENY
]]>
</value>

7
rm-server/config/alfresco/module/org_alfresco_module_rm/rm-webscript-context.xml
View File

@@ -245,6 +245,9 @@
<!-- RM Event API-->
<!-- Abstract parent bean for RM event beans -->
<bean id="rmEventBase" parent="webscript" abstract="true" />
<bean id="webscript.org.alfresco.rma.admin.rmevent.rmeventtypes.get" class="org.alfresco.module.org_alfresco_module_rm.script.admin.RmEventTypesGet" parent="webscript">
<property name="recordsManagementEventService" ref="RecordsManagementEventService"/>
</bean>
@@ -253,7 +256,7 @@
<property name="recordsManagementEventService" ref="RecordsManagementEventService"/>
</bean>
<bean id="webscript.org.alfresco.rma.admin.rmevent.rmevents.post" class="org.alfresco.module.org_alfresco_module_rm.script.admin.RmEventsPost" parent="webscript">
<bean id="webscript.org.alfresco.rma.admin.rmevent.rmevents.post" class="org.alfresco.module.org_alfresco_module_rm.script.admin.RmEventsPost" parent="rmEventBase">
<property name="recordsManagementEventService" ref="RecordsManagementEventService"/>
</bean>
@@ -261,7 +264,7 @@
<property name="recordsManagementEventService" ref="RecordsManagementEventService"/>
</bean>
<bean id="webscript.org.alfresco.rma.admin.rmevent.rmevent.put" class="org.alfresco.module.org_alfresco_module_rm.script.admin.RmEventPut" parent="webscript">
<bean id="webscript.org.alfresco.rma.admin.rmevent.rmevent.put" class="org.alfresco.module.org_alfresco_module_rm.script.admin.RmEventPut" parent="rmEventBase">
<property name="recordsManagementEventService" ref="RecordsManagementEventService"/>
</bean>

16
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventService.java
View File

@@ -74,12 +74,22 @@ public interface RecordsManagementEventService
boolean existsEvent(String eventName);
/**
* Indicates whether a particular event display label exists. Returns true if it does, false otherwise.
* Indicates whether a particular event can be created. Returns true if it is possible, false otherwise.
*
* @param eventDisplayLabel event display label
* @return true if event display label exists, false otherwise
* @param eventName event name
* @return true if the event can be created, false otherwise
*/
boolean existsEventDisplayLabel(String eventDisplayLabel);
boolean canCreateEvent(String eventDisplayLabel, String eventName);
/**
* Indicates whether a particular event can be edited. Returns true if it is possible, false otherwise.
*
* @param eventDisplayLabel event display label
* @param eventName event name
* @return true if the event can be edited, false otherwise
*/
boolean canEditEvent(String eventDisplayLabel, String eventName);
/**
* Add an event

85
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/event/RecordsManagementEventServiceImpl.java
View File

@@ -33,6 +33,7 @@ import org.alfresco.service.cmr.repository.ContentWriter;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.util.ParameterCheck;
import org.json.JSONArray;
import org.json.JSONObject;
@@ -123,22 +124,74 @@ public class RecordsManagementEventServiceImpl implements RecordsManagementEvent
return getEventMap().containsKey(eventName);
}
/**
* @see org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService#existsEventDisplayLabel(java.lang.String)
*/
@SuppressWarnings("rawtypes")
public boolean existsEventDisplayLabel(String eventDisplayLabel)
{
for (Iterator iterator = getEventMap().values().iterator(); iterator.hasNext();)
{
RecordsManagementEvent recordsManagementEvent = (RecordsManagementEvent) iterator.next();
if (recordsManagementEvent.getDisplayLabel().equalsIgnoreCase(eventDisplayLabel))
{
return true;
}
}
return false;
}
/**
* @see org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService#canCreateEvent(java.lang.String, java.lang.String)
*/
@SuppressWarnings("rawtypes")
public boolean canCreateEvent(String eventDisplayLabel, String eventName)
{
ParameterCheck.mandatoryString("eventDisplayLabel", eventDisplayLabel);
ParameterCheck.mandatoryString("eventName", eventName);
boolean canCreateEvent = true;
if (existsEvent(eventName) == true)
{
canCreateEvent = false;
}
if (canCreateEvent == true)
{
for (Iterator iterator = getEventMap().values().iterator(); iterator.hasNext();)
{
RecordsManagementEvent recordsManagementEvent = (RecordsManagementEvent) iterator.next();
if (recordsManagementEvent.getDisplayLabel().equalsIgnoreCase(eventDisplayLabel))
{
canCreateEvent = false;
break;
}
}
}
return canCreateEvent;
}
/**
* @see org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService#canEditEvent(java.lang.String, java.lang.String)
*/
@SuppressWarnings("rawtypes")
public boolean canEditEvent(String eventDisplayLabel, String eventName)
{
ParameterCheck.mandatoryString("eventDisplayLabel", eventDisplayLabel);
ParameterCheck.mandatoryString("eventName", eventName);
boolean canEditEvent = true;
if (existsEvent(eventName) == false)
{
throw new AlfrescoRuntimeException("The event '" + eventName + "' does not exist.");
}
for (Iterator iterator = getEventMap().values().iterator(); iterator.hasNext();)
{
RecordsManagementEvent recordsManagementEvent = (RecordsManagementEvent) iterator.next();
if (recordsManagementEvent.getDisplayLabel().equalsIgnoreCase(eventDisplayLabel))
{
if (recordsManagementEvent.getName().equalsIgnoreCase(eventName))
{
canEditEvent = false;
}
else
{
throw new AlfrescoRuntimeException("Cannot edit event. An event with the display label '"
+ eventDisplayLabel + "' already exist.");
}
break;
}
}
return canEditEvent;
}
/**
* @see org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService#addEvent(java.lang.String, java.lang.String, java.lang.String)

67
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/script/admin/RMEventBase.java Normal file
View File

@@ -0,0 +1,67 @@
/*
* Copyright (C) 2005-2013 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.module.org_alfresco_module_rm.script.admin;
import org.apache.commons.lang.StringUtils;
import org.json.JSONException;
import org.json.JSONObject;
import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
/**
* Base class for Records management event web scripts
*
* @author Tuna Aksoy
* @since 2.1
*/
public class RMEventBase extends DeclarativeWebScript
{
/**
* Helper method for getting the value for a key from a JSON object
*
* @param json The request content as JSON object
* @param key The key for which the value should be retrieved (e.g. "eventName")
* @return String The value for the provided key if the key exists, null otherwise
* @throws JSONException If there is no string value for the key
*/
protected String getValue(JSONObject json, String key) throws JSONException
{
String result = null;
if (json.has(key) == true)
{
result = json.getString(key);
}
return result;
}
/**
* Helper method for checking the key (e.g. "eventName")
*
* @param key String The key which will be checked
* @param msg String The error message to throw if the key doesn't have a value
*/
protected void doCheck(String key, String msg)
{
if (StringUtils.isBlank(key))
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, msg);
}
}
}

110
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/script/admin/RmEventPut.java
View File

@@ -22,30 +22,26 @@ import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEvent;
import org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.alfresco.util.ParameterCheck;
import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONTokener;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
* Records management event PUT web script
*
* @author Roy Wetherall
*/
public class RmEventPut extends DeclarativeWebScript
public class RmEventPut extends RMEventBase
{
@SuppressWarnings("unused")
private static Log logger = LogFactory.getLog(RmEventPut.class);
/** Reccords management event service */
/** Records management event service */
private RecordsManagementEventService rmEventService;
/**
@@ -58,59 +54,49 @@ public class RmEventPut extends DeclarativeWebScript
this.rmEventService = rmEventService;
}
/**
* @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest,
* org.springframework.extensions.webscripts.Status,
* org.springframework.extensions.webscripts.Cache)
*/
@Override
public Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
{
ParameterCheck.mandatory("req", req);
Map<String, Object> model = new HashMap<String, Object>();
JSONObject json = null;
try
{
// Event name
Map<String, String> templateVars = req.getServiceMatch().getTemplateVars();
String eventName = templateVars.get("eventname");
if (eventName == null)
{
throw new WebScriptException(Status.STATUS_NOT_FOUND, "No event name was provided on the URL.");
}
// Check the event exists
if (rmEventService.existsEvent(eventName) == false)
{
throw new WebScriptException(Status.STATUS_NOT_FOUND, "The event " + eventName + " does not exist.");
}
// Convert the request content to JSON
json = new JSONObject(new JSONTokener(req.getContent().getContent()));
String eventDisplayLabel = null;
if (json.has("eventDisplayLabel") == true)
// Check the event name
String eventName = getValue(json, "eventName");
doCheck(eventName, "No event name was provided.");
// Check the event display label
String eventDisplayLabel = getValue(json, "eventDisplayLabel");
doCheck(eventDisplayLabel, "No event display label was provided.");
// Check if the event can be edited or not
RecordsManagementEvent event = null;
if (canEditEvent(eventDisplayLabel, eventName) == true)
{
eventDisplayLabel = json.getString("eventDisplayLabel");
// Check the event type
String eventType = getValue(json, "eventType");
doCheck(eventType, "No event type was provided.");
// Create event
event = rmEventService.addEvent(eventType, eventName, eventDisplayLabel);
}
if (eventDisplayLabel == null || eventDisplayLabel.length() == 0)
else
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "No event display label provided.");
}
if (rmEventService.existsEventDisplayLabel(eventDisplayLabel))
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST,
"Cannot edit event. The event display label '"
+ eventDisplayLabel + "' already exists.");
// Get event
event = rmEventService.getEvent(eventName);
}
String eventType = null;
if (json.has("eventType") == true)
{
eventType = json.getString("eventType");
}
if (eventType == null || eventType.length() == 0)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "No event type provided.");
}
RecordsManagementEvent event = rmEventService.addEvent(eventType, eventName, eventDisplayLabel);
model.put("event", event);
}
catch (IOException iox)
{
@@ -125,4 +111,28 @@ public class RmEventPut extends DeclarativeWebScript
return model;
}
/**
* Helper method for checking if an event can be edited or not. Throws an
* error if an event with the same display label already exists.
*
* @param eventDisplayLabel The display label of the event
* @param eventName The name of the event
* @return true if the event can be edited, false otherwise
*/
private boolean canEditEvent(String eventDisplayLabel, String eventName)
{
boolean canEditEvent;
try
{
canEditEvent = rmEventService.canEditEvent(eventDisplayLabel, eventName);
}
catch (AlfrescoRuntimeException are)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, are.getLocalizedMessage());
}
return canEditEvent;
}
}

119
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/script/admin/RmEventsPost.java
View File

@@ -25,28 +25,24 @@ import java.util.Map;
import org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEvent;
import org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService;
import org.alfresco.util.GUID;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.alfresco.util.ParameterCheck;
import org.apache.commons.lang.StringUtils;
import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONTokener;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
*
* Records management event POST web script
*
* @author Roy Wetherall
*/
public class RmEventsPost extends DeclarativeWebScript
public class RmEventsPost extends RMEventBase
{
@SuppressWarnings("unused")
private static Log logger = LogFactory.getLog(RmEventsPost.class);
/** Reccords management event service */
/** Records management event service */
private RecordsManagementEventService rmEventService;
/**
@@ -59,57 +55,41 @@ public class RmEventsPost extends DeclarativeWebScript
this.rmEventService = rmEventService;
}
/**
* @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest,
* org.springframework.extensions.webscripts.Status,
* org.springframework.extensions.webscripts.Cache)
*/
@Override
public Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
{
ParameterCheck.mandatory("req", req);
Map<String, Object> model = new HashMap<String, Object>();
JSONObject json = null;
try
{
// Convert the request content to JSON
json = new JSONObject(new JSONTokener(req.getContent().getContent()));
String eventName = null;
if (json.has("eventName") == true)
{
eventName = json.getString("eventName");
}
// Get the event name
String eventName = getEventName(json);
if (eventName == null || eventName.length() == 0)
{
// Generate the event name
eventName = GUID.generate();
}
// Check the event display label
String eventDisplayLabel = getValue(json, "eventDisplayLabel");
doCheck(eventDisplayLabel, "No event display label was provided.");
String eventDisplayLabel = null;
if (json.has("eventDisplayLabel") == true)
{
eventDisplayLabel = json.getString("eventDisplayLabel");
}
if (eventDisplayLabel == null || eventDisplayLabel.length() == 0)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "No event display label provided.");
}
if (rmEventService.existsEventDisplayLabel(eventDisplayLabel))
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST,
"Cannot create event. The event display label '"
+ eventDisplayLabel + "' already exists.");
}
// Check if the event can be created
canCreateEvent(eventDisplayLabel, eventName);
String eventType = null;
if (json.has("eventType") == true)
{
eventType = json.getString("eventType");
}
if (eventType == null || eventType.length() == 0)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST, "No event type provided.");
}
// Check the event type
String eventType = getValue(json, "eventType");
doCheck(eventType, "No event type was provided.");
// Create event
RecordsManagementEvent event = rmEventService.addEvent(eventType, eventName, eventDisplayLabel);
model.put("event", event);
model.put("event", event);
}
catch (IOException iox)
{
@@ -124,4 +104,45 @@ public class RmEventsPost extends DeclarativeWebScript
return model;
}
/**
* Helper method for getting the event name
*
* @param json The request content as JSON object
* @return String The event name. A generated GUID if it doesn't exist
* @throws JSONException If there is no string value for the key
*/
private String getEventName(JSONObject json) throws JSONException
{
String eventName = getValue(json, "eventName");
if (StringUtils.isBlank(eventName))
{
// Generate the event name
eventName = GUID.generate();
}
return eventName;
}
/**
* Helper method for checking if an event can be created or not. Throws an
* error if the event already exists.
*
* @param eventDisplayLabel The display label of the event
* @param eventName The name of the event
*/
private boolean canCreateEvent(String eventDisplayLabel, String eventName)
{
boolean canCreateEvent = true;
if (rmEventService.canCreateEvent(eventDisplayLabel, eventName) == false)
{
throw new WebScriptException(Status.STATUS_BAD_REQUEST,
"Cannot create event. An event with the display label '"
+ eventDisplayLabel + "' already exists.");
}
return canCreateEvent;
}
}