org.apache.sshd.common

Class FactoryManagerUtils

java.lang.Object

org.apache.sshd.common.FactoryManagerUtils

public final class FactoryManagerUtils
extends Object

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
static Boolean	getBoolean(FactoryManager manager, String name)
static Boolean	getBoolean(Map<String,?> props, String name)
static Boolean	getBoolean(Session session, String name)
static boolean	getBooleanProperty(FactoryManager manager, String name, boolean defaultValue)
static boolean	getBooleanProperty(Map<String,?> props, String name, boolean defaultValue)
static boolean	getBooleanProperty(Session session, String name, boolean defaultValue)
static Integer	getInteger(FactoryManager manager, String name)
static Integer	getInteger(Map<String,?> props, String name)
static Integer	getInteger(Session session, String name)
static int	getIntProperty(FactoryManager manager, String name, int defaultValue)
static int	getIntProperty(Map<String,?> props, String name, int defaultValue)
static int	getIntProperty(Session session, String name, int defaultValue)
static Long	getLong(FactoryManager manager, String name)
static Long	getLong(Map<String,?> props, String name)
static Long	getLong(Session session, String name)
static long	getLongProperty(FactoryManager manager, String name, long defaultValue)
static long	getLongProperty(Map<String,?> props, String name, long defaultValue)
static long	getLongProperty(Session session, String name, long defaultValue)
static String	getString(FactoryManager manager, String name)
static String	getString(Map<String,?> props, String name)
static String	getString(Session session, String name)
static String	getStringProperty(FactoryManager manager, String name, String defaultValue)
static String	getStringProperty(Map<String,?> props, String name, String defaultValue)
static String	getStringProperty(Session session, String name, String defaultValue)
static Object	updateProperty(FactoryManager manager, String name, boolean value)
static Object	updateProperty(FactoryManager manager, String name, int value)
static Object	updateProperty(FactoryManager manager, String name, long value)
static Object	updateProperty(FactoryManager manager, String name, Object value)
static Object	updateProperty(Map<String,Object> props, String name, boolean value)
static Object	updateProperty(Map<String,Object> props, String name, int value)
static Object	updateProperty(Map<String,Object> props, String name, long value)
static Object	updateProperty(Map<String,Object> props, String name, Object value)
static Object	updateProperty(Session session, String name, boolean value)
static Object	updateProperty(Session session, String name, int value)
static Object	updateProperty(Session session, String name, long value)
static Object	updateProperty(Session session, String name, Object value)

Methods inherited from class java.lang.Object

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

Method Detail

getLongProperty

public static long getLongProperty(Session session,
                                   String name,
                                   long defaultValue)

Parameters:

session - The Session instance

name - The property name

defaultValue - The default value to return if the specified property does not exist in the properties map

Returns:

The resolved property

Throws:

NumberFormatException - if malformed value

getLongProperty

public static long getLongProperty(FactoryManager manager,
                                   String name,
                                   long defaultValue)

Parameters:

manager - The FactoryManager instance

name - The property name

defaultValue - The default value to return if the specified property does not exist in the properties map

Returns:

The resolved property

Throws:

NumberFormatException - if malformed value

getLongProperty

public static long getLongProperty(Map<String,?> props,
                                   String name,
                                   long defaultValue)

Parameters:

props - The properties Map - ignored if null/empty

name - The property name

defaultValue - The default value to return if the specified property does not exist in the properties map or is an empty string

Returns:

The resolved property

Throws:

NumberFormatException - if malformed value

getLong

public static Long getLong(Session session,
                           String name)

Parameters:

session - The Session instance

name - The property name

Returns:

The Long value or null if property not found or empty string

Throws:

NumberFormatException - if malformed value

getLong

public static Long getLong(FactoryManager manager,
                           String name)

Parameters:

manager - The FactoryManager instance

name - The property name

Returns:

The Long value or null if property not found

Throws:

NumberFormatException - if malformed value

getLong

public static Long getLong(Map<String,?> props,
                           String name)

Parameters:

props - The properties Map - ignored if null/empty

name - The property name

Returns:

The Long value or null if property not found or empty string

Throws:

NumberFormatException - if malformed value

updateProperty

public static Object updateProperty(Session session,
                                    String name,
                                    long value)

updateProperty

public static Object updateProperty(FactoryManager manager,
                                    String name,
                                    long value)

updateProperty

public static Object updateProperty(Map<String,Object> props,
                                    String name,
                                    long value)

getIntProperty

public static int getIntProperty(Session session,
                                 String name,
                                 int defaultValue)

getIntProperty

public static int getIntProperty(FactoryManager manager,
                                 String name,
                                 int defaultValue)

getIntProperty

public static int getIntProperty(Map<String,?> props,
                                 String name,
                                 int defaultValue)

getInteger

public static Integer getInteger(Session session,
                                 String name)

getInteger

public static Integer getInteger(FactoryManager manager,
                                 String name)

getInteger

public static Integer getInteger(Map<String,?> props,
                                 String name)

updateProperty

public static Object updateProperty(Session session,
                                    String name,
                                    int value)

updateProperty

public static Object updateProperty(FactoryManager manager,
                                    String name,
                                    int value)

updateProperty

public static Object updateProperty(Map<String,Object> props,
                                    String name,
                                    int value)

getBooleanProperty

public static boolean getBooleanProperty(Session session,
                                         String name,
                                         boolean defaultValue)

getBooleanProperty

public static boolean getBooleanProperty(FactoryManager manager,
                                         String name,
                                         boolean defaultValue)

getBooleanProperty

public static boolean getBooleanProperty(Map<String,?> props,
                                         String name,
                                         boolean defaultValue)

getBoolean

public static Boolean getBoolean(Session session,
                                 String name)

getBoolean

public static Boolean getBoolean(FactoryManager manager,
                                 String name)

getBoolean

public static Boolean getBoolean(Map<String,?> props,
                                 String name)

updateProperty

public static Object updateProperty(Session session,
                                    String name,
                                    boolean value)

updateProperty

public static Object updateProperty(FactoryManager manager,
                                    String name,
                                    boolean value)

updateProperty

public static Object updateProperty(Map<String,Object> props,
                                    String name,
                                    boolean value)

getString

public static String getString(Session session,
                               String name)

getStringProperty

public static String getStringProperty(Session session,
                                       String name,
                                       String defaultValue)

getString

public static String getString(FactoryManager manager,
                               String name)

getStringProperty

public static String getStringProperty(FactoryManager manager,
                                       String name,
                                       String defaultValue)

getString

public static String getString(Map<String,?> props,
                               String name)

getStringProperty

public static String getStringProperty(Map<String,?> props,
                                       String name,
                                       String defaultValue)

updateProperty

public static Object updateProperty(Session session,
                                    String name,
                                    Object value)

updateProperty

public static Object updateProperty(FactoryManager manager,
                                    String name,
                                    Object value)

updateProperty

public static Object updateProperty(Map<String,Object> props,
                                    String name,
                                    Object value)

Parameters:

props - The Map of properties to update

name - The property name

value - The property value - if null/empty then the specified property is removed from the properties map

Returns:

The removed or previous value (if any)