Apache Mina SSHD 2.15.0 · org.apache.sshd.common.util.security.AbstractSecurityProviderRegistrar

Modifier and Type	Field and Description
private final String	name
protected final Map<String, Object>	props
protected final AtomicReference<Provider>	providerHolder
protected final Map<Class<?>, Map<String, Boolean>>	supportedEntities

Access	Constructor and Description
protected	AbstractSecurityProviderRegistrar(String name)

Method Summary

Modifier and Type	Method and Description
protected Provider	createProviderInstance(String providerClassName)
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
protected Provider	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 getOrCreateProvider(String The fully-qualified class name to instantiate if a provider not already registered providerClassName) Attempts to see if a provider with this name already registered.
public Map<String, Object>	getProperties() Overrides default org.apache.sshd.common.util.security.SecurityProviderRegistrar.getProperties. A map of properties that can be used to configure the SSH server or client.
public boolean	isSecurityEntitySupported(Class<?> entityType, String name) Overrides default org.apache.sshd.common.util.security.SecurityProviderRegistrar.isSecurityEntitySupported.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: debug debug debug debug debug error error error error error getSimplifiedLogger info info warn warn warn warn warn warn warn warn

name	back to summary
private final String name

props	back to summary
protected final Map<String, Object> props

providerHolder	back to summary
protected final AtomicReference<Provider> providerHolder

supportedEntities	back to summary
protected final Map<Class<?>, Map<String, Boolean>> supportedEntities

AbstractSecurityProviderRegistrar	back to summary
protected AbstractSecurityProviderRegistrar(String name)

Method Detail

createProviderInstance	back to summary
protected Provider createProviderInstance(String providerClassName) throws ReflectiveOperationException

getName	back to summary
public final String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public final String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations

@Override

getOrCreateProvider back to summary

getOrCreateProvider	back to summary
protected Provider getOrCreateProvider(String providerClassName) throws 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:String The fully-qualified class name to instantiate if a provider not already registered Returns:Provider The resolved `Provider` instance - Note: the result is cached - i.e., successful resolution result will not cause the code to re-resolve the provider Exceptions ReflectiveOperationException: If failed to instantiate the provider UnsupportedOperationException: If registrar not supported See Also `isSupported()`, `Security#getProvider(String)`, `createProviderInstance(String)`

protected Provider getOrCreateProvider(String providerClassName) throws 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:String: The fully-qualified class name to instantiate if a provider not already registered

Returns:Provider

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

Exceptions

ReflectiveOperationException:: If failed to instantiate the provider
UnsupportedOperationException:: If registrar not supported

getProperties back to summary

getProperties	back to summary
public Map<String, Object> getProperties() Overrides default org.apache.sshd.common.util.security.SecurityProviderRegistrar.getProperties. Doc from org.apache.sshd.common.PropertyResolver.getProperties. 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. Returns:Map<String, Object> a valid `Map` containing configuration values, never `null` Note may be immutable. Annotations @Override

public Map<String, Object> getProperties()

Overrides default org.apache.sshd.common.util.security.SecurityProviderRegistrar.getProperties.

Doc from org.apache.sshd.common.PropertyResolver.getProperties.

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.

Returns:Map<String, Object>

a valid Map containing configuration values, never null

Note

may be immutable.

Annotations

@Override

isSecurityEntitySupported	back to summary
public boolean isSecurityEntitySupported(Class<?> entityType, String name) Overrides default org.apache.sshd.common.util.security.SecurityProviderRegistrar.isSecurityEntitySupported. Annotations @Override

isSecurityEntitySupported

back to summary

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

Overrides default org.apache.sshd.common.util.security.SecurityProviderRegistrar.isSecurityEntitySupported.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public abstract Class AbstractSecurityProviderRegistrar

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail