Package org.apache.sshd.sftp.client.fs

Class SftpFileSystemInitializationContext

java.lang.Object

org.apache.sshd.sftp.client.fs.SftpFileSystemInitializationContext

public class SftpFileSystemInitializationContext
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
private BasicCredentialsProvider	credentials
private java.util.Map<java.lang.String,?>	environment
private java.lang.String	host
private java.lang.String	id
private java.time.Duration	maxAuthTime
private java.time.Duration	maxConnectTime
private int	port
private PropertyResolver	propertyResolver
private java.net.URI	uri

Constructor Summary

Constructors

Constructor	Description
SftpFileSystemInitializationContext(java.lang.String id, java.net.URI uri, java.util.Map<java.lang.String,?> env)

Method Summary

Modifier and Type	Method	Description
BasicCredentialsProvider	getCredentials()
java.util.Map<java.lang.String,?>	getEnvironment()
java.lang.String	getHost()
java.lang.String	getId()
java.time.Duration	getMaxAuthTime()
java.time.Duration	getMaxConnectTime()
int	getPort()
PropertyResolver	getPropertyResolver()
java.net.URI	getUri()
void	setCredentials(BasicCredentialsProvider credentials)
void	setHost(java.lang.String host)
void	setMaxAuthTime(java.time.Duration maxAuthTime)
void	setMaxConnectTime(java.time.Duration maxConnectTime)
void	setPort(int port)
void	setPropertyResolver(PropertyResolver propertyResolver)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

private final java.lang.String id

uri

private final java.net.URI uri

environment

private final java.util.Map<java.lang.String,?> environment

host

private java.lang.String host

port

private int port

credentials

private BasicCredentialsProvider credentials

propertyResolver

private PropertyResolver propertyResolver

maxConnectTime

private java.time.Duration maxConnectTime

maxAuthTime

private java.time.Duration maxAuthTime

Constructor Detail

SftpFileSystemInitializationContext

public SftpFileSystemInitializationContext(java.lang.String id,
                                           java.net.URI uri,
                                           java.util.Map<java.lang.String,?> env)

Parameters:

id - The unique identifier assigned to the file-system being created

uri - The original URI that triggered the file-system creation

env - The environment settings passed along with the URI (may be null)

Method Detail

getId

public java.lang.String getId()

Returns:

The unique identifier assigned to the file-system being created

getUri

public java.net.URI getUri()

Returns:

The original URI that triggered the file-system creation

getEnvironment

public java.util.Map<java.lang.String,?> getEnvironment()

Returns:

The environment settings passed along with the URI (may be null)

getHost

public java.lang.String getHost()

setHost

public void setHost(java.lang.String host)

getPort

public int getPort()

Returns:

The resolved target port from the URI

setPort

public void setPort(int port)

getCredentials

public BasicCredentialsProvider getCredentials()

Returns:

The credentials recovered from the URI

setCredentials

public void setCredentials(BasicCredentialsProvider credentials)

getPropertyResolver

public PropertyResolver getPropertyResolver()

Returns:

A PropertyResolver for easy access of any query parameters encoded in the URI

setPropertyResolver

public void setPropertyResolver(PropertyResolver propertyResolver)

getMaxConnectTime

public java.time.Duration getMaxConnectTime()

Returns:

The resolved max. connect timeout (msec.)

setMaxConnectTime

public void setMaxConnectTime(java.time.Duration maxConnectTime)

getMaxAuthTime

public java.time.Duration getMaxAuthTime()

Returns:

The resolved max. authentication timeout (msec.)

setMaxAuthTime

public void setMaxAuthTime(java.time.Duration maxAuthTime)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object