Class SSM

java.lang.Object

org.jpos.q2.cli.SSM

All Implemented Interfaces:

CLICommand, CLISubSystem

public class SSM
extends Object
implements CLISubSystem, CLICommand

CLI implementation - SSM subsystem

Constructor Summary

Constructors

Constructor	Description
SSM()	Default constructor; no instance state to initialise.

Method Summary

Modifier and Type	Method	Description
void	exec(CLIContext cli, String[] strings)	Executes the CLI command.
String[]	getCompletionPrefixes(CLIContext ctx, String[] args)	Returns the command prefixes registered by this sub-system.
String	getPrompt(CLIContext ctx, String[] args)	Returns the prompt string for this sub-system.
static JCESecurityModule	getSecurityModule(CLIContext cliContext)	Returns the JCESecurityModule stashed in the SSM-subsystem storage.
static void	setSecurityModule(CLIContext cliContext, JCESecurityModule securityModule)	Stashes a JCESecurityModule in the SSM-subsystem storage so other SSM commands can resolve it.

Methods inherited from class Object

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

Constructor Details

SSM

public SSM()

Default constructor; no instance state to initialise.

Method Details

getPrompt

public String getPrompt(CLIContext ctx,
 String[] args)

Description copied from interface: CLISubSystem

Returns the prompt string for this sub-system.

Specified by:

getPrompt in interface CLISubSystem

Parameters:

ctx - the CLI context

args - current command arguments

Returns:

the prompt string

getCompletionPrefixes

public String[] getCompletionPrefixes(CLIContext ctx,
 String[] args)

Description copied from interface: CLISubSystem

Returns the command prefixes registered by this sub-system.

Specified by:

getCompletionPrefixes in interface CLISubSystem

Parameters:

ctx - the CLI context

args - current command arguments

Returns:

command prefixes

exec

public void exec(CLIContext cli,
 String[] strings)
          throws Exception

Description copied from interface: CLICommand

Executes the CLI command.

Specified by:

exec in interface CLICommand

Parameters:

cli - the CLI context

strings - command arguments

Throws:

Exception - on error

getSecurityModule

public static JCESecurityModule getSecurityModule(CLIContext cliContext)

Returns the JCESecurityModule stashed in the SSM-subsystem storage.

Parameters:

cliContext - CLI context

Returns:

the active security module, or null if none has been set

setSecurityModule

public static void setSecurityModule(CLIContext cliContext,
 JCESecurityModule securityModule)

Stashes a JCESecurityModule in the SSM-subsystem storage so other SSM commands can resolve it.

Parameters:

cliContext - CLI context

securityModule - security module to store