Package org.alfresco.service.cmr.transfer

Interface TransferTarget

All Known Implementing Classes:
TransferTargetImpl
public interface TransferTarget
Transfer Target. Definition of a remote target to transfer to, contains details such as its name and address.
Author:
Mark Rogers

  • Method Details

    • getNodeRef

      NodeRef getNodeRef()
      read only - get the node reference of the underlying transfer target node.
      Returns:
      NodeRef

    • getName

      String getName()
      Get the name of this transfer target
      Returns:
      String

    • getDescription

      String getDescription()
      Get the description for this transfer target
      Returns:
      String

    • setDescription

      void setDescription(String description)
      Set the decription for this transfer target
      Parameters:
      description - String

    • getTitle

      String getTitle()
      Get the title of this transfer target
      Returns:
      String

    • setTitle

      void setTitle(String title)
      Set the title for this transfer target
      Parameters:
      title - String

    • getEndpointHost

      String getEndpointHost()
      Get the endpoint host
      Returns:
      String

    • setEndpointHost

      void setEndpointHost(String endpointHost)
      Set the endpoint host
      Parameters:
      endpointHost - String

    • getEndpointPort

      int getEndpointPort()
      Get the endpoint port
      Returns:
      int

    • setEndpointPort

      void setEndpointPort(int endpointPort)
      Set the endpoint port
      Parameters:
      endpointPort - int

    • getEndpointProtocol

      String getEndpointProtocol()
      HTTP OR HTTPS

    • setEndpointProtocol

      void setEndpointProtocol(String endpointProtocol)
      Set the endpoint protocol.
      Parameters:
      endpointProtocol - String

    • setPassword

      void setPassword(char[] password)
      Set the password for this transfer target
      Parameters:
      password - clear text password.

    • getUsername

      String getUsername()
      The username used to authenticate with the transfer target
      Returns:
      String

    • setUsername

      void setUsername(String userName)
      The username used to authenticate with the transfer target
      Parameters:
      userName - String

    • getPassword

      char[] getPassword()
      Get the cleartext password
      Returns:
      char[]

    • getEndpointPath

      String getEndpointPath()
      The location of the transfer service on the target endpoint host Defaults to "/alfresco/service/api/transfer", and this shouldn't typically need to change
      Returns:
      String

    • setEndpointPath

      void setEndpointPath(String path)
      The location of the transfer service on the target endpoint host Defaults to "/alfresco/service/api/transfer", and this shouldn't typically need to change

    • isEnabled

      boolean isEnabled()
      is this transfer target enabled or disabled?

    • setEnabled

      void setEnabled(boolean enabled)
      enable this transfer target