Top Fields Constructors Methods

org.apache.sshd.sftp.client.fs

public Class SftpFileSystemInitializationContext

Class Inheritance

extends Object

java.lang.Object
org.apache.sshd.sftp.client.fs.SftpFileSystemInitializationContext

Imports

java.net.URI, java.time.Duration, java.util.Map, org.apache.sshd.common.PropertyResolver, org.apache.sshd.common.auth.BasicCredentialsProvider

Author: Apache MINA SSHD Project

Field Summary

Modifier and Type	Field and Description
private BasicCredentialsProvider	credentials
private final Map<String, ?>	environment
private String	host
private final String	id
private Duration	maxAuthTime
private Duration	maxConnectTime
private int	port
private PropertyResolver	propertyResolver
private final URI	uri

Constructor Summary

Access	Constructor and Description
public	SftpFileSystemInitializationContext(String The unique identifier assigned to the file-system being created id, URI The original `URI` that triggered the file-system creation uri, Map<String, ?> The environment settings passed along with the URI (may be `null`) env)

Method Summary

Modifier and Type	Method and Description
public BasicCredentialsProvider	Returns: The credentials recovered from the URI getCredentials()
public Map<String, ?>	Returns: The environment settings passed along with the URI (may be `null`) getEnvironment()
public String	getHost()
public String	Returns: The unique identifier assigned to the file-system being created getId()
public Duration	Returns: The resolved max. authentication timeout (msec.) getMaxAuthTime()
public Duration	Returns: The resolved max. connect timeout (msec.) getMaxConnectTime()
public int	Returns: The resolved target port from the URI getPort()
public PropertyResolver	Returns: A `PropertyResolver` for easy access of any query parameters encoded in the URI getPropertyResolver()
public URI	Returns: The original `URI` that triggered the file-system creation getUri()
public void	setCredentials(BasicCredentialsProvider credentials)
public void	setHost(String host)
public void	setMaxAuthTime(Duration maxAuthTime)
public void	setMaxConnectTime(Duration maxConnectTime)
public void	setPort(int port)
public void	setPropertyResolver(PropertyResolver propertyResolver)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

credentials	back to summary
private BasicCredentialsProvider credentials

environment	back to summary
private final Map<String, ?> environment

host	back to summary
private String host

id	back to summary
private final String id

maxAuthTime	back to summary
private Duration maxAuthTime

maxConnectTime	back to summary
private Duration maxConnectTime

port	back to summary
private int port

propertyResolver	back to summary
private PropertyResolver propertyResolver

uri	back to summary
private final URI uri

Constructor Detail

SftpFileSystemInitializationContext	back to summary
public SftpFileSystemInitializationContext(String id, URI uri, Map<String, ?> env) Parameters id:String The unique identifier assigned to the file-system being created uri:URI The original `URI` that triggered the file-system creation env:Map<String, ?> The environment settings passed along with the URI (may be `null`)

Method Detail

getCredentials	back to summary
public BasicCredentialsProvider getCredentials() Returns:BasicCredentialsProvider The credentials recovered from the URI

getEnvironment	back to summary
public Map<String, ?> getEnvironment() Returns:Map<String, ?> The environment settings passed along with the URI (may be `null`)

getHost	back to summary
public String getHost()

getId	back to summary
public String getId() Returns:String The unique identifier assigned to the file-system being created

getMaxAuthTime	back to summary
public Duration getMaxAuthTime() Returns:Duration The resolved max. authentication timeout (msec.)

getMaxConnectTime	back to summary
public Duration getMaxConnectTime() Returns:Duration The resolved max. connect timeout (msec.)

getPort	back to summary
public int getPort() Returns:int The resolved target port from the URI

getPropertyResolver	back to summary
public PropertyResolver getPropertyResolver() Returns:PropertyResolver A `PropertyResolver` for easy access of any query parameters encoded in the URI

getUri	back to summary
public URI getUri() Returns:URI The original `URI` that triggered the file-system creation

setCredentials	back to summary
public void setCredentials(BasicCredentialsProvider credentials)

setHost	back to summary
public void setHost(String host)

setMaxAuthTime	back to summary
public void setMaxAuthTime(Duration maxAuthTime)

setMaxConnectTime	back to summary
public void setMaxConnectTime(Duration maxConnectTime)

setPort	back to summary
public void setPort(int port)

setPropertyResolver	back to summary
public void setPropertyResolver(PropertyResolver propertyResolver)

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