RemoteCredentialsHolder (Unofficial IntelliJ Community Edition API docs)

java.lang.Object
- com.intellij.remote.RemoteCredentialsHolder

All Implemented Interfaces:

MutableRemoteCredentials, RemoteCredentials

Direct Known Subclasses:

RemoteSdkCredentialsHolder
```
public class RemoteCredentialsHolder
extends java.lang.Object
implements MutableRemoteCredentials
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ANONYMOUS`
`static java.lang.String`	`HOST`
`static java.lang.String`	`PASSPHRASE`
`static java.lang.String`	`PASSWORD`
`static java.lang.String`	`PORT`
`static java.lang.String`	`PRIVATE_KEY_FILE`
`static java.lang.String`	`SSH_PREFIX`
`static java.lang.String`	`USE_AUTH_AGENT`
`static java.lang.String`	`USE_KEY_PAIR`
`static java.lang.String`	`USERNAME`

Constructor Summary

Constructors
Constructor and Description

RemoteCredentialsHolder()

RemoteCredentialsHolder(RemoteCredentials credentials)

Constructors
Constructor and Description
`RemoteCredentialsHolder()`
`RemoteCredentialsHolder(RemoteCredentials credentials)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copyFrom(RemoteCredentials from)`
`static void`	`copyRemoteCredentials(RemoteCredentials from, MutableRemoteCredentials to)`
`void`	`copyRemoteCredentialsTo(MutableRemoteCredentials to)`
`boolean`	`equals(java.lang.Object o)`
`AuthType`	`getAuthType()`
`static java.lang.String`	`getCredentialsString(RemoteCredentials cred)`
`java.lang.String`	`getHost()`
`java.lang.String`	`getLiteralPort()`
`java.lang.String`	`getPassphrase()`
`java.lang.String`	`getPassword()`
`int`	`getPort()`
`java.lang.String`	`getPrivateKeyFile()`
`java.lang.String`	`getSerializedUserName()`
`java.lang.String`	`getUserName()`
`int`	`hashCode()`
`boolean`	`isStorePassphrase()`
`boolean`	`isStorePassword()`
`void`	`load(Element element)`
`void`	`save(Element rootElement)` Stores main part of ssh credentials in xml element and password and passphrase in PasswordSafe.
`void`	`setAuthType(AuthType authType)`
`void`	`setHost(java.lang.String host)`
`void`	`setLiteralPort(java.lang.String portText)` Sets string representation of port and its int value, which is equal to string one if it's a valid integer, and is 0 otherwise.
`void`	`setPassphrase(java.lang.String passphrase)`
`void`	`setPassword(java.lang.String password)`
`void`	`setPort(int port)` Sets both int and String representations of port.
`void`	`setPrivateKeyFile(java.lang.String privateKeyFile)`
`void`	`setStorePassphrase(boolean storePassphrase)`
`void`	`setStorePassword(boolean storePassword)`
`void`	`setUserName(java.lang.String userName)`

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

Methods inherited from interface com.intellij.remote.RemoteCredentials
isSkippingHostKeyVerification

- Field Detail
  - HOST
```
public static final java.lang.String HOST
```
    See Also:
    
    Constant Field Values
  - PORT
```
public static final java.lang.String PORT
```
    See Also:
    
    Constant Field Values
  - ANONYMOUS
```
public static final java.lang.String ANONYMOUS
```
    See Also:
    
    Constant Field Values
  - USERNAME
```
public static final java.lang.String USERNAME
```
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final java.lang.String PASSWORD
```
    See Also:
    
    Constant Field Values
  - USE_KEY_PAIR
```
public static final java.lang.String USE_KEY_PAIR
```
    See Also:
    
    Constant Field Values
  - USE_AUTH_AGENT
```
public static final java.lang.String USE_AUTH_AGENT
```
    See Also:
    
    Constant Field Values
  - PRIVATE_KEY_FILE
```
public static final java.lang.String PRIVATE_KEY_FILE
```
    See Also:
    
    Constant Field Values
  - PASSPHRASE
```
public static final java.lang.String PASSPHRASE
```
    See Also:
    
    Constant Field Values
  - SSH_PREFIX
```
public static final java.lang.String SSH_PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RemoteCredentialsHolder
```
public RemoteCredentialsHolder()
```
  - RemoteCredentialsHolder
```
public RemoteCredentialsHolder(RemoteCredentials credentials)
```
- Method Detail
  - getCredentialsString
```
public static java.lang.String getCredentialsString(RemoteCredentials cred)
```
  - getHost
```
public java.lang.String getHost()
```
    Specified by:
    
    getHost in interface RemoteCredentials
  - setHost
```
public void setHost(java.lang.String host)
```
    Specified by:
    
    setHost in interface MutableRemoteCredentials
  - getPort
```
public int getPort()
```
    Specified by:
    
    getPort in interface RemoteCredentials
  - setPort
```
public void setPort(int port)
```
    Sets both int and String representations of port.
    
    Specified by:
    
    setPort in interface MutableRemoteCredentials
  - getLiteralPort
```
public java.lang.String getLiteralPort()
```
    Specified by:
    
    getLiteralPort in interface RemoteCredentials
  - setLiteralPort
```
public void setLiteralPort(java.lang.String portText)
```
    Sets string representation of port and its int value, which is equal to string one if it's a valid integer, and is 0 otherwise.
    
    Specified by:
    
    setLiteralPort in interface MutableRemoteCredentials
  - getUserName
```
public java.lang.String getUserName()
```
    Specified by:
    
    getUserName in interface RemoteCredentials
  - setUserName
```
public void setUserName(java.lang.String userName)
```
    Specified by:
    
    setUserName in interface MutableRemoteCredentials
  - getPassword
```
public java.lang.String getPassword()
```
    Specified by:
    
    getPassword in interface RemoteCredentials
  - setPassword
```
public void setPassword(java.lang.String password)
```
    Specified by:
    
    setPassword in interface MutableRemoteCredentials
  - setStorePassword
```
public void setStorePassword(boolean storePassword)
```
    Specified by:
    
    setStorePassword in interface MutableRemoteCredentials
  - setStorePassphrase
```
public void setStorePassphrase(boolean storePassphrase)
```
    Specified by:
    
    setStorePassphrase in interface MutableRemoteCredentials
  - isStorePassword
```
public boolean isStorePassword()
```
    Specified by:
    
    isStorePassword in interface RemoteCredentials
  - isStorePassphrase
```
public boolean isStorePassphrase()
```
    Specified by:
    
    isStorePassphrase in interface RemoteCredentials
  - getPrivateKeyFile
```
public java.lang.String getPrivateKeyFile()
```
    Specified by:
    
    getPrivateKeyFile in interface RemoteCredentials
  - setPrivateKeyFile
```
public void setPrivateKeyFile(java.lang.String privateKeyFile)
```
    Specified by:
    
    setPrivateKeyFile in interface MutableRemoteCredentials
  - getPassphrase
```
public java.lang.String getPassphrase()
```
    Specified by:
    
    getPassphrase in interface RemoteCredentials
  - setPassphrase
```
public void setPassphrase(java.lang.String passphrase)
```
    Specified by:
    
    setPassphrase in interface MutableRemoteCredentials
  - getAuthType
```
public AuthType getAuthType()
```
    Specified by:
    
    getAuthType in interface RemoteCredentials
  - setAuthType
```
public void setAuthType(AuthType authType)
```
    Specified by:
    
    setAuthType in interface MutableRemoteCredentials
  - getSerializedUserName
```
public java.lang.String getSerializedUserName()
```
  - copyRemoteCredentialsTo
```
public void copyRemoteCredentialsTo(MutableRemoteCredentials to)
```
  - copyFrom
```
public void copyFrom(RemoteCredentials from)
```
  - copyRemoteCredentials
```
public static void copyRemoteCredentials(RemoteCredentials from,
                                         MutableRemoteCredentials to)
```
  - load
```
public void load(Element element)
```
  - save
```
public void save(Element rootElement)
```
    Stores main part of ssh credentials in xml element and password and passphrase in PasswordSafe.
    Don't use this method to serialize intermediate state of credentials because it will overwrite password and passphrase in PasswordSafe
  - 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

Class RemoteCredentialsHolder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.intellij.remote.RemoteCredentials

Field Detail

HOST

PORT

ANONYMOUS

USERNAME

PASSWORD

USE_KEY_PAIR

USE_AUTH_AGENT

PRIVATE_KEY_FILE

PASSPHRASE

SSH_PREFIX

Constructor Detail

RemoteCredentialsHolder

RemoteCredentialsHolder

Method Detail

getCredentialsString

getHost

setHost

getPort

setPort

getLiteralPort

setLiteralPort

getUserName

setUserName

getPassword

setPassword

setStorePassword

setStorePassphrase

isStorePassword

isStorePassphrase

getPrivateKeyFile

setPrivateKeyFile

getPassphrase

setPassphrase

getAuthType

setAuthType

getSerializedUserName

copyRemoteCredentialsTo

copyFrom

copyRemoteCredentials

load

save

equals

hashCode