Package org.alfresco.repo.transfer

Class HttpClientTransmitterImpl

java.lang.Object

org.alfresco.repo.transfer.HttpClientTransmitterImpl

All Implemented Interfaces:

TransferTransmitter

public class HttpClientTransmitterImpl
extends java.lang.Object
implements TransferTransmitter

HTTP implementation of TransferTransmitter. Sends data via HTTP to the server.

Author:

brian

Constructor Summary

Constructors

Constructor	Description
HttpClientTransmitterImpl()

Method Summary

Modifier and Type	Method	Description
void	abort(Transfer transfer)	Abort the transfer
Transfer	begin(TransferTarget target, java.lang.String fromRepositoryId, TransferVersion fromVersion)	Begin a transfer, the transfer object returned will be used by subsequent calls to the transfer service.
void	commit(Transfer transfer)
ContentService	getContentService()
protected org.apache.commons.httpclient.methods.PostMethod	getPostMethod()
TransferProgress	getStatus(Transfer transfer)	Get the status of an in process transfer
void	getTransferReport(Transfer transfer, java.io.OutputStream result)	Get the destination side transfer report from the destination and write it to the specified output stream.
void	init()
void	prepare(Transfer transfer)
void	sendContent(Transfer transfer, java.util.Set<org.alfresco.service.cmr.repository.ContentData> data)	Send the content of the specified urls
void	sendManifest(Transfer transfer, java.io.File manifest, java.io.OutputStream result)
void	setContentService(ContentService contentService)
void	setHttpClient(org.apache.commons.httpclient.HttpClient httpClient)	By default, this class uses a plain HttpClient instance with the only non-default option being the multi-threaded connection manager.
void	setHttpMethodFactory(HttpMethodFactory httpMethodFactory)
void	setHttpsSocketFactory(org.apache.commons.httpclient.protocol.ProtocolSocketFactory socketFactory)	By default this class uses the standard SSLProtocolSocketFactory, but this method allows this to be overridden.
void	setIsAuthenticationPreemptive(boolean isAuthenticationPreemptive)	Whether httpClient will use preemptive authentication or not.
void	setJsonErrorSerializer(JsonSerializer<java.lang.Throwable,org.json.JSONObject> jsonErrorSerializer)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	verifyTarget(TransferTarget target)	Verify that the target is available

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpClientTransmitterImpl

public HttpClientTransmitterImpl()

Method Detail

init

public void init()

setHttpsSocketFactory

public void setHttpsSocketFactory(org.apache.commons.httpclient.protocol.ProtocolSocketFactory socketFactory)

By default this class uses the standard SSLProtocolSocketFactory, but this method allows this to be overridden. Useful if, for example, one wishes to permit support of self-signed certificates on the target.

Parameters:

socketFactory - ProtocolSocketFactory

setHttpClient

public void setHttpClient(org.apache.commons.httpclient.HttpClient httpClient)

By default, this class uses a plain HttpClient instance with the only non-default option being the multi-threaded connection manager. Use this method to replace this with your own HttpClient instance configured how you wish

Parameters:

httpClient - HttpClient

setIsAuthenticationPreemptive

public void setIsAuthenticationPreemptive(boolean isAuthenticationPreemptive)

Whether httpClient will use preemptive authentication or not.

Parameters:

isAuthenticationPreemptive - boolean

verifyTarget

public void verifyTarget(TransferTarget target)
                  throws TransferException

Description copied from interface: TransferTransmitter

Verify that the target is available

Specified by:

verifyTarget in interface TransferTransmitter

Parameters:

target - TransferTarget

Throws:

TransferException

begin

public Transfer begin(TransferTarget target,
                      java.lang.String fromRepositoryId,
                      TransferVersion fromVersion)
               throws TransferException

Description copied from interface: TransferTransmitter

Begin a transfer, the transfer object returned will be used by subsequent calls to the transfer service.

Specified by:

begin in interface TransferTransmitter

Parameters:

target - definition of where to transfer to.

fromRepositoryId - the repositoryID of the sending system

fromVersion - the version of the repository sending

Returns:

the transfer object or null if the target cannot be locked.

Throws:

TransferException

sendManifest

public void sendManifest(Transfer transfer,
                         java.io.File manifest,
                         java.io.OutputStream result)
                  throws TransferException

Specified by:

sendManifest in interface TransferTransmitter

Parameters:

transfer - the transfer object returned by an earlier call to begin

manifest - the transfer manifest file

result - - where to write the results, probably a temporary file the output steam should be open and will be closed before the method returns.

Throws:

TransferException

abort

public void abort(Transfer transfer)
           throws TransferException

Description copied from interface: TransferTransmitter

Abort the transfer

Specified by:

abort in interface TransferTransmitter

Parameters:

transfer - the transfer object returned by an earlier call to begin

Throws:

TransferException

commit

public void commit(Transfer transfer)
            throws TransferException

Specified by:

commit in interface TransferTransmitter

Parameters:

transfer - the transfer object returned by an earlier call to begin

Throws:

TransferException

prepare

public void prepare(Transfer transfer)
             throws TransferException

Specified by:

prepare in interface TransferTransmitter

Parameters:

transfer - the transfer object returned by an earlier call to begin

Throws:

TransferException

sendContent

public void sendContent(Transfer transfer,
                        java.util.Set<org.alfresco.service.cmr.repository.ContentData> data)
                 throws TransferException

Description copied from interface: TransferTransmitter

Send the content of the specified urls

Specified by:

sendContent in interface TransferTransmitter

Parameters:

transfer - the transfer object returned by an earlier call to begin

data - the content to send

Throws:

TransferException

getStatus

public TransferProgress getStatus(Transfer transfer)
                           throws TransferException

Description copied from interface: TransferTransmitter

Get the status of an in process transfer

Specified by:

getStatus in interface TransferTransmitter

Throws:

TransferException

getTransferReport

public void getTransferReport(Transfer transfer,
                              java.io.OutputStream result)

Description copied from interface: TransferTransmitter

Get the destination side transfer report from the destination and write it to the specified output stream.

The result stream will be closed.

Specified by:

getTransferReport in interface TransferTransmitter

Parameters:

transfer - the transfer object returned by an earlier call to begin

result - - where to write the contents of the transfer report.

getPostMethod

protected org.apache.commons.httpclient.methods.PostMethod getPostMethod()

setContentService

public void setContentService(ContentService contentService)

getContentService

public ContentService getContentService()

setHttpMethodFactory

public void setHttpMethodFactory(HttpMethodFactory httpMethodFactory)

setJsonErrorSerializer

public void setJsonErrorSerializer(JsonSerializer<java.lang.Throwable,org.json.JSONObject> jsonErrorSerializer)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)