org.jscsi.target.settings

Class TextParameter

java.lang.Object

org.jscsi.target.settings.TextParameter

public final class TextParameter
extends Object

This is a utility class with static methods useful for dealing with key-value pairs.

Author:

Andreas Ergenzinger

Constructor Summary

Constructors

Constructor and Description
TextParameter()

Method Summary

Methods

Modifier and Type	Method and Description
static String	booleanToTextValue(boolean value) Translates boolean values to either Yes (true) or No (false).
static boolean	checkTextValueFormat(String value) Checks if the value parameter is a properly formatted String value, i.e.
static String	concatenateKeyValuePairs(Collection<String> keyValuePairs) Concatenates the key-value pair elements from the specified Collection to a null-character-separated String that can be sent as a text parameter data segment.
static String	getSuffix(String string, String prefix) Returns the suffix of a specified String.
static String[]	intersect(String[] a, String[] b) Returns an array of Strings containing only those String values present in both input String arrays a and b.
static Boolean	parseBooleanValue(String value) A methods for parsing boolean values from the value part of a key=value pair String.
static String[]	splitKeyValuePair(String keyValuePair) Splits a key=value pair and returns an array with the separated key and value parts.
static String[]	splitValues(String values) Splits a String of (one or more) values at the ',' signs and returns the values in an array of Strings.
static List<String>	tokenizeKeyValuePairs(String keyValuePairs) Returns the key-value pairs contained in a null character-separated text data segment in an array of Strings.
static String	toKeyValuePair(String key, String value) Joins a key and a value String to a key=value pair as required by iSCSI text parameter negotiation and returns the result.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextParameter

public TextParameter()

Method Detail

tokenizeKeyValuePairs

public static List<String> tokenizeKeyValuePairs(String keyValuePairs)

Returns the key-value pairs contained in a null character-separated text data segment in an array of Strings.

If the parameter equals null an empty List will be returned.

Parameters:

keyValuePairs - a login request or text negotiation text data segment

Returns:

a Vector of Strings containing the purged key value pairs

concatenateKeyValuePairs

public static String concatenateKeyValuePairs(Collection<String> keyValuePairs)

Concatenates the key-value pair elements from the specified Collection to a null-character-separated String that can be sent as a text parameter data segment.

Parameters:

keyValuePairs - a Collection of key-value pairs

Returns:

null-character-separated String containing all elements

getSuffix

public static String getSuffix(String string,
               String prefix)

Returns the suffix of a specified String. The length of the suffix is equal to the length of string minus the lenght of prefix, but of course only if the beginning of string does equal prefix. If prefix is not a prefix of string, null is returned.

Parameters:

string - the String whose suffix we want to have returned

prefix - a prefix of string

Returns:

the suffix or null

splitKeyValuePair

public static String[] splitKeyValuePair(String keyValuePair)

Splits a key=value pair and returns an array with the separated key and value parts.

If the parameter does not match this required pattern, then null will be returned.

Parameters:

keyValuePair - a String with a key prefix of length > 0, a '=' in the middle and a value suffix of length > 0

Returns:

array with the separated key and value parts or null.

splitValues

public static String[] splitValues(String values)

Splits a String of (one or more) values at the ',' signs and returns the values in an array of Strings.

Returns null if values parameter is null.

Parameters:

values - a comma-separated String of text parameter values

Returns:

a String array of values or null

intersect

public static String[] intersect(String[] a,
                 String[] b)

Returns an array of Strings containing only those String values present in both input String arrays a and b.

The order of elements in the returned array equals that in array a.

If a or b or one of their elements is null, null is returned.

Parameters:

a - an array of Strings (element order will be preserved)

b - an array of Strings

Returns:

an array of shared Strings or null

parseBooleanValue

public static Boolean parseBooleanValue(String value)

A methods for parsing boolean values from the value part of a key=value pair String. If value equals "Yes", then true will be returned, if value equals "No", then false will be returned. In all other cases the method will return null.

Parameters:

value - a String containing

Returns:

true, false, or null

checkTextValueFormat

public static boolean checkTextValueFormat(String value)

Checks if the value parameter is a properly formatted String value, i.e. if it only contains the allowed characters. The list of legal characters is specified in RFC3720, section 5.1. All characters from that list except for '~' and the null character are considered legitimate.

If those constraints are violated, the method returns null.

Parameters:

value - the value part of a key=value pair, which is a String text parameter

Returns:

the properly formatted value String or null

toKeyValuePair

public static String toKeyValuePair(String key,
                    String value)

Joins a key and a value String to a key=value pair as required by iSCSI text parameter negotiation and returns the result.

Parameters:

key - the key part

value - the value part

Returns:

the concatenated key=value pair

booleanToTextValue

public static String booleanToTextValue(boolean value)

Translates boolean values to either Yes (true) or No (false).

Parameters:

value - the value to translate

Returns:

Yes or No