com.opendxl.streaming.cli

Class CliUtils

java.lang.Object

com.opendxl.streaming.cli.CliUtils

public class CliUtils
extends java.lang.Object

Facilities for command line options

Method Summary

Modifier and Type	Method and Description
static java.util.Properties	configToMap(java.lang.String commaSeparatedConfig) Get properties from comma-separated config String
static java.lang.String	getBaseURL(java.net.URL url) Get url based String based on URL instance
static java.lang.String	getCertificate(java.lang.String certificateParameterValue) Checks whether the certificate parameter value is an existing filename.
static java.util.Map<java.lang.String,java.util.List<?>>	getCommandLine(joptsimple.OptionSet options, java.util.Map<Options,joptsimple.ArgumentAcceptingOptionSpec<java.lang.String>> mandatoryOptions) It gets a list of options used for a specific operation command line
static StickinessCookie	getCookie(Channel channel) Get stickiness cookie from channel
static HttpProxySettings	getHttpProxySettings(java.lang.String httpProxyArgument) Build an HttpProxySettings object from CLI arguments
static void	printUsageAndFinish(joptsimple.OptionParser parser, java.lang.String message) This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec.
static void	printUsageAndFinish(joptsimple.OptionParser parser, java.lang.String message, java.lang.Exception exception) This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec.
static void	printUsageAndFinish(java.lang.String executionResult) Prints usage and exits without system error
static void	setCookie(Channel channel, StickinessCookie stickinessCookie) Set stickiness cookie to channel
static java.util.List<java.lang.String>	topicsToList(java.lang.String commaSeparatedTopics) Get a List of topics from a command-separated topic String
static void	validateMandatoryOperationArgs(CommandLineOperation operationArgument, joptsimple.OptionParser parser, joptsimple.OptionSet options) This method validate the mandatory arguments for a specific operation

Methods inherited from class java.lang.Object

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

Method Detail

printUsageAndFinish

public static void printUsageAndFinish(joptsimple.OptionParser parser,
                                       java.lang.String message)

This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec. Then , it shows the usage and exit with a error

Parameters:

parser - The utility capable to show the usage

message - Message Error

printUsageAndFinish

public static void printUsageAndFinish(joptsimple.OptionParser parser,
                                       java.lang.String message,
                                       java.lang.Exception exception)

This method is invoked when the command line made up by options and argument are ill formed or do not meet options spec. Then , it shows the usage and exit with a error

Parameters:

parser - The utility capable to show the usage

message - Message Error

exception - exception that caused this error

validateMandatoryOperationArgs

public static void validateMandatoryOperationArgs(CommandLineOperation operationArgument,
                                                  joptsimple.OptionParser parser,
                                                  joptsimple.OptionSet options)

This method validate the mandatory arguments for a specific operation

Parameters:

operationArgument - It represents a instance of --operation argument

parser - The utility capable to show the usage

options - Represents the set of options in the command line

printUsageAndFinish

public static void printUsageAndFinish(java.lang.String executionResult)

Prints usage and exits without system error

Parameters:

executionResult - It represents the result of a command line operation

getCommandLine

public static java.util.Map<java.lang.String,java.util.List<?>> getCommandLine(joptsimple.OptionSet options,
                                                                               java.util.Map<Options,joptsimple.ArgumentAcceptingOptionSpec<java.lang.String>> mandatoryOptions)

It gets a list of options used for a specific operation command line

Parameters:

options - Options supported by cli

mandatoryOptions - mandatory options for a specific operation

Returns:

list of options for the command line

getBaseURL

public static java.lang.String getBaseURL(java.net.URL url)

Get url based String based on URL instance

Parameters:

url - instance

Returns:

url based String

configToMap

public static java.util.Properties configToMap(java.lang.String commaSeparatedConfig)

Get properties from comma-separated config String

Parameters:

commaSeparatedConfig - comma-separated config String

Returns:

Properties instance

topicsToList

public static java.util.List<java.lang.String> topicsToList(java.lang.String commaSeparatedTopics)

Get a List of topics from a command-separated topic String

Parameters:

commaSeparatedTopics - a comma-separated topic String

Returns:

a List of topics

getCookie

public static StickinessCookie getCookie(Channel channel)

Get stickiness cookie from channel

Parameters:

channel - Channel instance to get cookie

Returns:

stickiness cookie

setCookie

public static void setCookie(Channel channel,
                             StickinessCookie stickinessCookie)

Set stickiness cookie to channel

Parameters:

channel - Channel instance to set cookie

stickinessCookie - cookie to be injected

getHttpProxySettings

public static HttpProxySettings getHttpProxySettings(java.lang.String httpProxyArgument)

Build an HttpProxySettings object from CLI arguments

Parameters:

httpProxyArgument - string with comma separated values for the Http Proxy attributes being: enabled (true/false), url, port, username, password. Enabled, url and port attributes are mandatory while username and password are optional.

Returns:

an HttpProxySettings object built from httpProxyArgument attributes.

getCertificate

public static java.lang.String getCertificate(java.lang.String certificateParameterValue)

Checks whether the certificate parameter value is an existing filename. If it is, then the certificate parameter value is returned without any change. If it is not, then it is assumed the certificate parameter value is a certificate itself and the "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----" strings will be prepended and appended respectively.

Parameters:

certificateParameterValue - the "--verify-cert-bundle" CLI input parameter value

Returns:

the received string value if such string is an existing filename. the received string with prepended "BEGIN CERTIFICATE" and appended "END CERTIFICATE" strings otherwise.