First cut of a replication javascript API. Covers the basics, but not tests yet

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Nick Burch
2010-08-13 11:54:51 +00:00
parent 295e83b953
commit 6cf0b47522
2 changed files with 260 additions and 0 deletions

View File

@@ -0,0 +1,129 @@
/*
* Copyright (C) 2005-2010 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.repo.replication.script;
import java.util.List;
import org.alfresco.repo.jscript.ScriptAction;
import org.alfresco.repo.jscript.ScriptNode;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.action.ActionDefinition;
import org.alfresco.service.cmr.replication.ReplicationDefinition;
import org.alfresco.service.cmr.replication.ReplicationService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.mozilla.javascript.Scriptable;
/**
* ReplicationDefinition JavaScript Object. This class is a JavaScript-friendly wrapper for
* the {@link ReplicationDefinition replicationDefinition} class.
*
* @author Nick Burch
* @see org.alfresco.service.cmr.replication.ReplicationDefinition
*/
public final class ScriptReplicationDefinition extends ScriptAction
{
private static final long serialVersionUID = -6729144733846247372L;
private ReplicationService replicationService;
public ScriptReplicationDefinition(ServiceRegistry serviceRegistry, ReplicationService replicationService,
Scriptable scope, ReplicationDefinition replicationDefinition)
{
super(serviceRegistry, (Action)replicationDefinition, (ActionDefinition)replicationDefinition);
this.replicationService = replicationService;
}
/**
* Returns the name of this replication definition
*
* @return the name which uniquely identifies this replication definition.
*/
public String getReplicationName()
{
return getReplicationDefinition().getReplicationName();
}
public String getDescription()
{
return getReplicationDefinition().getDescription();
}
public String getTargetName()
{
return getReplicationDefinition().getTargetName();
}
public void setTargetName(String target)
{
getReplicationDefinition().setTargetName(target);
}
public ScriptNode[] getPayload()
{
List<NodeRef> payload = getReplicationDefinition().getPayload();
ScriptNode[] nodes = new ScriptNode[payload.size()];
for(int i=0; i<nodes.length; i++)
{
nodes[i] = new ScriptNode(payload.get(i), services);
}
return nodes;
}
public void setPayload(ScriptNode[] payloadNodes)
{
List<NodeRef> payload = getReplicationDefinition().getPayload();
payload.clear();
for(ScriptNode payloadNode : payloadNodes)
{
payload.add(payloadNode.getNodeRef());
}
}
@Override
public String toString()
{
StringBuilder msg = new StringBuilder();
msg.append(this.getClass().getSimpleName())
.append("[").append(getReplicationName()).append("]");
return msg.toString();
}
ReplicationDefinition getReplicationDefinition()
{
return (ReplicationDefinition)action;
}
/**
* Triggers the execution of the replication.
*/
public void replicate()
{
executeImpl(null);
}
@Override
protected void executeImpl(ScriptNode node)
{
ReplicationDefinition replicationDefinition = getReplicationDefinition();
replicationService.replicate(replicationDefinition);
}
}

View File

@@ -0,0 +1,131 @@
/*
* Copyright (C) 2005-2010 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.repo.replication.script;
import java.util.List;
import org.alfresco.repo.jscript.BaseScopableProcessorExtension;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.replication.ReplicationDefinition;
import org.alfresco.service.cmr.replication.ReplicationService;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Script object representing the replication service.
*
* @author Nick Burch
*/
public class ScriptReplicationService extends BaseScopableProcessorExtension
{
private static Log logger = LogFactory.getLog(ScriptReplicationService.class);
/** The Services registry */
private ServiceRegistry serviceRegistry;
private ReplicationService replicationService;
/**
* Set the service registry
*
* @param serviceRegistry the service registry.
*/
public void setServiceRegistry(ServiceRegistry serviceRegistry)
{
this.serviceRegistry = serviceRegistry;
}
/**
* Set the replication service
*
* @param replicationService the replication service.
*/
public void setReplicationService(ReplicationService replicationService)
{
this.replicationService = replicationService;
}
/**
* Creates a new {@link ScriptReplicationDefinition} and sets the replication name and
* the description to the specified values.
*
* @param replicationName A unique identifier used to specify the created
* {@link ScriptReplicationDefinition}.
* @param description A description of the replication
* @return the created {@link ScriptReplicationDefinition}.
* @see org.alfresco.service.cmr.replication.ReplicationService#createReplicationDefinition(String, String)
*/
public ScriptReplicationDefinition createReplicationDefinition(String replicationName, String description)
{
if (logger.isDebugEnabled())
{
StringBuilder msg = new StringBuilder();
msg.append("Creating ScriptReplicationDefinition [")
.append(replicationName).append(", ")
.append(description).append("]");
logger.debug(msg.toString());
}
ReplicationDefinition replicationDefinition = replicationService.createReplicationDefinition(replicationName, description);
return new ScriptReplicationDefinition(serviceRegistry, replicationService, this.getScope(), replicationDefinition);
}
public void saveReplicationDefinition(ScriptReplicationDefinition definition)
{
if (logger.isDebugEnabled())
{
StringBuilder msg = new StringBuilder();
msg.append("Saving ScriptReplicationDefinition [")
.append(definition.getReplicationName()).append(", ")
.append(definition.getDescription()).append("]");
logger.debug(msg.toString());
}
ReplicationDefinition replicationDefinition = definition.getReplicationDefinition();
replicationService.saveReplicationDefinition(replicationDefinition);
}
public ScriptReplicationDefinition loadReplicationDefinition(String replicationName)
{
ReplicationDefinition replicationDefinition = replicationService.loadReplicationDefinition(replicationName);
return new ScriptReplicationDefinition(serviceRegistry, replicationService, this.getScope(), replicationDefinition);
}
public ScriptReplicationDefinition[] loadReplicationDefinitions()
{
List<ReplicationDefinition> definitions = replicationService.loadReplicationDefinitions();
return toScriptReplicationDefinitions(definitions);
}
public ScriptReplicationDefinition[] loadReplicationDefinitions(String targetName)
{
List<ReplicationDefinition> definitions = replicationService.loadReplicationDefinitions(targetName);
return toScriptReplicationDefinitions(definitions);
}
private ScriptReplicationDefinition[] toScriptReplicationDefinitions(List<ReplicationDefinition> definitions)
{
ScriptReplicationDefinition[] scriptDefs = new ScriptReplicationDefinition[definitions.size()];
for(int i=0; i<scriptDefs.length; i++)
{
ReplicationDefinition def = definitions.get(i);
scriptDefs[i] = new ScriptReplicationDefinition(serviceRegistry, replicationService, this.getScope(), def);
}
return scriptDefs;
}
}