org.apache.sshd.common.util.security

Class AbstractSecurityProviderRegistrar

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.security.AbstractSecurityProviderRegistrar

All Implemented Interfaces:

NamedResource, OptionalFeature, PropertyResolver, SecurityProviderChoice, SecurityProviderRegistrar

Direct Known Subclasses:

BouncyCastleSecurityProviderRegistrar, EdDSASecurityProviderRegistrar

public abstract class AbstractSecurityProviderRegistrar
extends AbstractLoggingBean
implements SecurityProviderRegistrar

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name
protected java.util.Map<java.lang.String,java.lang.Object>	props
protected java.util.concurrent.atomic.AtomicReference<java.security.Provider>	providerHolder
protected java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.String,java.lang.Boolean>>	supportedEntities

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.util.security.SecurityProviderRegistrar

ALL_OPTIONS_VALUE, ALL_OPTIONS_WILDCARD, CONFIG_PROP_BASE, ENABLED_PROPERTY, NAMED_PROVIDER_PROPERTY, NO_OPTIONS_VALUE, SECURITY_ENTITIES

Fields inherited from interface org.apache.sshd.common.util.security.SecurityProviderChoice

EMPTY

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Fields inherited from interface org.apache.sshd.common.OptionalFeature

FALSE, TRUE

Fields inherited from interface org.apache.sshd.common.PropertyResolver

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSecurityProviderRegistrar(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected java.security.Provider	createProviderInstance(java.lang.String providerClassName)
java.lang.String	getName()
protected java.security.Provider	getOrCreateProvider(java.lang.String providerClassName) Attempts to see if a provider with this name already registered.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() A map of properties that can be used to configure the SSH server or client.
boolean	isSecurityEntitySupported(java.lang.Class<?> entityType, java.lang.String name)
java.lang.String	toString()

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.util.security.SecurityProviderRegistrar

findSecurityProviderRegistrarBySecurityEntity, getBasePropertyName, getConfigurationPropertyName, getDefaultSecurityEntitySupportValue, getEffectiveSecurityEntityName, getParentPropertyResolver, isAllOptionsValue, isCertificateFactorySupported, isCipherSupported, isEnabled, isKeyAgreementSupported, isKeyFactorySupported, isKeyPairGeneratorSupported, isMacSupported, isMessageDigestSupported, isNamedProviderUsed, isSecurityEntitySupported, isSecurityEntitySupported, isSignatureSupported, registerSecurityProvider

Methods inherited from interface org.apache.sshd.common.util.security.SecurityProviderChoice

createProviderInstance, getSecurityProvider, toSecurityProviderChoice, toSecurityProviderChoice

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, getNameList, getNames, ofName, removeByName

Methods inherited from interface org.apache.sshd.common.OptionalFeature

all, any, isSupported, of

Methods inherited from interface org.apache.sshd.common.PropertyResolver

getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getString, getStringProperty

Field Detail

props

protected final java.util.Map<java.lang.String,java.lang.Object> props

supportedEntities

protected final java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.String,java.lang.Boolean>> supportedEntities

providerHolder

protected final java.util.concurrent.atomic.AtomicReference<java.security.Provider> providerHolder

name

private final java.lang.String name

Constructor Detail

AbstractSecurityProviderRegistrar

protected AbstractSecurityProviderRegistrar(java.lang.String name)

Method Detail

getName

public final java.lang.String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Description copied from interface: PropertyResolver

A map of properties that can be used to configure the SSH server or client. This map will never be changed by either the server or client and is not supposed to be changed at runtime (changes are not bound to have any effect on a running client or server), though it may affect the creation of sessions later as these values are usually not cached.

Note: the type of the mapped property should match the expected configuration value type - Long, Integer, Boolean, String, etc.... If it doesn't, the toString() result of the mapped value is used to convert it to the required type. E.g., if the mapped value is the string "1234" and the expected value is a long then it will be parsed into one. Also, if the mapped value is an Integer but a long is expected, then it will be converted into one.

Specified by:

getProperties in interface PropertyResolver

Specified by:

getProperties in interface SecurityProviderRegistrar

Returns:

a valid Map containing configuration values, never null. Note: may be immutable.

isSecurityEntitySupported

public boolean isSecurityEntitySupported(java.lang.Class<?> entityType,
                                         java.lang.String name)

Specified by:

isSecurityEntitySupported in interface SecurityProviderRegistrar

getOrCreateProvider

protected java.security.Provider getOrCreateProvider(java.lang.String providerClassName)
                                              throws java.lang.ReflectiveOperationException

Attempts to see if a provider with this name already registered. If not, then uses reflection API in order to load and instantiate the specified providerClassName

Parameters:

providerClassName - The fully-qualified class name to instantiate if a provider not already registered

Returns:

The resolved Provider instance - Note: the result is cached - i.e., successful resolution result will not cause the code to re-resolve the provider

Throws:

java.lang.ReflectiveOperationException - If failed to instantiate the provider

java.lang.UnsupportedOperationException - If registrar not supported

See Also:

OptionalFeature.isSupported(), Security.getProvider(String), createProviderInstance(String)

createProviderInstance

protected java.security.Provider createProviderInstance(java.lang.String providerClassName)
                                                 throws java.lang.ReflectiveOperationException

Throws:

java.lang.ReflectiveOperationException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object