unlimited.fc.server.api

Class FCServerCLIWrapper

java.lang.Object

unlimited.fc.server.api.FCServerCLIWrapper

public class FCServerCLIWrapper
extends java.lang.Object

Title: FileCatalyst Direct Server API

Description: Provides server-side command line to execute remote administrations calls to a FileCatalyst Server

 - - - - - - - - - - - - - - -
 COMMAND LINE USAGE:
 - - - - - - - - - - - - - - -
 
 

 See command-line help for complete usage:
  java -jar FCServerAPI.jar -help
 

 Multiple commands may be stacked left to right in one call.
 

 Usage:
  java -jar FCServerAPI.jar [help commands] [connection directives] [command list]
 

 Help commands:
  -help      --> prints this help to console
  -version   --> prints out the Server API version
  -disableStatusClient --> Forces status client to not run, and disables resynchronizations of config files.  Speeds up ad-hoc user
 add/modify/delete commands.  Commands requiring status client connection (session info) are disabled.
 Resynchronization calls may be executed manually and a command list.
  -timeout --> Specify timeout for command to complete for CLI (return code 3 if timeout event occurs)
 

 Connection directives (if not found, default "localhost:12400" used.
  -host      --> location of the FileCatalyst Direct Server
      [ip or hostname]
      [ip or hostname]:[port]
  -port      --> location of the FileCatalyst Direct Server admin port, or HTTP port if using -lite.
  -user      --> Remote Server admin user
      [username]
      [username/password]
  -passwd    --> Remote Server admin password
  -lite      --> Use the lightweight admin. Requires remote admin and http to be enabled. The port must be the server's HTTP port.
 

 Command list:
   -resynch  --> forces the ServerAPI to resynch configuration files.  Recommended use when disableStatusClient is set.
   -getreqstr
   -getlicstr
   -setlicstr [license string]
   -listusernames
   -listalluserdetails
   -killuser [username]
   -killallusers
   -listsessions
   -killsession [sessionID]
   -overridepriority [sessionID] [newpriority 0-10]
   -overridebandwidthkbps [sessionID] [newbandwidth]
   -resetalloverrides
   -showrates
   -adduser [username] [password]
   -adduserandhome [username] [password] [directory]
   -deluser [username]
   -deluserandhome [username]
   -enableuser [username] [true|false]
   -modpasswd [username] [password]
   -addtmppasswd [username] [password]
   -deltmppasswd [username] [password]
   -moduser [username] [[mod user subcommands]]
     mod user subcommand list:
     -muHomedir [directory]
     -muEnable [true|false]
     -muFullName [fullname]
     -muEmail [email]
     -muFileRead [true|false]
     -muFileWrite [true|false]
     -muFileModify [true|false]
     -muFileDelete [true|false]
     -muFileRename [true|false]
     -muFolderRead [true|false]
     -muFolderWrite [true|false]
     -muFolderModify [true|false]
     -muFolderDelete [true|false]
     -muFolderRename [true|false]
     -muPriority [1..10]
     -muBandwidthLimit [kbps]
     -muHasBandwidthLimit [true|false]
     -muHasQuotaLimit [true|false]
     -muDailyQuotaLimit [bytes]
     -muExpiry [yyyy-MM-dd'T'HH:mm:ssz] --> eg:  2001-07-04T12:08:56PDT
   -listGroups
   -addGroup [groupname] [description] [true|false]
   -enableGroup [groupname]
   -delGroup [groupname]
   -modGroup [groupname] [[mod group subcommands]]
     -mgDescription [description]
     -mgEnabled [true|false]
   -listFolders            --> returns unique folder name list
   -listFoldersWithLabels  --> returns folder name with labels in parenthesis ie:  "storage_123(storage)"
   -addFolder [label] [path] [description]
   -delFolder [name]
   -modFolder [groupname] [[mod folder subcommands]]
     -mfDescription [description]
     -mfLabel [label]
     -mfPath [path]
   -linkUserAndGroup [username] [groupname]");
   -unlinkUserAndGroup [username] [groupname]");
   -linkUserAndFolder [username] [foldername] [READ|READWRITE] --> if no permission, then it is set to No Access.");
   -unlinkUserAndFolder [username] [groupname]");
   -linkGroupAndFolder [groupname] [foldername] [READ|READWRITE] --> if no permission, then it is set to No Access.");");
   -unlinkGroupAndFolder [username] [groupname]");
   -listUsersLinkedToGroup [groupname]
   -listGroupsLinkedToUser [username]
   -getPermissionForFolderAndGroup [groupname] [foldername]

 

 Example 1:  add user "bob" with a password "12345"
   java -jar FCServerAPI.jar -host 10.1.1.1 -port 12400 -user admin -passwd 12345 -adduser bob 12345
 

 Example 2:  modify user "bob"'s home directory and fileread access
   java -jar FCServerAPI.jar -host 10.1.1.1:12400 -user admin/12345 -moduser bob -muHomeDir "C:\My Data\bob" -muFileRead true
 

Note: temporary passwords given to users decays on the FileCatalyst Server after either 10 logins or 30 minutes, whichever happens first. Default values may be changed by modifying fcconf.conf and adding the following values:

 FCServer.server.config.user.tmp.login.expirytime.minutes=30
 FCServer.server.config.user.tmp.login.max.connections=10
 

 

 Copyright: Copyright (c) 2009
 
 

 Company: Unlimi-Tech Software Inc.
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FCServerCLIWrapper.ConnectionData Title: FileCatalyst Direct Server API

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARG_DISABLESTATUSCLIENT
static java.lang.String	ARG_HELP
static java.lang.String	ARG_HOST
static java.lang.String	ARG_LITE
static java.lang.String	ARG_PASSWD
static java.lang.String	ARG_PORT
static java.lang.String	ARG_TIMEOUT
static java.lang.String	ARG_USER
static java.lang.String	ARG_VERSION
static java.lang.String	CMD_ADDFOLDER
static java.lang.String	CMD_ADDGROUP
static java.lang.String	CMD_ADDTMPPASSWD
static java.lang.String	CMD_ADDUSER
static java.lang.String	CMD_ADDUSERANDHOME
static java.lang.String	CMD_DELFOLDER
static java.lang.String	CMD_DELGROUP
static java.lang.String	CMD_DELTMPPASSWD
static java.lang.String	CMD_DELUSER
static java.lang.String	CMD_DELUSERANDHOME
static java.lang.String	CMD_ENABLEFOLDER
static java.lang.String	CMD_ENABLEGROUP
static java.lang.String	CMD_ENABLEUSER
static java.lang.String	CMD_GETFOLDERGROUPPERMISSIONS
static java.lang.String	CMD_GETFOLDERUSERPERMISSIONS
static java.lang.String	CMD_GETLICSTR
static java.lang.String	CMD_GETREQSTR
static java.lang.String	CMD_KILLALL
static java.lang.String	CMD_KILLSESSION
static java.lang.String	CMD_KILLUSER
static java.lang.String	CMD_LINKGROUPANDFOLDER
static java.lang.String	CMD_LINKUSERANDFOLDER
static java.lang.String	CMD_LINKUSERANDGROUP
static java.lang.String	CMD_LISTALLUSERDETAILS
static java.lang.String	CMD_LISTFOLDERS
static java.lang.String	CMD_LISTFOLDERSLINKEDTOGROUP
static java.lang.String	CMD_LISTFOLDERSLINKEDTOUSER
static java.lang.String	CMD_LISTFOLDERSWITHLABELS
static java.lang.String	CMD_LISTGROUPS
static java.lang.String	CMD_LISTGROUPSLINKEDTOFOLDER
static java.lang.String	CMD_LISTGROUPSLINKEDTOUSER
static java.lang.String	CMD_LISTSESSIONS
static java.lang.String	CMD_LISTUSERDETAILS
static java.lang.String	CMD_LISTUSERNAMES
static java.lang.String	CMD_LISTUSERSLINKEDTOFOLDER
static java.lang.String	CMD_LISTUSERSLINKEDTOGROUP
static java.lang.String	CMD_MFDESCRIPTION
static java.lang.String	CMD_MFLABEL
static java.lang.String	CMD_MFPATH
static java.lang.String	CMD_MGDESCRIPTION
static java.lang.String	CMD_MGENABLED
static java.lang.String	CMD_MODFOLDER
static java.lang.String	CMD_MODGROUP
static java.lang.String	CMD_MODPASSWD
static java.lang.String	CMD_MODUSER
static java.lang.String	CMD_MUBANDWIDTH
static java.lang.String	CMD_MUEMAIL
static java.lang.String	CMD_MUENABLE
static java.lang.String	CMD_MUEXPIRY
static java.lang.String	CMD_MUFILEDELETE
static java.lang.String	CMD_MUFILEMODIFY
static java.lang.String	CMD_MUFILEREAD
static java.lang.String	CMD_MUFILERENAME
static java.lang.String	CMD_MUFILEWRITE
static java.lang.String	CMD_MUFOLDERDELETE
static java.lang.String	CMD_MUFOLDERMODIFY
static java.lang.String	CMD_MUFOLDERREAD
static java.lang.String	CMD_MUFOLDERRENAME
static java.lang.String	CMD_MUFOLDERWRITE
static java.lang.String	CMD_MUFULLNAME
static java.lang.String	CMD_MUHASBANDWIDTH
static java.lang.String	CMD_MUHASQUOTA
static java.lang.String	CMD_MUHOME
static java.lang.String	CMD_MUPRIORITY
static java.lang.String	CMD_MUQUOTA
static java.lang.String	CMD_OVERRIDEBANDWIDTHKBPS
static java.lang.String	CMD_OVERRIDEPRIORITY
static java.lang.String	CMD_RESETALLOVERRIDES
static java.lang.String	CMD_RESYNCH
static java.lang.String	CMD_SETLICSTR
static java.lang.String	CMD_SHOWRATES
static java.lang.String	CMD_UNLINKGROUPANDFOLDER
static java.lang.String	CMD_UNLINKUSERANDFOLDER
static java.lang.String	CMD_UNLINKUSERANDGROUP
protected static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor and Description
FCServerCLIWrapper()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) Main method.
protected static FCServerCLIWrapper.ConnectionData	parseAndGetConnectionArguments(java.lang.String[] args) Parse and get the arguments for a connection
protected static void	parseCommands(java.lang.String[] args, FCServerIfc fcserver) CLI parser called by MAIN method to execute commands if not using API.
static void	usage() Spits out usage for command-line tool usage.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static java.util.logging.Logger logger

ARG_LITE

public static final java.lang.String ARG_LITE

See Also:

Constant Field Values

ARG_HELP

public static final java.lang.String ARG_HELP

See Also:

Constant Field Values

ARG_VERSION

public static final java.lang.String ARG_VERSION

See Also:

Constant Field Values

ARG_TIMEOUT

public static final java.lang.String ARG_TIMEOUT

See Also:

Constant Field Values

ARG_HOST

public static final java.lang.String ARG_HOST

See Also:

Constant Field Values

ARG_PORT

public static final java.lang.String ARG_PORT

See Also:

Constant Field Values

ARG_USER

public static final java.lang.String ARG_USER

See Also:

Constant Field Values

ARG_PASSWD

public static final java.lang.String ARG_PASSWD

See Also:

Constant Field Values

ARG_DISABLESTATUSCLIENT

public static final java.lang.String ARG_DISABLESTATUSCLIENT

See Also:

Constant Field Values

CMD_RESYNCH

public static final java.lang.String CMD_RESYNCH

See Also:

Constant Field Values

CMD_GETREQSTR

public static final java.lang.String CMD_GETREQSTR

See Also:

Constant Field Values

CMD_GETLICSTR

public static final java.lang.String CMD_GETLICSTR

See Also:

Constant Field Values

CMD_SETLICSTR

public static final java.lang.String CMD_SETLICSTR

See Also:

Constant Field Values

CMD_LISTUSERNAMES

public static final java.lang.String CMD_LISTUSERNAMES

See Also:

Constant Field Values

CMD_LISTUSERDETAILS

public static final java.lang.String CMD_LISTUSERDETAILS

See Also:

Constant Field Values

CMD_LISTALLUSERDETAILS

public static final java.lang.String CMD_LISTALLUSERDETAILS

See Also:

Constant Field Values

CMD_KILLALL

public static final java.lang.String CMD_KILLALL

See Also:

Constant Field Values

CMD_KILLUSER

public static final java.lang.String CMD_KILLUSER

See Also:

Constant Field Values

CMD_LISTSESSIONS

public static final java.lang.String CMD_LISTSESSIONS

See Also:

Constant Field Values

CMD_KILLSESSION

public static final java.lang.String CMD_KILLSESSION

See Also:

Constant Field Values

CMD_OVERRIDEPRIORITY

public static final java.lang.String CMD_OVERRIDEPRIORITY

See Also:

Constant Field Values

CMD_OVERRIDEBANDWIDTHKBPS

public static final java.lang.String CMD_OVERRIDEBANDWIDTHKBPS

See Also:

Constant Field Values

CMD_RESETALLOVERRIDES

public static final java.lang.String CMD_RESETALLOVERRIDES

See Also:

Constant Field Values

CMD_SHOWRATES

public static final java.lang.String CMD_SHOWRATES

See Also:

Constant Field Values

CMD_ADDUSER

public static final java.lang.String CMD_ADDUSER

See Also:

Constant Field Values

CMD_ADDUSERANDHOME

public static final java.lang.String CMD_ADDUSERANDHOME

See Also:

Constant Field Values

CMD_DELUSER

public static final java.lang.String CMD_DELUSER

See Also:

Constant Field Values

CMD_DELUSERANDHOME

public static final java.lang.String CMD_DELUSERANDHOME

See Also:

Constant Field Values

CMD_ENABLEUSER

public static final java.lang.String CMD_ENABLEUSER

See Also:

Constant Field Values

CMD_MODPASSWD

public static final java.lang.String CMD_MODPASSWD

See Also:

Constant Field Values

CMD_ADDTMPPASSWD

public static final java.lang.String CMD_ADDTMPPASSWD

See Also:

Constant Field Values

CMD_DELTMPPASSWD

public static final java.lang.String CMD_DELTMPPASSWD

See Also:

Constant Field Values

CMD_MODUSER

public static final java.lang.String CMD_MODUSER

See Also:

Constant Field Values

CMD_MUHOME

public static final java.lang.String CMD_MUHOME

See Also:

Constant Field Values

CMD_MUENABLE

public static final java.lang.String CMD_MUENABLE

See Also:

Constant Field Values

CMD_MUFULLNAME

public static final java.lang.String CMD_MUFULLNAME

See Also:

Constant Field Values

CMD_MUEMAIL

public static final java.lang.String CMD_MUEMAIL

See Also:

Constant Field Values

CMD_MUFILEREAD

public static final java.lang.String CMD_MUFILEREAD

See Also:

Constant Field Values

CMD_MUFILEWRITE

public static final java.lang.String CMD_MUFILEWRITE

See Also:

Constant Field Values

CMD_MUFILEMODIFY

public static final java.lang.String CMD_MUFILEMODIFY

See Also:

Constant Field Values

CMD_MUFILEDELETE

public static final java.lang.String CMD_MUFILEDELETE

See Also:

Constant Field Values

CMD_MUFILERENAME

public static final java.lang.String CMD_MUFILERENAME

See Also:

Constant Field Values

CMD_MUFOLDERREAD

public static final java.lang.String CMD_MUFOLDERREAD

See Also:

Constant Field Values

CMD_MUFOLDERWRITE

public static final java.lang.String CMD_MUFOLDERWRITE

See Also:

Constant Field Values

CMD_MUFOLDERMODIFY

public static final java.lang.String CMD_MUFOLDERMODIFY

See Also:

Constant Field Values

CMD_MUFOLDERDELETE

public static final java.lang.String CMD_MUFOLDERDELETE

See Also:

Constant Field Values

CMD_MUFOLDERRENAME

public static final java.lang.String CMD_MUFOLDERRENAME

See Also:

Constant Field Values

CMD_MUPRIORITY

public static final java.lang.String CMD_MUPRIORITY

See Also:

Constant Field Values

CMD_MUBANDWIDTH

public static final java.lang.String CMD_MUBANDWIDTH

See Also:

Constant Field Values

CMD_MUHASBANDWIDTH

public static final java.lang.String CMD_MUHASBANDWIDTH

See Also:

Constant Field Values

CMD_MUHASQUOTA

public static final java.lang.String CMD_MUHASQUOTA

See Also:

Constant Field Values

CMD_MUQUOTA

public static final java.lang.String CMD_MUQUOTA

See Also:

Constant Field Values

CMD_MUEXPIRY

public static final java.lang.String CMD_MUEXPIRY

See Also:

Constant Field Values

CMD_LISTGROUPS

public static final java.lang.String CMD_LISTGROUPS

See Also:

Constant Field Values

CMD_ADDGROUP

public static final java.lang.String CMD_ADDGROUP

See Also:

Constant Field Values

CMD_DELGROUP

public static final java.lang.String CMD_DELGROUP

See Also:

Constant Field Values

CMD_ENABLEGROUP

public static final java.lang.String CMD_ENABLEGROUP

See Also:

Constant Field Values

CMD_MODGROUP

public static final java.lang.String CMD_MODGROUP

See Also:

Constant Field Values

CMD_MGDESCRIPTION

public static final java.lang.String CMD_MGDESCRIPTION

See Also:

Constant Field Values

CMD_MGENABLED

public static final java.lang.String CMD_MGENABLED

See Also:

Constant Field Values

CMD_LINKUSERANDGROUP

public static final java.lang.String CMD_LINKUSERANDGROUP

See Also:

Constant Field Values

CMD_UNLINKUSERANDGROUP

public static final java.lang.String CMD_UNLINKUSERANDGROUP

See Also:

Constant Field Values

CMD_LISTUSERSLINKEDTOGROUP

public static final java.lang.String CMD_LISTUSERSLINKEDTOGROUP

See Also:

Constant Field Values

CMD_LISTGROUPSLINKEDTOUSER

public static final java.lang.String CMD_LISTGROUPSLINKEDTOUSER

See Also:

Constant Field Values

CMD_LISTFOLDERS

public static final java.lang.String CMD_LISTFOLDERS

See Also:

Constant Field Values

CMD_LISTFOLDERSWITHLABELS

public static final java.lang.String CMD_LISTFOLDERSWITHLABELS

See Also:

Constant Field Values

CMD_ADDFOLDER

public static final java.lang.String CMD_ADDFOLDER

See Also:

Constant Field Values

CMD_DELFOLDER

public static final java.lang.String CMD_DELFOLDER

See Also:

Constant Field Values

CMD_ENABLEFOLDER

public static final java.lang.String CMD_ENABLEFOLDER

See Also:

Constant Field Values

CMD_MODFOLDER

public static final java.lang.String CMD_MODFOLDER

See Also:

Constant Field Values

CMD_MFLABEL

public static final java.lang.String CMD_MFLABEL

See Also:

Constant Field Values

CMD_MFPATH

public static final java.lang.String CMD_MFPATH

See Also:

Constant Field Values

CMD_MFDESCRIPTION

public static final java.lang.String CMD_MFDESCRIPTION

See Also:

Constant Field Values

CMD_LINKUSERANDFOLDER

public static final java.lang.String CMD_LINKUSERANDFOLDER

See Also:

Constant Field Values

CMD_UNLINKUSERANDFOLDER

public static final java.lang.String CMD_UNLINKUSERANDFOLDER

See Also:

Constant Field Values

CMD_LISTUSERSLINKEDTOFOLDER

public static final java.lang.String CMD_LISTUSERSLINKEDTOFOLDER

See Also:

Constant Field Values

CMD_LISTFOLDERSLINKEDTOUSER

public static final java.lang.String CMD_LISTFOLDERSLINKEDTOUSER

See Also:

Constant Field Values

CMD_GETFOLDERUSERPERMISSIONS

public static final java.lang.String CMD_GETFOLDERUSERPERMISSIONS

See Also:

Constant Field Values

CMD_LINKGROUPANDFOLDER

public static final java.lang.String CMD_LINKGROUPANDFOLDER

See Also:

Constant Field Values

CMD_UNLINKGROUPANDFOLDER

public static final java.lang.String CMD_UNLINKGROUPANDFOLDER

See Also:

Constant Field Values

CMD_LISTGROUPSLINKEDTOFOLDER

public static final java.lang.String CMD_LISTGROUPSLINKEDTOFOLDER

See Also:

Constant Field Values

CMD_LISTFOLDERSLINKEDTOGROUP

public static final java.lang.String CMD_LISTFOLDERSLINKEDTOGROUP

See Also:

Constant Field Values

CMD_GETFOLDERGROUPPERMISSIONS

public static final java.lang.String CMD_GETFOLDERGROUPPERMISSIONS

See Also:

Constant Field Values

Constructor Detail

FCServerCLIWrapper

public FCServerCLIWrapper()

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Main method. Parses out command line arguments

Parameters:

args - String[]

Throws:

java.lang.Exception

parseCommands

protected static void parseCommands(java.lang.String[] args,
                                    FCServerIfc fcserver)
                             throws java.lang.Exception

CLI parser called by MAIN method to execute commands if not using API. Should only be called by MAIN() methods and unit testers.

Parameters:

args - String[]

Throws:

java.lang.Exception

parseAndGetConnectionArguments

protected static FCServerCLIWrapper.ConnectionData parseAndGetConnectionArguments(java.lang.String[] args)
                                                                           throws java.lang.NumberFormatException

Parse and get the arguments for a connection

Parameters:

args - Arguments to use

Throws:

java.lang.NumberFormatException

usage

public static void usage()

Spits out usage for command-line tool usage. Triggered by including the flag -help || --help || -? || --? via the command-line.