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.


Method Summary
 java.lang.String getDescription()
          Get the description for this transfer target
 java.lang.String getEndpointHost()
          Get the endpoint host
 java.lang.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
 int getEndpointPort()
          Get the endpoint port
 java.lang.String getEndpointProtocol()
          HTTP OR HTTPS
 java.lang.String getName()
          Get the name of this transfer target
 org.alfresco.service.cmr.repository.NodeRef getNodeRef()
          read only - get the node reference of the underlying transfer target node.
 char[] getPassword()
          Get the cleartext password
 java.lang.String getTitle()
          Get the title of this transfer target
 java.lang.String getUsername()
          The username used to authenticate with the transfer target
 boolean isEnabled()
          is this transfer target enabled or disabled?
 void setDescription(java.lang.String description)
          Set the decription for this transfer target
 void setEnabled(boolean enabled)
          enable this transfer target
 void setEndpointHost(java.lang.String endpointHost)
          Set the endpoint host
 void setEndpointPath(java.lang.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
 void setEndpointPort(int endpointPort)
          Set the endpoint port
 void setEndpointProtocol(java.lang.String endpointProtocol)
          Set the endpoint protocol.
 void setPassword(char[] password)
          Set the password for this transfer target
 void setTitle(java.lang.String title)
          Set the title for this transfer target
 void setUsername(java.lang.String userName)
          The username used to authenticate with the transfer target
 

Method Detail

getNodeRef

org.alfresco.service.cmr.repository.NodeRef getNodeRef()
read only - get the node reference of the underlying transfer target node.

Returns:

getName

java.lang.String getName()
Get the name of this transfer target

Returns:

getDescription

java.lang.String getDescription()
Get the description for this transfer target

Returns:

setDescription

void setDescription(java.lang.String description)
Set the decription for this transfer target

Parameters:
description -

getTitle

java.lang.String getTitle()
Get the title of this transfer target

Returns:

setTitle

void setTitle(java.lang.String title)
Set the title for this transfer target

Parameters:
title -

getEndpointHost

java.lang.String getEndpointHost()
Get the endpoint host

Returns:

setEndpointHost

void setEndpointHost(java.lang.String endpointHost)
Set the endpoint host

Parameters:
endpointHost -

getEndpointPort

int getEndpointPort()
Get the endpoint port

Returns:

setEndpointPort

void setEndpointPort(int endpointPort)
Set the endpoint port

Parameters:
endpointPort -

getEndpointProtocol

java.lang.String getEndpointProtocol()
HTTP OR HTTPS


setEndpointProtocol

void setEndpointProtocol(java.lang.String endpointProtocol)
Set the endpoint protocol.

Parameters:
endpointProtocol -

setPassword

void setPassword(char[] password)
Set the password for this transfer target

Parameters:
password - clear text password.

getUsername

java.lang.String getUsername()
The username used to authenticate with the transfer target

Returns:

setUsername

void setUsername(java.lang.String userName)
The username used to authenticate with the transfer target

Parameters:
userName -

getPassword

char[] getPassword()
Get the cleartext password

Returns:

getEndpointPath

java.lang.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:

setEndpointPath

void setEndpointPath(java.lang.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



Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.