Interface PropertyResolver
- All Known Subinterfaces:
Channel,ClientChannel,ClientFactoryManager,ClientSession,ConnectionService,FactoryManager,SecurityProviderRegistrar,ServerChannel,ServerFactoryManager,ServerSession,Service,Session,SessionContext,SessionHeartbeatController
- All Known Implementing Classes:
AbstractChannel,AbstractClientChannel,AbstractClientSession,AbstractConnectionService,AbstractFactoryManager,AbstractSecurityProviderRegistrar,AbstractServerChannel,AbstractServerSession,AbstractSession,AgentForwardedChannel,BouncyCastleSecurityProviderRegistrar,ChannelAgentForwarding,ChannelDirectTcpip,ChannelExec,ChannelForwardedX11,ChannelSession,ChannelSession,ChannelShell,ChannelSubsystem,ClientConnectionService,ClientSessionImpl,ClientUserAuthService,DefaultSftpClient.SftpChannelSubsystem,EdDSASecurityProviderRegistrar,PtyCapableChannelSession,ServerConnectionService,ServerSessionImpl,ServerUserAuthService,SessionHelper,SshClient,SshServer,TcpipClientChannel,TcpipServerChannel
boolean value, or from int to long, etc.. Note: implementations may decide
to use case insensitive property names, therefore it is highly discouraged to use names that
differ from each other only in case sensitivity. Also, implementations may choose to trim whitespaces, thus such are
also highly discouraged.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final PropertyResolverAn "empty" resolver with no properties and no parent -
Method Summary
Modifier and TypeMethodDescriptiondefault BooleangetBoolean(String name) default booleangetBooleanProperty(String name, boolean def) default CharsetgetCharset(String name, Charset defaultValue) default IntegergetInteger(String name) default intgetIntProperty(String name, int def) default Longdefault longgetLongProperty(String name, long def) default ObjectA map of properties that can be used to configure the SSH server or client.default Stringdefault StringgetStringProperty(String name, String def) default booleanisEmpty()static booleanisEmpty(PropertyResolver resolver)
-
Field Details
-
EMPTY
An "empty" resolver with no properties and no parent
-
-
Method Details
-
getParentPropertyResolver
PropertyResolver getParentPropertyResolver()- Returns:
- The parent resolver that can be used to query for missing properties -
nullif no parent
-
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, thetoString()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 alongthen it will be parsed into one. Also, if the mapped value is anIntegerbut alongis expected, then it will be converted into one.- Returns:
- a valid
Mapcontaining configuration values, nevernull. Note: may be immutable.
-
isEmpty
default boolean isEmpty() -
getLongProperty
-
getLong
-
getIntProperty
-
getInteger
-
getBooleanProperty
-
getBoolean
-
getStringProperty
-
getString
-
getObject
-
getCharset
-
isEmpty
-