ScpLocation (Apache Mina SSHD

java.lang.Object
- org.apache.sshd.scp.common.ScpLocation

All Implemented Interfaces:

Serializable, Cloneable, MutableUserHolder, UsernameHolder
```
public class ScpLocation
extends Object
implements MutableUserHolder, Serializable, Cloneable
```
Represents a local or remote SCP location in the format "user@host:path" or "scp://[user@]host[:port][/path]" for a remote path and a simple path for a local one. If user is omitted for a remote path then current user is used.

Author:

Apache MINA SSHD Project

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static char HOST_PART_SEPARATOR

static String SCHEME

static char USERNAME_PART_SEPARATOR

Fields
Modifier and Type	Field and Description
`static char`	`HOST_PART_SEPARATOR`
`static String`	`SCHEME`
`static char`	`USERNAME_PART_SEPARATOR`

Constructor Summary

Constructors
Constructor and Description
`ScpLocation()`
`ScpLocation(String locSpec)`
`ScpLocation(String username, String host, int port, String path)`
`ScpLocation(String username, String host, String path)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScpLocation`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getHost()`
`String`	`getPath()`
`int`	`getPort()`
`String`	`getUsername()`
`int`	`hashCode()`
`boolean`	`isLocal()`
`static ScpLocation`	`parse(String locSpec)` Parses a local or remote SCP location in the format "user@host:path" or "scp://[user@]host[:port][/path]"
`int`	`resolvePort()`
`String`	`resolveUsername()` Resolves the effective username to use for a remote location.
`void`	`setHost(String host)`
`void`	`setPath(String path)`
`void`	`setPort(int port)`
`void`	`setUsername(String username)`
`String`	`toString()`
`static <L extends ScpLocation> L`	`update(String spec, L location)` Parses a local or remote SCP location in the format "user@host:path" or "scp://[user@]host[:port][/path]"

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SCHEME
```
public static final String SCHEME
```
    See Also:
    
    Constant Field Values
  - HOST_PART_SEPARATOR
```
public static final char HOST_PART_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - USERNAME_PART_SEPARATOR
```
public static final char USERNAME_PART_SEPARATOR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ScpLocation
```
public ScpLocation()
```
  - ScpLocation
```
public ScpLocation(String locSpec)
```
    Parameters:
    
    locSpec - The location specification - ignored if null/empty
    
    Throws:
    
    IllegalArgumentException - if invalid specification
    
    See Also:
    
    update(String, ScpLocation)
  - ScpLocation
```
public ScpLocation(String username,
                   String host,
                   String path)
```
  - ScpLocation
```
public ScpLocation(String username,
                   String host,
                   int port,
                   String path)
```
- Method Detail
  - getHost
```
public String getHost()
```
  - setHost
```
public void setHost(String host)
```
  - isLocal
```
public boolean isLocal()
```
  - getPort
```
public int getPort()
```
  - setPort
```
public void setPort(int port)
```
  - resolvePort
```
public int resolvePort()
```
  - getUsername
```
public String getUsername()
```
    Specified by:
    
    getUsername in interface UsernameHolder
  - setUsername
```
public void setUsername(String username)
```
    Specified by:
    
    setUsername in interface MutableUserHolder
  - resolveUsername
```
public String resolveUsername()
```
    Resolves the effective username to use for a remote location. If username not set then uses the current username
    
    Returns:
    
    The resolved username
    
    See Also:
    
    getUsername(), OsUtils.getCurrentUser()
  - getPath
```
public String getPath()
```
  - setPath
```
public void setPath(String path)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public ScpLocation clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - parse
```
public static ScpLocation parse(String locSpec)
```
    Parses a local or remote SCP location in the format "user@host:path" or "scp://[user@]host[:port][/path]"
    
    Parameters:
    
    locSpec - The location specification - ignored if null/empty
    
    Returns:
    
    The ScpLocation or null if no specification provider
    
    Throws:
    
    IllegalArgumentException - if invalid specification
    
    See Also:
    
    update(String, ScpLocation)
  - update
```
public static <L extends ScpLocation> L update(String spec,
                                               L location)
```
    Parses a local or remote SCP location in the format "user@host:path" or "scp://[user@]host[:port][/path]"
    
    Type Parameters:
    
    L - Type of ScpLocation being updated
    
    Parameters:
    
    spec - The location specification - ignored if null/empty
    
    location - The ScpLocation to update - never null
    
    Returns:
    
    The updated location (unless no specification)
    
    Throws:
    
    IllegalArgumentException - if invalid specification

Class ScpLocation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCHEME

HOST_PART_SEPARATOR

USERNAME_PART_SEPARATOR

Constructor Detail

ScpLocation

ScpLocation

ScpLocation

ScpLocation

Method Detail

getHost

setHost

isLocal

getPort

setPort

resolvePort

getUsername

setUsername

resolveUsername

getPath

setPath

hashCode

equals

clone

toString

parse

update