Moving to root below branch label

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
2005-12-08 07:13:07 +00:00
commit e1e6508fec
1095 changed files with 230566 additions and 0 deletions

View File

@@ -0,0 +1,595 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.tools;
import java.io.File;
import java.io.InputStream;
import java.util.Collection;
import org.alfresco.repo.exporter.FileExportPackageHandler;
import org.alfresco.repo.exporter.ACPExportPackageHandler;
import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.view.ExportPackageHandler;
import org.alfresco.service.cmr.view.Exporter;
import org.alfresco.service.cmr.view.ExporterContext;
import org.alfresco.service.cmr.view.ExporterCrawlerParameters;
import org.alfresco.service.cmr.view.ExporterException;
import org.alfresco.service.cmr.view.ExporterService;
import org.alfresco.service.cmr.view.Location;
import org.alfresco.service.namespace.QName;
/**
* Alfresco Repository Export Tool
*
* @author David Caruana
*/
public final class Export extends Tool
{
/** Export Context */
private ExportContext context;
/**
* Entry Point
*
* @param args
*/
public static void main(String[] args)
{
Tool tool = new Export();
tool.start(args);
}
/* (non-Javadoc)
* @see org.alfresco.tools.Tool#getToolName()
*/
@Override
String getToolName()
{
return "Alfresco Repository Exporter";
}
/**
* Process Export Tool command line arguments
*
* @param args the arguments
* @return the export context
*/
@Override
/*package*/ ToolContext processArgs(String[] args)
{
context = new ExportContext();
context.setLogin(true);
int i = 0;
while (i < args.length)
{
if (args[i].equals("-h") || args[i].equals("-help"))
{
context.setHelp(true);
break;
}
else if (args[i].equals("-s") || args[i].equals("-store"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <store> for the parameter -store must be specified");
}
context.storeRef = new StoreRef(args[i]);
}
else if (args[i].equals("-p") || args[i].equals("-path"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <path> for the parameter -path must be specified");
}
context.path = args[i];
}
else if (args[i].equals("-d") || args[i].equals("-dir"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <dir> for the parameter -dir must be specified");
}
context.destDir = args[i];
}
else if (args[i].equals("-packagedir"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <packagedir> for the parameter -packagedir must be specified");
}
context.packageDir = args[i];
}
else if (args[i].equals("-user"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <user> for the option -user must be specified");
}
context.setUsername(args[i]);
}
else if (args[i].equals("-pwd"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <password> for the option -pwd must be specified");
}
context.setPassword(args[i]);
}
else if (args[i].equals("-root"))
{
context.self = true;
}
else if (args[i].equals("-nochildren"))
{
context.children = false;
}
else if (args[i].equals("-zip"))
{
context.zipped = true;
}
else if (args[i].equals("-overwrite"))
{
context.overwrite = true;
}
else if (args[i].equals("-quiet"))
{
context.setQuiet(true);
}
else if (args[i].equals("-verbose"))
{
context.setVerbose(true);
}
else if (i == (args.length - 1))
{
context.packageName = args[i];
}
else
{
throw new ToolException("Unknown option " + args[i]);
}
// next argument
i++;
}
return context;
}
/* (non-Javadoc)
* @see org.alfresco.tools.Tool#displayHelp()
*/
@Override
/*package*/ void displayHelp()
{
System.out.println("Usage: export -user username -s[tore] store [options] packagename");
System.out.println("");
System.out.println("username: username for login");
System.out.println("store: the store to extract from in the form of scheme://store_name");
System.out.println("packagename: the filename to export to (with or without extension)");
System.out.println("");
System.out.println("Options:");
System.out.println(" -h[elp] display this help");
System.out.println(" -p[ath] the path within the store to extract from (default: /)");
System.out.println(" -d[ir] the destination directory to export to (default: current directory)");
System.out.println(" -pwd password for login");
System.out.println(" -packagedir the directory to place extracted content (default: dir/<packagename>)");
System.out.println(" -root extract the item located at export path");
System.out.println(" -nochildren do not extract children of the item at export path");
System.out.println(" -overwrite force overwrite of existing export package if it already exists");
System.out.println(" -quiet do not display any messages during export");
System.out.println(" -verbose report export progress");
System.out.println(" -zip export in zip format");
}
/* (non-Javadoc)
* @see org.alfresco.tools.Tool#execute()
*/
@Override
void execute() throws ToolException
{
ExporterService exporter = getServiceRegistry().getExporterService();
// create export package handler
ExportPackageHandler exportHandler = null;
if (context.zipped)
{
exportHandler = new ZipHandler(context.getDestDir(), context.getZipFile(), context.getPackageFile(), context.getPackageDir(), context.overwrite);
}
else
{
exportHandler = new FileHandler(context.getDestDir(), context.getPackageFile(), context.getPackageDir(), context.overwrite);
}
// export Repository content to export package
ExporterCrawlerParameters parameters = new ExporterCrawlerParameters();
parameters.setExportFrom(context.getLocation());
parameters.setCrawlSelf(context.self);
parameters.setCrawlChildNodes(context.children);
try
{
exporter.exportView(exportHandler, parameters, new ExportProgress());
}
catch(ExporterException e)
{
throw new ToolException("Failed to export", e);
}
}
/**
* Handler for exporting Repository content streams to file system files
*
* @author David Caruana
*/
private class FileHandler extends FileExportPackageHandler
{
/**
* Construct
*
* @param destDir
* @param dataFile
* @param contentDir
* @param overwrite
*/
public FileHandler(File destDir, File dataFile, File contentDir, boolean overwrite)
{
super(destDir, dataFile, contentDir, overwrite);
}
/**
* Log Export Message
*
* @param message message to log
*/
protected void log(String message)
{
Export.this.log(message);
}
}
/**
* Handler for exporting Repository content streams to zip file
*
* @author David Caruana
*/
private class ZipHandler extends ACPExportPackageHandler
{
/**
* Construct
*
* @param destDir
* @param zipFile
* @param dataFile
* @param contentDir
*/
public ZipHandler(File destDir, File zipFile, File dataFile, File contentDir, boolean overwrite)
{
super(destDir, zipFile, dataFile, contentDir, overwrite);
}
/**
* Log Export Message
*
* @param message message to log
*/
protected void log(String message)
{
Export.this.log(message);
}
}
/**
* Export Tool Context
*
* @author David Caruana
*/
private class ExportContext extends ToolContext
{
/** Store Reference to export from */
private StoreRef storeRef;
/** Path to export from */
private String path;
/** Destination directory to export to */
private String destDir;
/** The package directory within the destination directory to export to */
private String packageDir;
/** The package name to export to */
private String packageName;
/** Export children */
private boolean children = true;
/** Export self */
private boolean self = false;
/** Force overwrite of existing package */
private boolean overwrite = false;
/** Zipped? */
private boolean zipped = false;
/* (non-Javadoc)
* @see org.alfresco.tools.ToolContext#validate()
*/
@Override
/*package*/ void validate()
{
super.validate();
if (storeRef == null)
{
throw new ToolException("Store to export from has not been specified.");
}
if (packageName == null)
{
throw new ToolException("Package name has not been specified.");
}
if (destDir != null)
{
File fileDestDir = new File(destDir);
if (fileDestDir.exists() == false)
{
throw new ToolException("Destination directory " + fileDestDir.getAbsolutePath() + " does not exist.");
}
}
}
/**
* Get the location within the Repository to export from
*
* @return the location
*/
private Location getLocation()
{
Location location = new Location(storeRef);
location.setPath(path);
return location;
}
/**
* Get the destination directory
*
* @return the destination directory (or null if current directory)
*/
private File getDestDir()
{
File dir = (destDir == null) ? null : new File(destDir);
return dir;
}
/**
* Get the package directory
*
* @return the package directory within the destination directory
*/
private File getPackageDir()
{
File dir = null;
if (packageDir != null)
{
dir = new File(packageDir);
}
else if (packageName.indexOf('.') != -1)
{
dir = new File(packageName.substring(0, packageName.indexOf('.')));
}
else
{
dir = new File(packageName);
}
return dir;
}
/**
* Get the xml export file
*
* @return the package file
*/
private File getPackageFile()
{
String packageFile = (packageName.indexOf('.') != -1) ? packageName : packageName + ".xml";
File file = new File(packageFile);
return file;
}
/**
* Get the zip file
*
* @return the zip file
*/
private File getZipFile()
{
int iExt = packageName.indexOf('.');
String zipFile = ((iExt != -1) ? packageName.substring(0, iExt) : packageName) + ".acp";
return new File(zipFile);
}
}
/**
* Report Export Progress
*
* @author David Caruana
*/
private class ExportProgress
implements Exporter
{
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#start()
*/
public void start(ExporterContext exportNodeRef)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#startNamespace(java.lang.String, java.lang.String)
*/
public void startNamespace(String prefix, String uri)
{
logVerbose("Exporting namespace " + uri + " (prefix: " + prefix + ")");
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#endNamespace(java.lang.String)
*/
public void endNamespace(String prefix)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#startNode(org.alfresco.service.cmr.repository.NodeRef)
*/
public void startNode(NodeRef nodeRef)
{
logVerbose("Exporting node " + nodeRef.toString());
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#endNode(org.alfresco.service.cmr.repository.NodeRef)
*/
public void endNode(NodeRef nodeRef)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#startAspects(org.alfresco.service.cmr.repository.NodeRef)
*/
public void startAspects(NodeRef nodeRef)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#endAspects(org.alfresco.service.cmr.repository.NodeRef)
*/
public void endAspects(NodeRef nodeRef)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#startAspect(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)
*/
public void startAspect(NodeRef nodeRef, QName aspect)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#endAspect(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)
*/
public void endAspect(NodeRef nodeRef, QName aspect)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#startProperties(org.alfresco.service.cmr.repository.NodeRef)
*/
public void startProperties(NodeRef nodeRef)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#endProperties(org.alfresco.service.cmr.repository.NodeRef)
*/
public void endProperties(NodeRef nodeRef)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#startProperty(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)
*/
public void startProperty(NodeRef nodeRef, QName property)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#endProperty(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)
*/
public void endProperty(NodeRef nodeRef, QName property)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#value(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.io.Serializable)
*/
public void value(NodeRef nodeRef, QName property, Object value)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#value(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.util.Collection)
*/
public void value(NodeRef nodeRef, QName property, Collection values)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#content(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.io.InputStream)
*/
public void content(NodeRef nodeRef, QName property, InputStream content, ContentData contentData)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#startAssoc(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)
*/
public void startAssoc(NodeRef nodeRef, QName assoc)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#endAssoc(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)
*/
public void endAssoc(NodeRef nodeRef, QName assoc)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#startAssocs(org.alfresco.service.cmr.repository.NodeRef)
*/
public void startAssocs(NodeRef nodeRef)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#endAssocs(org.alfresco.service.cmr.repository.NodeRef)
*/
public void endAssocs(NodeRef nodeRef)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#warning(java.lang.String)
*/
public void warning(String warning)
{
log("Warning: " + warning);
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.Exporter#end()
*/
public void end()
{
}
}
}

View File

@@ -0,0 +1,419 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.tools;
import java.io.File;
import java.io.Serializable;
import java.nio.charset.Charset;
import org.alfresco.repo.importer.ACPImportPackageHandler;
import org.alfresco.repo.importer.FileImportPackageHandler;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.view.ImportPackageHandler;
import org.alfresco.service.cmr.view.ImporterException;
import org.alfresco.service.cmr.view.ImporterProgress;
import org.alfresco.service.cmr.view.ImporterService;
import org.alfresco.service.cmr.view.Location;
import org.alfresco.service.namespace.QName;
/**
* Import Tool.
*
* @author David Caruana
*/
public class Import extends Tool
{
/** Import Tool Context */
private ImportContext context;
/**
* Entry Point
*
* @param args
*/
public static void main(String[] args)
{
Tool tool = new Import();
tool.start(args);
}
/* (non-Javadoc)
* @see org.alfresco.tools.Tool#processArgs(java.lang.String[])
*/
@Override
/*package*/ ToolContext processArgs(String[] args)
{
context = new ImportContext();
context.setLogin(true);
int i = 0;
while (i < args.length)
{
if (args[i].equals("-h") || args[i].equals("-help"))
{
context.setHelp(true);
break;
}
else if (args[i].equals("-s") || args[i].equals("-store"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <store> for the option -store must be specified");
}
context.storeRef = new StoreRef(args[i]);
}
else if (args[i].equals("-p") || args[i].equals("-path"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <path> for the option -path must be specified");
}
context.path = args[i];
}
else if (args[i].equals("-d") || args[i].equals("-dir"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <dir> for the option -dir must be specified");
}
context.sourceDir = args[i];
}
else if (args[i].equals("-user"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <user> for the option -user must be specified");
}
context.setUsername(args[i]);
}
else if (args[i].equals("-pwd"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <password> for the option -pwd must be specified");
}
context.setPassword(args[i]);
}
else if (args[i].equals("-encoding"))
{
i++;
if (i == args.length || args[i].length() == 0)
{
throw new ToolException("The value <encoding> for the option -encoding must be specified");
}
context.encoding = args[i];
}
else if (args[i].equals("-quiet"))
{
context.setQuiet(true);
}
else if (args[i].equals("-verbose"))
{
context.setVerbose(true);
}
else if (i == (args.length - 1))
{
context.packageName = args[i];
}
else
{
throw new ToolException("Unknown option " + args[i]);
}
// next argument
i++;
}
return context;
}
/* (non-Javadoc)
* @see org.alfresco.tools.Tool#displayHelp()
*/
@Override
/*package*/ void displayHelp()
{
System.out.println("Usage: import -user username -s[tore] store [options] packagename");
System.out.println("");
System.out.println("username: username for login");
System.out.println("store: the store to import into the form of scheme://store_name");
System.out.println("packagename: the filename to import from (with or without extension)");
System.out.println("");
System.out.println("Options:");
System.out.println(" -h[elp] display this help");
System.out.println(" -p[ath] the path within the store to extract into (default: /)");
System.out.println(" -d[ir] the source directory to import from (default: current directory)");
System.out.println(" -pwd password for login");
System.out.println(" -encoding package file encoding (default: " + Charset.defaultCharset() + ")");
System.out.println(" -quiet do not display any messages during import");
System.out.println(" -verbose report import progress");
}
/* (non-Javadoc)
* @see org.alfresco.tools.Tool#getToolName()
*/
@Override
/*package*/ String getToolName()
{
return "Alfresco Repository Importer";
}
/* (non-Javadoc)
* @see org.alfresco.tools.Tool#execute()
*/
@Override
/*package*/ void execute() throws ToolException
{
ImporterService importer = getServiceRegistry().getImporterService();
// determine type of import (from zip or file system)
ImportPackageHandler importHandler;
if (context.zipFile)
{
importHandler = new ZipHandler(context.getSourceDir(), context.getPackageFile(), context.encoding);
}
else
{
importHandler = new FileHandler(context.getSourceDir(), context.getPackageFile(), context.encoding);
}
try
{
importer.importView(importHandler, context.getLocation(), null, new ImportProgress());
}
catch(ImporterException e)
{
throw new ToolException("Failed to import package due to " + e.getMessage(), e);
}
}
/**
* Handler for importing Repository content from zip package
*
* @author David Caruana
*/
private class ZipHandler extends ACPImportPackageHandler
{
/**
* Construct
*
* @param sourceDir
* @param dataFile
* @param dataFileEncoding
*/
public ZipHandler(File sourceDir, File dataFile, String dataFileEncoding)
{
super(new File(sourceDir, dataFile.getPath()), dataFileEncoding);
}
/**
* Log Export Message
*
* @param message message to log
*/
protected void log(String message)
{
Import.this.log(message);
}
}
/**
* Handler for importing Repository content from file system files
*
* @author David Caruana
*/
private class FileHandler extends FileImportPackageHandler
{
/**
* Construct
*
* @param sourceDir
* @param dataFile
* @param dataFileEncoding
*/
public FileHandler(File sourceDir, File dataFile, String dataFileEncoding)
{
super(sourceDir, dataFile, dataFileEncoding);
}
/**
* Log Export Message
*
* @param message message to log
*/
protected void log(String message)
{
Import.this.log(message);
}
}
/**
* Report Import Progress
*
* @author David Caruana
*/
private class ImportProgress
implements ImporterProgress
{
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.ImporterProgress#nodeCreated(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, org.alfresco.service.namespace.QName)
*/
public void nodeCreated(NodeRef nodeRef, NodeRef parentRef, QName assocName, QName childName)
{
logVerbose("Imported node " + nodeRef + " (parent=" + parentRef + ", childname=" + childName + ", association=" + assocName + ")");
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.ImporterProgress#contentCreated(org.alfresco.service.cmr.repository.NodeRef, java.lang.String)
*/
public void contentCreated(NodeRef nodeRef, String sourceUrl)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.ImporterProgress#propertySet(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.io.Serializable)
*/
public void propertySet(NodeRef nodeRef, QName property, Serializable value)
{
}
/* (non-Javadoc)
* @see org.alfresco.service.cmr.view.ImporterProgress#aspectAdded(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)
*/
public void aspectAdded(NodeRef nodeRef, QName aspect)
{
}
}
/**
* Import Tool Context
*
* @author David Caruana
*/
private class ImportContext extends ToolContext
{
/** Store Reference to import into */
private StoreRef storeRef;
/** Path to import into */
private String path;
/** Source directory to import from */
private String sourceDir;
/** The package name to import */
private String packageName;
/** The package encoding */
private String encoding = null;
/** Zip Package? */
private boolean zipFile = false;
/* (non-Javadoc)
* @see org.alfresco.tools.ToolContext#validate()
*/
@Override
/*package*/ void validate()
{
super.validate();
if (storeRef == null)
{
throw new ToolException("Store to import into has not been specified.");
}
if (packageName == null)
{
throw new ToolException("Package name has not been specified.");
}
if (sourceDir != null)
{
File fileSourceDir = getSourceDir();
if (fileSourceDir.exists() == false)
{
throw new ToolException("Source directory " + fileSourceDir.getAbsolutePath() + " does not exist.");
}
}
if (packageName.endsWith(".acp"))
{
File packageFile = new File(getSourceDir(), packageName);
if (!packageFile.exists())
{
throw new ToolException("Package zip file " + packageFile.getAbsolutePath() + " does not exist.");
}
zipFile = true;
}
else
{
File packageFile = new File(getSourceDir(), getDataFile().getPath());
if (!packageFile.exists())
{
throw new ToolException("Package file " + packageFile.getAbsolutePath() + " does not exist.");
}
}
}
/**
* Get the location within the Repository to import into
*
* @return the location
*/
private Location getLocation()
{
Location location = new Location(storeRef);
location.setPath(path);
return location;
}
/**
* Get the source directory
*
* @return the source directory (or null if current directory)
*/
private File getSourceDir()
{
File dir = (sourceDir == null) ? null : new File(sourceDir);
return dir;
}
/**
* Get the xml import file
*
* @return the package file
*/
private File getDataFile()
{
String dataFile = (packageName.indexOf('.') != -1) ? packageName : packageName + ".xml";
File file = new File(dataFile);
return file;
}
/**
* Get the zip import file (.acp - alfresco content package)
*
* @return the zip package file
*/
private File getPackageFile()
{
return (zipFile) ? new File(packageName) : getDataFile();
}
}
}

View File

@@ -0,0 +1,209 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.tools;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.security.AuthenticationService;
import org.alfresco.util.ApplicationContextHelper;
import org.springframework.context.ApplicationContext;
/**
* Abstract Tool Implementation
*
* @author David Caruana
*/
public abstract class Tool
{
/** Tool Context */
private ToolContext toolContext;
/** Spring Application Context */
private ApplicationContext appContext;
/** Repository Service Registry */
private ServiceRegistry serviceRegistry;
/**
* Process Tool Arguments
*
* @param args the arguments
* @return the tool context
* @throws ToolException
*/
/*package*/ ToolContext processArgs(String[] args)
throws ToolException
{
return new ToolContext();
}
/**
* Display Tool Help
*/
/*package*/ void displayHelp()
{
System.out.println("Sorry. Help is not available.");
}
/**
* Perform Tool Behaviour
*
* @throws ToolException
*/
/*package*/ abstract void execute()
throws ToolException;
/**
* Get the tool name
*
* @return the tool name
*/
/*package*/ abstract String getToolName();
/**
* Get the Application Context
*
* @return the application context
*/
/*package*/ final ApplicationContext getApplicationContext()
{
return appContext;
}
/**
* Get the Repository Service Registry
*
* @return the service registry
*/
/*package*/ final ServiceRegistry getServiceRegistry()
{
return serviceRegistry;
}
/**
* Log message
*
* @param msg message to log
*/
/*package*/ final void log(String msg)
{
if (toolContext.isQuiet() == false)
{
System.out.println(msg);
}
}
/**
* Log Verbose message
*
* @param msg message to log
*/
/*package*/ final void logVerbose(String msg)
{
if (toolContext.isVerbose())
{
log(msg);
}
}
/**
* Tool entry point
*
* @param args the tool arguments
*/
/*package*/ final void start(String[] args)
{
try
{
// Process tool arguments
toolContext = processArgs(args);
toolContext.validate();
try
{
if (toolContext.isHelp())
{
// Display help, if requested
displayHelp();
}
else
{
// Perform Tool behaviour
log(getToolName());
initialiseRepository();
login();
execute();
log(getToolName() + " successfully completed.");
}
System.exit(0);
}
catch (ToolException e)
{
displayError(e);
System.exit(-1);
}
}
catch(ToolException e)
{
System.out.println(e.getMessage());
System.out.println();
displayHelp();
System.exit(-1);
}
catch (Throwable e)
{
System.out.println("The following error has occurred:");
System.out.println(e.getMessage());
e.printStackTrace();
System.exit(-1);
}
}
/**
* Login to Repository
*/
private void login()
{
// TODO: Replace with call to ServiceRegistry
AuthenticationService auth = (AuthenticationService)appContext.getBean("authenticationService");
auth.authenticate(toolContext.getUsername(), toolContext.getPassword().toCharArray());
log("Connected as " + toolContext.getUsername());
}
/**
* Initialise the Repository
*/
private void initialiseRepository()
{
appContext = ApplicationContextHelper.getApplicationContext();
serviceRegistry = (ServiceRegistry) appContext.getBean(ServiceRegistry.SERVICE_REGISTRY);
}
/**
* Display Error Message
*
* @param e exception
*/
private void displayError(Throwable e)
{
System.out.println(e.getMessage());
if (toolContext != null && toolContext.isVerbose())
{
e.printStackTrace();
}
}
}

View File

@@ -0,0 +1,176 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.tools;
/**
* Tool Context
*
* @author David Caruana
*/
/*package*/ class ToolContext
{
/** Help required? */
private boolean help = false;
/** Login required? */
private boolean login = false;
/** Username */
private String username = null;
/** Password */
private String password = "";
/** Log messages whilst importing? */
private boolean quiet = false;
/** Verbose logging */
private boolean verbose = false;
/**
* Is help required?
*
* @return true => help is required
*/
/*package*/ final boolean isHelp()
{
return help;
}
/**
* Sets whether help is required
*
* @param help
*/
/*package*/ final void setHelp(boolean help)
{
this.help = help;
}
/**
* Is login required?
*
* @return true => login is required
*/
/*package*/ final boolean isLogin()
{
return login;
}
/**
* Sets whether login is required
*
* @param login
*/
/*package*/ final void setLogin(boolean login)
{
this.login = login;
}
/**
* Get the password
*
* @return the password
*/
/*package*/ final String getPassword()
{
return password;
}
/**
* Set the password
*
* @param password
*/
/*package*/ final void setPassword(String password)
{
this.password = password;
}
/**
* Is output is required?
*
* @return true => output is required
*/
/*package*/ final boolean isQuiet()
{
return quiet;
}
/**
* Sets whether output is required
*
* @param quiet
*/
/*package*/ final void setQuiet(boolean quiet)
{
this.quiet = quiet;
}
/**
* Get the username
*
* @return the username
*/
/*package*/ final String getUsername()
{
return username;
}
/**
* Set the username
*
* @param username
*/
/*package*/ final void setUsername(String username)
{
this.username = username;
}
/**
* Is verbose logging required?
*
* @return true => verbose logging is required
*/
/*package*/ final boolean isVerbose()
{
return verbose;
}
/**
* Sets whether verbose logging is required
*
* @param verbose
*/
/*package*/ final void setVerbose(boolean verbose)
{
this.verbose = verbose;
}
/**
* Validate Tool Context
*/
/*package*/ void validate()
throws ToolException
{
if (login)
{
if (username == null || username.length() == 0)
{
throw new ToolException("Username for login has not been specified.");
}
}
}
}

View File

@@ -0,0 +1,38 @@
/*
* Copyright (C) 2005 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the
* License.
*/
package org.alfresco.tools;
/**
* Tool Exception
*
* @author David Caruana
*/
/*package*/ class ToolException extends RuntimeException
{
private static final long serialVersionUID = 3257008761007847733L;
/*package*/ ToolException(String msg)
{
super(msg);
}
/*package*/ ToolException(String msg, Throwable cause)
{
super(msg, cause);
}
}