Package org.apache.sshd.common

Class SyspropsMapWrapper

java.lang.Object

org.apache.sshd.common.SyspropsMapWrapper

All Implemented Interfaces:

Map<String,Object>

public final class SyspropsMapWrapper
extends Object
implements Map<String,Object>

A wrapper that exposes a read-only Map access to the system properties. Any attempt to modify it will throw UnsupportedOperationException. The mapper uses the SYSPROPS_MAPPED_PREFIX to filter and access' only these properties, ignoring all others

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static SyspropsMapWrapper	INSTANCE	The one and only wrapper instance
static PropertyResolver	RAW_PROPS_RESOLVER	Exposes the "raw" system properties as a PropertyResolver without any further filtering
static String	SYSPROPS_MAPPED_PREFIX	Prefix of properties used by the mapper to identify SSHD related settings
static PropertyResolver	SYSPROPS_RESOLVER	A PropertyResolver with no parent that exposes the system properties

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
static String	getMappedSyspropKey(Object key)
static String	getUnmappedSyspropKey(Object key)
boolean	isEmpty()
static boolean	isMappedSyspropKey(String key)
Set<String>	keySet()
Object	put(String key, Object value)
void	putAll(Map<? extends String,?> m)
Object	remove(Object key)
int	size()
String	toString()
Collection<Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

SYSPROPS_MAPPED_PREFIX

public static final String SYSPROPS_MAPPED_PREFIX

Prefix of properties used by the mapper to identify SSHD related settings

See Also:

Constant Field Values

RAW_PROPS_RESOLVER

public static final PropertyResolver RAW_PROPS_RESOLVER

Exposes the "raw" system properties as a PropertyResolver without any further filtering

INSTANCE

public static final SyspropsMapWrapper INSTANCE

The one and only wrapper instance

SYSPROPS_RESOLVER

public static final PropertyResolver SYSPROPS_RESOLVER

A PropertyResolver with no parent that exposes the system properties

Method Detail

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

putAll

public void putAll(Map<? extends String,?> m)

Specified by:

putAll in interface Map<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

size

public int size()

Specified by:

size in interface Map<String,Object>

values

public Collection<Object> values()

Specified by:

values in interface Map<String,Object>

toString

public String toString()

Overrides:

toString in class Object

isMappedSyspropKey

public static boolean isMappedSyspropKey(String key)

Parameters:

key - Key to be tested

Returns:

true if key starts with SYSPROPS_MAPPED_PREFIX and continues with a dot followed by some characters

getUnmappedSyspropKey

public static String getUnmappedSyspropKey(Object key)

Parameters:

key - Key to be transformed

Returns:

The "pure" key name if a mapped one, same as input otherwise

See Also:

isMappedSyspropKey(String)

getMappedSyspropKey

public static String getMappedSyspropKey(Object key)

Parameters:

key - The original key

Returns:

A key prefixed by SYSPROPS_MAPPED_PREFIX

See Also:

isMappedSyspropKey(String)