org.codice.ddf.migration.commands

Class MigrationCommand

java.lang.Object

org.codice.ddf.migration.commands.MigrationCommand

All Implemented Interfaces:

org.apache.karaf.shell.api.action.Action

Direct Known Subclasses:

DecryptCommand, ExportCommand, ImportCommand

public abstract class MigrationCommand
extends Object
implements org.apache.karaf.shell.api.action.Action

Provides common methods and instance variables that migration commands can use.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationMigrationService	configurationMigrationService
static String	ERROR_MESSAGE
protected org.osgi.service.event.EventAdmin	eventAdmin
protected Path	exportDirectory
protected static String	EXPORTED
static String	NAMESPACE
protected Security	security
protected org.apache.karaf.shell.api.console.Session	session
protected String	user

Constructor Summary

Constructors

Constructor and Description
MigrationCommand()

Method Summary

Modifier and Type	Method and Description
Object	execute()
protected abstract Object	executeWithSubject() Executes the command once the user has been properly authorized.
protected PrintStream	getConsole()
protected String	getSubjectName()
protected void	outputErrorMessage(String message)
protected void	outputMessage(MigrationMessage msg)
protected void	postSystemNotice(String cmd)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_MESSAGE

public static final String ERROR_MESSAGE

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

EXPORTED

protected static final String EXPORTED

See Also:

Constant Field Values

security

protected final Security security

configurationMigrationService

protected ConfigurationMigrationService configurationMigrationService

eventAdmin

protected org.osgi.service.event.EventAdmin eventAdmin

session

protected org.apache.karaf.shell.api.console.Session session

user

protected String user

exportDirectory

protected Path exportDirectory

Constructor Detail

MigrationCommand

public MigrationCommand()

Method Detail

execute

public Object execute()
               throws Exception

Specified by:

execute in interface org.apache.karaf.shell.api.action.Action

Throws:

Exception

executeWithSubject

protected abstract Object executeWithSubject()
                                      throws Exception

Executes the command once the user has been properly authorized.

Returns:

result of the command execution

Throws:

Exception - if the command failed to run

outputErrorMessage

protected void outputErrorMessage(String message)

outputMessage

protected void outputMessage(MigrationMessage msg)

getConsole

protected PrintStream getConsole()

getSubjectName

protected String getSubjectName()

postSystemNotice

protected void postSystemNotice(String cmd)