JSCAPE MFT Server

com.jscape.inet.mft.resources
Class SftpResourceDescriptor

java.lang.Object
  extended by com.jscape.inet.mft.resources.SftpResourceDescriptor
All Implemented Interfaces:
com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>, ResourceDescriptor

public class SftpResourceDescriptor
extends java.lang.Object
implements com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>

SFTP resource descriptor. Contains information about remote SFTP connection.

Author:
Alex

Nested Class Summary
static interface SftpResourceDescriptor.Handler
           
 
Nested classes/interfaces inherited from interface com.jscape.inet.mft.resources.RemoteResourceDescriptor
com.jscape.inet.mft.resources.RemoteResourceDescriptor.HandlerBase
 
Constructor Summary
SftpResourceDescriptor()
          Creates a new descriptor instance.
SftpResourceDescriptor(SftpResourceDescriptor that)
           
SftpResourceDescriptor(java.lang.String name, java.lang.String host, int port, java.lang.String username, java.lang.String password, boolean usingCredentials, long timeout, com.jscape.inet.vfs.KeyProvider keyProvider, java.lang.String logDirectory, java.lang.Long timeToLive, com.jscape.inet.mft.RemoteDirectory remoteDirectory, boolean useAdaptiveConnection, boolean startSubsystemReplyRequired)
           
 
Method Summary
 void accept(SftpResourceDescriptor.Handler handler)
           
 SftpResourceDescriptor copy()
           
 boolean equals(java.lang.Object o)
           
 java.lang.String getHost()
          Returns server hostname/IP.
 com.jscape.inet.vfs.KeyProvider getKeyProvider()
           
 java.lang.String getLogDirectory()
           
 java.lang.String getName()
          Returns resource name.
 java.lang.String getPassword()
          Returns connection password.
 int getPort()
          Returns server port.
 com.jscape.inet.mft.RemoteDirectory getRemoteDirectory()
           
 long getTimeout()
           
 java.lang.Long getTimeToLive()
           
 java.lang.String getUsername()
          Returns username.
 boolean getUsingCredentials()
          Returns use user credentials indicator.
 int hashCode()
           
 boolean isStartSubsystemReplyRequired()
           
 boolean isUseAdaptiveConnection()
           
 void setHost(java.lang.String value)
          Sets server hostname/IP.
 void setKey(java.lang.String value)
           
 void setKeyProvider(com.jscape.inet.vfs.KeyProvider value)
           
 void setLogDirectory(java.lang.String value)
           
 void setName(java.lang.String value)
          Sets resource name.
 void setPassword(java.lang.String value)
          Sets connection password.
 void setPort(int value)
          Sets server port.
 void setRemoteDirectory(com.jscape.inet.mft.RemoteDirectory value)
           
 void setStartSubsystemReplyRequired(boolean value)
           
 void setTimeout(long value)
           
 void setTimeToLive(java.lang.Long value)
           
 void setUseAdaptiveConnection(boolean value)
           
 void setUsername(java.lang.String value)
          Sets username.
 void setUsingCredentials(boolean value)
          Sets use user credentials.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SftpResourceDescriptor

public SftpResourceDescriptor(java.lang.String name,
                              java.lang.String host,
                              int port,
                              java.lang.String username,
                              java.lang.String password,
                              boolean usingCredentials,
                              long timeout,
                              com.jscape.inet.vfs.KeyProvider keyProvider,
                              java.lang.String logDirectory,
                              java.lang.Long timeToLive,
                              com.jscape.inet.mft.RemoteDirectory remoteDirectory,
                              boolean useAdaptiveConnection,
                              boolean startSubsystemReplyRequired)

SftpResourceDescriptor

public SftpResourceDescriptor(SftpResourceDescriptor that)

SftpResourceDescriptor

public SftpResourceDescriptor()
Creates a new descriptor instance.

Method Detail

getName

public java.lang.String getName()
Returns resource name.

Specified by:
getName in interface ResourceDescriptor
Returns:
resource name

setName

public void setName(java.lang.String value)
Sets resource name.

Parameters:
value - the resource name

getHost

public java.lang.String getHost()
Returns server hostname/IP.

Returns:
server hostname/IP

setHost

public void setHost(java.lang.String value)
Sets server hostname/IP.

Parameters:
value - the server hostname/IP

getPort

public int getPort()
Returns server port.

Returns:
server port

setPort

public void setPort(int value)
Sets server port.

Parameters:
value - the server port

getUsingCredentials

public boolean getUsingCredentials()
Returns use user credentials indicator.

Specified by:
getUsingCredentials in interface com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>
Returns:
true user will authenticate to FTP resource using current user credentials, false otherwise

setUsingCredentials

public void setUsingCredentials(boolean value)
Sets use user credentials. When it is true user will authenticate to FTP resource with the current user credentials

Parameters:
value - Indicates use current user credentials

getUsername

public java.lang.String getUsername()
Returns username.

Specified by:
getUsername in interface com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>
Returns:
username

setUsername

public void setUsername(java.lang.String value)
Sets username.

Specified by:
setUsername in interface com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>
Parameters:
value - the username

getPassword

public java.lang.String getPassword()
Returns connection password.

Specified by:
getPassword in interface com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>
Returns:
connection password

setPassword

public void setPassword(java.lang.String value)
Sets connection password.

Specified by:
setPassword in interface com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>
Parameters:
value - the connection password

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long value)

setKey

public void setKey(java.lang.String value)

getKeyProvider

public com.jscape.inet.vfs.KeyProvider getKeyProvider()

setKeyProvider

public void setKeyProvider(com.jscape.inet.vfs.KeyProvider value)

getLogDirectory

public java.lang.String getLogDirectory()

setLogDirectory

public void setLogDirectory(java.lang.String value)

getTimeToLive

public java.lang.Long getTimeToLive()
Specified by:
getTimeToLive in interface ResourceDescriptor

setTimeToLive

public void setTimeToLive(java.lang.Long value)

getRemoteDirectory

public com.jscape.inet.mft.RemoteDirectory getRemoteDirectory()
Specified by:
getRemoteDirectory in interface com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>

setRemoteDirectory

public void setRemoteDirectory(com.jscape.inet.mft.RemoteDirectory value)
Specified by:
setRemoteDirectory in interface com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>

copy

public SftpResourceDescriptor copy()
Specified by:
copy in interface com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>

isUseAdaptiveConnection

public boolean isUseAdaptiveConnection()

setUseAdaptiveConnection

public void setUseAdaptiveConnection(boolean value)

isStartSubsystemReplyRequired

public boolean isStartSubsystemReplyRequired()

setStartSubsystemReplyRequired

public void setStartSubsystemReplyRequired(boolean value)

accept

public void accept(SftpResourceDescriptor.Handler handler)
            throws java.lang.Exception
Specified by:
accept in interface com.jscape.inet.mft.resources.RemoteResourceDescriptor<SftpResourceDescriptor.Handler>
Throws:
java.lang.Exception

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

JSCAPE MFT Server

Copyright © JSCAPE LLC. 1999-2013. All Rights Reserved