Package org.alfresco.tools

Class RenameUser

java.lang.Object

org.alfresco.tools.Tool

org.alfresco.tools.RenameUser

public class RenameUser
extends Tool

Rename user tool. This tool provides minimal support for renaming users. See displayHelp() message for restrictions.

 Usage: renameUser -user username [options] oldUsername newUsername");
        renameUser -user username [options] -file filename");
 

The csv file has a simple comma separated list, with a pair of usernames on each line. Comments and blank lines may also be included. For example:

 # List of usernames to change
 
 # oldUsername,newUsername
 johnp,ceo # President and CEO
 johnn,cto # CTO and Chairman
 

Author:

Alan Davis

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RenameUser.RenameUserToolContext
class	RenameUser.User

Field Summary

Fields

Modifier and Type	Field	Description
protected RenameUser.RenameUserToolContext	context	User Rename Tool Context

Constructor Summary

Constructors

Constructor	Description
RenameUser()

Method Summary

Modifier and Type	Method	Description
protected void	displayHelp()	Display Tool Help
protected int	execute()	Perform Tool Behaviour
protected String	getToolName()	Get the tool name
static void	main(String[] args)	Entry Point
protected org.alfresco.tools.ToolContext	processArgs(String[] args)	Process Tool Arguments
void	setLogin(boolean login)

Methods inherited from class org.alfresco.tools.Tool

exit, getApplicationContext, getServiceRegistry, handleError, logError, logInfo, logVerbose, start

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

context

protected RenameUser.RenameUserToolContext context

User Rename Tool Context

Constructor Details

RenameUser

public RenameUser()

Method Details

setLogin

public void setLogin(boolean login)

main

public static void main(String[] args)

Entry Point

Parameters:

args -

processArgs

protected org.alfresco.tools.ToolContext processArgs(String[] args)
                                              throws org.alfresco.tools.ToolArgumentException

Description copied from class: Tool

Process Tool Arguments

Overrides:

processArgs in class Tool

Parameters:

args - the arguments

Returns:

the tool context

Throws:

org.alfresco.tools.ToolArgumentException

displayHelp

protected void displayHelp()

Description copied from class: Tool

Display Tool Help

Overrides:

displayHelp in class Tool

getToolName

protected String getToolName()

Description copied from class: Tool

Get the tool name

Specified by:

getToolName in class Tool

Returns:

the tool name

execute

protected int execute()
               throws ToolException

Description copied from class: Tool

Perform Tool Behaviour

Specified by:

execute in class Tool

Throws:

ToolException