inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-21 18:09:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

RM-2604 Implementation of JSON-based caveat DAO.

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/DEV/caveatmarkdatatype@114109 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tom Page
2015-10-12 10:35:19 +00:00
parent 205ffc8073
commit 701f39d4d5
2 changed files with 174 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/caveat/CaveatException.java
View File

@@ -53,4 +53,21 @@ public class CaveatException extends AlfrescoRuntimeException
super("Could not find caveat mark with id " + caveatMarkId); super("Could not find caveat mark with id " + caveatMarkId);
} }
} }
/** The caveat configuration file contains errors. */
public static class MalformedConfiguration extends CaveatException
{
/** serial version uid */
private static final long serialVersionUID = -4486048933410071424L;
public MalformedConfiguration(String message)
{
super(message);
}
public MalformedConfiguration(String message, Throwable cause)
{
super(message, cause);
}
}
} }

157
rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/caveat/dao/CaveatDAOFromJSON.java Normal file
View File

@@ -0,0 +1,157 @@
/*
* Copyright (C) 2005-2015 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.caveat.dao;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.alfresco.module.org_alfresco_module_rm.caveat.CaveatException.MalformedConfiguration;
import org.alfresco.module.org_alfresco_module_rm.caveat.scheme.CaveatGroup;
import org.alfresco.module.org_alfresco_module_rm.caveat.scheme.CaveatGroupType;
import org.alfresco.module.org_alfresco_module_rm.caveat.scheme.CaveatMark;
import org.apache.commons.io.IOUtils;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import org.json.JSONTokener;
/**
* An object that provides access to the configured caveat groups and marks, which it retrieves from JSON files.
*
* @author Tom Page
* @since 2.4.a
*/
public class CaveatDAOFromJSON implements CaveatDAOInterface
{
/** JSON key for the group id. */
private static final String GROUP_ID_JSON_KEY = "id";
/** JSON key for the group display label key. */
private static final String GROUP_DISPLAY_LABEL_JSON_KEY = "displayLabel";
/** JSON key for the group description key. */
private static final String DESCRIPTION_JSON_KEY = "description";
/** JSON key for the group type. */
private static final String TYPE_JSON_KEY = "type";
/** JSON key for the caveat marks array. */
private static final String MARKS_JSON_KEY = "marks";
/** JSON key for the mark id. */
private static final String MARK_ID_JSON_KEY = "id";
/** JSON key for the mark display label key. */
private static final String MARK_DISPLAY_LABEL_JSON_KEY = "displayLabel";
/** The location of the configuration file relative to the classpath. */
String configLocation;
/** Set the location of the configuration file relative to the classpath. */
public void setConfigLocation(String configLocation)
{
this.configLocation = configLocation;
}
/**
* {@inheritDoc}
*
* @throws MalformedConfiguration If the configuration file cannot be interpreted.
*/
@Override
public Map<String, CaveatGroup> getCaveatGroups()
{
Map<String, CaveatGroup> result = new HashMap<>();
try (final InputStream in = this.getClass().getResourceAsStream(configLocation))
{
if (in != null)
{
final String jsonString = IOUtils.toString(in);
final JSONArray jsonArray = new JSONArray(new JSONTokener(jsonString));
for (int i = 0; i < jsonArray.length(); i++)
{
final JSONObject nextObj = jsonArray.getJSONObject(i);
CaveatGroup caveatGroup = createGroup(nextObj);
String caveatGroupId = caveatGroup.getId();
if (result.containsKey(caveatGroupId)) { throw new MalformedConfiguration(
"Configuration contains two caveat groups with id " + caveatGroupId); }
result.put(caveatGroupId, caveatGroup);
}
}
}
catch (IOException | JSONException e)
{
String message = "Could not read caveat configuration: " + configLocation;
throw new MalformedConfiguration(message, e);
}
return result;
}
/**
* Create a caveat group from the supplied JSON.
*
* @param jsonGroup The JSON object corresponding to a single group and its marks.
* @return The created group.
* @throws JSONException If there is an issue reading the JSON.
*/
private CaveatGroup createGroup(JSONObject jsonGroup) throws JSONException
{
String id = jsonGroup.getString(GROUP_ID_JSON_KEY);
String displayLabelKey = jsonGroup.getString(GROUP_DISPLAY_LABEL_JSON_KEY);
String descriptionKey = jsonGroup.getString(DESCRIPTION_JSON_KEY);
String caveatGroupTypeString = jsonGroup.getString(TYPE_JSON_KEY);
CaveatGroupType caveatGroupType;
try
{
caveatGroupType = CaveatGroupType.valueOf(caveatGroupTypeString);
}
catch (IllegalArgumentException e)
{
throw new MalformedConfiguration("Unrecognised caveat group type " + caveatGroupTypeString, e);
}
// Create a list of the configured caveat marks.
List<CaveatMark> caveatMarks = new ArrayList<>();
JSONArray jsonMarks = jsonGroup.getJSONArray(MARKS_JSON_KEY);
for (int i = 0; i < jsonMarks.length(); i++)
{
JSONObject jsonMark = jsonMarks.getJSONObject(i);
caveatMarks.add(createMark(jsonMark));
}
// Instantiate the group (and associate the marks with the group).
CaveatGroup caveatGroup = new CaveatGroup(id, displayLabelKey, descriptionKey, caveatGroupType, caveatMarks);
return caveatGroup;
}
/**
* Create a caveat mark from the supplied JSON. This does not set the group id of the caveat mark.
*
* @param jsonMark The JSON object corresponding to a single mark.
* @return The created mark.
* @throws JSONException If there is an issue reading the JSON.
*/
private CaveatMark createMark(JSONObject jsonMark) throws JSONException
{
String id = jsonMark.getString(MARK_ID_JSON_KEY);
String displayLabelKey = jsonMark.getString(MARK_DISPLAY_LABEL_JSON_KEY);
return new CaveatMark(id, displayLabelKey);
}
}