/*
* #%L
* Alfresco Records Management Module
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* -
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
* -
* 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/>.
* #L%
*/
package org.alfresco.module.org_alfresco_module_rm.script.slingshot;
import static org.alfresco.util.WebScriptUtils.getRequestContentAsJSONObject;
import static org.alfresco.util.WebScriptUtils.getStringValueFromJSONObject;
import java.util.HashMap;
import java.util.Map;
import org.alfresco.module.org_alfresco_module_rm.recordableversion.RecordableVersionConfigService;
import org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript;
import org.alfresco.service.cmr.repository.NodeRef;
import org.json.JSONObject;
import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptRequest;
/**
* REST API to set the recorded version config for a document
*
* @author Tuna Aksoy
* @since 2.3
*/
public class RecordedVersionConfigPost extends AbstractRmWebScript
{
/** Constant for recorded version parameter */
public static final String RECORDED_VERSION = "recordedVersion";
/** Recordable version config service */
private RecordableVersionConfigService recordableVersionConfigService;
/**
* Gets the recordable version config service
*
* @return The recordable version config service
*/
protected RecordableVersionConfigService getRecordableVersionConfigService()
{
return this.recordableVersionConfigService;
}
/**
* Sets the recordable version config service
*
* @param recordableVersionConfigService The recordable version config service
*/
public void setRecordableVersionConfigService(RecordableVersionConfigService recordableVersionConfigService)
{
this.recordableVersionConfigService = recordableVersionConfigService;
}
/**
* @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache)
*/
@Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
{
NodeRef nodeRef = parseRequestForNodeRef(req);
String policy = getRecordableVersionPolicy(req);
getRecordableVersionConfigService().setVersion(nodeRef, policy);
return new HashMap<String, Object>(1);
}
/**
* Gets the recordable version policy from the request
*
* @param The webscript request
* @return The recordable version policy
*/
private String getRecordableVersionPolicy(WebScriptRequest req)
{
JSONObject requestContent = getRequestContentAsJSONObject(req);
return getStringValueFromJSONObject(requestContent, RECORDED_VERSION);
}
}