org.alfresco.jlan.client.demo

Class jlanApp

java.lang.Object

org.alfresco.jlan.client.demo.jlanApp

Direct Known Subclasses:

jlanDir, jlanEventlog, jlanMessage, jlanRegistry, jlanServices, jlanShares, jlanStat, jlanUser, jlanWatch

public abstract class jlanApp
extends Object

JLAN Application Base Class

Author:

gkspencer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CmdLineArg
static String	CmdLineArg1
static String	CmdLineArg2
static String	CmdLineArg3
static String	CmdLineArg4
static String	CmdLineArg5
static String	CmdLineArg6
protected static String	PropertiesFileName
protected static String	PropertyBroadcast
protected static String	PropertyConnectOrder
protected static String	PropertyDebug
protected static String	PropertyDomain
protected static String	PropertyJCEProvider
protected static String	PropertyNameScope
protected static String	PropertyPassword
protected static String	PropertyResolveOrder
protected static String	PropertyUserName
protected static String	PropertyWildcardName
protected static String	PropertyWINS
protected static int	RightAlign
static String	SwitchDomain
static String	SwitchPassword
static String	SwitchUserName

Constructor Summary

Constructors

Constructor and Description
jlanApp(String name, String desc) Class constructor
jlanApp(String name, String desc, boolean switches) Class constructor

Method Summary

Modifier and Type	Method and Description
protected abstract void	doCommand(PrintStream out) Perform the specific command processing
protected void	formatOutput(PrintStream out, String col1, int width1) Format an output string and output to the specified stream
protected void	formatOutput(PrintStream out, String col1, int width1, String col2, int width2) Format an output string and output to the specified stream
protected void	formatOutput(PrintStream out, String col1, int width1, String col2, int width2, String col3, int width3) Format an output string and output to the specified stream
protected void	formatOutput(PrintStream out, String col1, int width1, String col2, int width2, String col3, int width3, String col4, int width4) Format an output string and output to the specified stream
protected void	formatOutput(PrintStream out, String col1, int width1, String col2, int width2, String col3, int width3, String col4, int width4, String col5, int width5) Format an output string and output to the specified stream
String	getCommandDescription() Return the command short description
String	getCommandName() Return the command name
protected String	getDomain() Get a domain name from the command line or properties file
protected String	getPassword() Get a password from the command line or properties file
protected Session	getSession() Return the session
protected PCShare	getShare() Get the share details
protected String	getUserName() Get a user name from the command line or properties file
protected boolean	hasCommandSwitches() Check if the command uses command line switches
protected boolean	hasSession() Check if there is an active session
protected abstract void	outputCommandHelp(PrintStream out) Output the command help
protected int	parseCommandLine(String[] args) Parse the command line
protected String	promptForPassword() Prompt for a password, do not echo to the console
void	runCommand(String[] args) Run the command
protected void	setSession(Session sess) Set the active session
protected void	setShare(PCShare shr) Set the share details
protected abstract boolean	validateCommandLine(NameValueList cmdLine, PrintStream out) Validate the command line parameters

Methods inherited from class java.lang.Object

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

Field Detail

CmdLineArg

public static final String CmdLineArg

See Also:

Constant Field Values

CmdLineArg1

public static final String CmdLineArg1

See Also:

Constant Field Values

CmdLineArg2

public static final String CmdLineArg2

See Also:

Constant Field Values

CmdLineArg3

public static final String CmdLineArg3

See Also:

Constant Field Values

CmdLineArg4

public static final String CmdLineArg4

See Also:

Constant Field Values

CmdLineArg5

public static final String CmdLineArg5

See Also:

Constant Field Values

CmdLineArg6

public static final String CmdLineArg6

See Also:

Constant Field Values

SwitchUserName

public static final String SwitchUserName

See Also:

Constant Field Values

SwitchPassword

public static final String SwitchPassword

See Also:

Constant Field Values

SwitchDomain

public static final String SwitchDomain

See Also:

Constant Field Values

RightAlign

protected static final int RightAlign

See Also:

Constant Field Values

PropertiesFileName

protected static final String PropertiesFileName

See Also:

Constant Field Values

PropertyUserName

protected static final String PropertyUserName

See Also:

Constant Field Values

PropertyPassword

protected static final String PropertyPassword

See Also:

Constant Field Values

PropertyDomain

protected static final String PropertyDomain

See Also:

Constant Field Values

PropertyWINS

protected static final String PropertyWINS

See Also:

Constant Field Values

PropertyBroadcast

protected static final String PropertyBroadcast

See Also:

Constant Field Values

PropertyDebug

protected static final String PropertyDebug

See Also:

Constant Field Values

PropertyResolveOrder

protected static final String PropertyResolveOrder

See Also:

Constant Field Values

PropertyConnectOrder

protected static final String PropertyConnectOrder

See Also:

Constant Field Values

PropertyNameScope

protected static final String PropertyNameScope

See Also:

Constant Field Values

PropertyWildcardName

protected static final String PropertyWildcardName

See Also:

Constant Field Values

PropertyJCEProvider

protected static final String PropertyJCEProvider

See Also:

Constant Field Values

Constructor Detail

jlanApp

public jlanApp(String name,
               String desc)

Class constructor

Parameters:

name - String

desc - String

jlanApp

public jlanApp(String name,
               String desc,
               boolean switches)

Class constructor

Parameters:

name - String

desc - String

switches - boolean

Method Detail

getCommandName

public final String getCommandName()

Return the command name

Returns:

String

getCommandDescription

public final String getCommandDescription()

Return the command short description

Returns:

String

outputCommandHelp

protected abstract void outputCommandHelp(PrintStream out)

Output the command help

Parameters:

out - PrintStream

doCommand

protected abstract void doCommand(PrintStream out)
                           throws Exception

Perform the specific command processing

Parameters:

out - PrintStream

Throws:

Exception

validateCommandLine

protected abstract boolean validateCommandLine(NameValueList cmdLine,
                                               PrintStream out)

Validate the command line parameters

Parameters:

cmdLine - NameValueList

out - PrintStream

Returns:

boolean

getUserName

protected final String getUserName()

Get a user name from the command line or properties file

Returns:

String

getDomain

protected final String getDomain()

Get a domain name from the command line or properties file

Returns:

String

getPassword

protected final String getPassword()

Get a password from the command line or properties file

Returns:

String

parseCommandLine

protected final int parseCommandLine(String[] args)

Parse the command line

Parameters:

args - String[]

Returns:

int

runCommand

public final void runCommand(String[] args)

Run the command

Parameters:

args - String[]

promptForPassword

protected final String promptForPassword()

Prompt for a password, do not echo to the console

Returns:

String

getShare

protected final PCShare getShare()

Get the share details

Returns:

PCShare

hasSession

protected final boolean hasSession()

Check if there is an active session

Returns:

boolean

getSession

protected final Session getSession()

Return the session

Returns:

Session

hasCommandSwitches

protected final boolean hasCommandSwitches()

Check if the command uses command line switches

Returns:

boolean

setShare

protected final void setShare(PCShare shr)

Set the share details

Parameters:

shr - PCShare

setSession

protected final void setSession(Session sess)

Set the active session

Parameters:

sess - Session

formatOutput

protected final void formatOutput(PrintStream out,
                                  String col1,
                                  int width1,
                                  String col2,
                                  int width2,
                                  String col3,
                                  int width3,
                                  String col4,
                                  int width4,
                                  String col5,
                                  int width5)

Format an output string and output to the specified stream

Parameters:

out - PrintStream

col1 - String

width1 - int

col2 - String

width2 - int

col3 - String

width3 - int

col4 - String

width4 - int

col5 - String

width5 - int

formatOutput

protected final void formatOutput(PrintStream out,
                                  String col1,
                                  int width1,
                                  String col2,
                                  int width2,
                                  String col3,
                                  int width3,
                                  String col4,
                                  int width4)

Format an output string and output to the specified stream

Parameters:

out - PrintStream

col1 - String

width1 - int

col2 - String

width2 - int

col3 - String

width3 - int

col4 - String

width4 - int

formatOutput

protected final void formatOutput(PrintStream out,
                                  String col1,
                                  int width1,
                                  String col2,
                                  int width2,
                                  String col3,
                                  int width3)

Format an output string and output to the specified stream

Parameters:

out - PrintStream

col1 - String

width1 - int

col2 - String

width2 - int

col3 - String

width3 - int

formatOutput

protected final void formatOutput(PrintStream out,
                                  String col1,
                                  int width1,
                                  String col2,
                                  int width2)

Format an output string and output to the specified stream

Parameters:

out - PrintStream

col1 - String

width1 - int

col2 - String

width2 - int

formatOutput

protected final void formatOutput(PrintStream out,
                                  String col1,
                                  int width1)

Format an output string and output to the specified stream

Parameters:

out - PrintStream

col1 - String