org.apache.sshd.common

Class SyspropsMapWrapper

java.lang.Object

org.apache.sshd.common.SyspropsMapWrapper

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>

public final class SyspropsMapWrapper
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.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

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and 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 java.lang.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

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SyspropsMapWrapper()

Method Summary

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

Constructor Detail

SyspropsMapWrapper

private SyspropsMapWrapper()

Method Detail

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.Object>

entrySet

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

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.Object>

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.Object>

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

putAll

public void putAll(java.util.Map<? extends java.lang.String,?> m)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.Object>

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.Object>

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.Object>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isMappedSyspropKey

public static boolean isMappedSyspropKey(java.lang.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 java.lang.String getUnmappedSyspropKey(java.lang.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 java.lang.String getMappedSyspropKey(java.lang.Object key)

Parameters:

key - The original key

Returns:

A key prefixed by SYSPROPS_MAPPED_PREFIX

See Also:

isMappedSyspropKey(String)