Interface IRemoteConnectionWorkingCopy

All Superinterfaces:
IRemoteConnection

public interface IRemoteConnectionWorkingCopy extends IRemoteConnection
A working copy of a remote connection used to change the name and/or attributes of the connection. It is also used when creating a new connection
  • Method Details

    • getOriginal

      IRemoteConnection getOriginal()
      Returns the original connection this working copy was created from. Returns null if this is a new connection.
      Returns:
      original connection
    • isDirty

      boolean isDirty()
      Returns whether this connection has been modified since it was last saved or created.
      Returns:
      true if the connection has been modified
    • save

      Saves this working copy to its original connection and returns a handle to the resulting connection. Has no effect if this connection does not need saving.
      Returns:
      saved connection
      Throws:
      RemoteConnectionException
    • setName

      void setName(String name)
      Set the name for this connection
      Parameters:
      name -
    • setAttribute

      void setAttribute(String key, String value)
      Set an implementation dependent attribute for the connection. Attributes keys supported by the connection can be obtained using
      invalid reference
      #getAttributes()
      . Attributes are persisted along with connection information.
      Parameters:
      key - attribute key
      value - attribute value
    • setSecureAttribute

      void setSecureAttribute(String key, String value)
      Set an attribute such as a password that's stored in secure storage.
      Parameters:
      key -
      value -
      Since:
      2.0