com.atlassian.confluence.rest.client

Class RemoteAttachmentServiceImpl

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<AttachmentService>

com.atlassian.confluence.rest.client.RemoteAttachmentServiceImpl

All Implemented Interfaces:

RemoteAttachmentService

public class RemoteAttachmentServiceImpl
extends AbstractRemoteService<AttachmentService>
implements RemoteAttachmentService

AttachmentService implementation that communicates with Confluence remotely using the Confluence REST api

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RemoteAttachmentServiceImpl.RemoteAttachmentFinderImpl

Nested classes/interfaces inherited from interface com.atlassian.confluence.rest.client.RemoteAttachmentService

RemoteAttachmentService.RemoteAttachmentFinder

Field Summary

Fields inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

provider

Constructor Summary

Constructors

Constructor and Description
RemoteAttachmentServiceImpl(AuthenticatedWebResourceProvider provider, com.google.common.util.concurrent.ListeningExecutorService executor)

Method Summary

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<PageResponse<Content>>	addAttachments(ContentId contentId, Collection<AttachmentUpload> uploads) Deprecated. since 7.0.1. Use addAttachmentsCompletionStage(ContentId, Collection) instead.
com.atlassian.util.concurrent.Promise<PageResponse<Content>>	addAttachments(ContentId contentId, ContentStatus status, Collection<AttachmentUpload> uploads) Deprecated. since 7.0.1. Use addAttachmentsCompletionStage(ContentId, ContentStatus, Collection) instead.
com.atlassian.util.concurrent.Promise<PageResponse<Content>>	addAttachments(ContentId containerId, ContentStatus containerStatus, Collection<AttachmentUpload> uploads, boolean allowDuplicated, Expansions expansions) Deprecated. since 7.0.1. Use addAttachmentsCompletionStage(ContentId, ContentStatus, Collection, boolean, Expansions) instead.
CompletionStage<PageResponse<Content>>	addAttachmentsCompletionStage(ContentId contentId, Collection<AttachmentUpload> uploads) Add one or more attachments to a piece of Content.
CompletionStage<PageResponse<Content>>	addAttachmentsCompletionStage(ContentId contentId, ContentStatus status, Collection<AttachmentUpload> uploads)
CompletionStage<PageResponse<Content>>	addAttachmentsCompletionStage(ContentId containerId, ContentStatus containerStatus, Collection<AttachmentUpload> uploads, boolean allowDuplicated, Expansions expansions)
com.atlassian.util.concurrent.Promise<Void>	delete(Content attachmentContent) Deprecated. since 7.0.1. Use deleteCompletionStage(Content) instead.
CompletionStage<Void>	deleteCompletionStage(Content attachmentContent) Removes an Attachment from the system.
RemoteAttachmentService.RemoteAttachmentFinder	find(Expansion... expansions)
com.atlassian.util.concurrent.Promise<Content>	update(Content attachment) Deprecated. since 7.0.1. Use updateCompletionStage(Content) instead.
CompletionStage<Content>	updateCompletionStage(Content attachment) Updates the non-data parts of an Attachment Content instance.
com.atlassian.util.concurrent.Promise<Content>	updateData(ContentId attachmentId, AttachmentUpload upload) Deprecated. since 7.0.1. Use updateDataCompletionStage(ContentId, AttachmentUpload) instead.
CompletionStage<Content>	updateDataCompletionStage(ContentId attachmentId, AttachmentUpload upload) Updates the data part of an Attachment Content instance.
AttachmentService.Validator	validator() Remote validation not supported

Methods inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

addExpansions, addPageRequest, addPageRequestParams, deleteCompletionStage, deleteCompletionStage, deleteFuture, deleteFuture, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postFuture, postFuture, postFuture, postFutureToPageResponse, putCompletionStage, putFuture

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteAttachmentServiceImpl

public RemoteAttachmentServiceImpl(AuthenticatedWebResourceProvider provider,
                                   com.google.common.util.concurrent.ListeningExecutorService executor)

Method Detail

addAttachments

@Deprecated
public com.atlassian.util.concurrent.Promise<PageResponse<Content>> addAttachments(ContentId contentId,
                                                                                               Collection<AttachmentUpload> uploads)
                                                                                        throws ServiceException

Deprecated. since 7.0.1. Use addAttachmentsCompletionStage(ContentId, Collection) instead.

Specified by:

addAttachments in interface RemoteAttachmentService

Throws:

ServiceException

addAttachments

@Deprecated
public com.atlassian.util.concurrent.Promise<PageResponse<Content>> addAttachments(ContentId contentId,
                                                                                               ContentStatus status,
                                                                                               Collection<AttachmentUpload> uploads)
                                                                                        throws ServiceException

Deprecated. since 7.0.1. Use addAttachmentsCompletionStage(ContentId, ContentStatus, Collection) instead.

Specified by:

addAttachments in interface RemoteAttachmentService

Throws:

ServiceException

addAttachments

@Deprecated
public com.atlassian.util.concurrent.Promise<PageResponse<Content>> addAttachments(ContentId containerId,
                                                                                               ContentStatus containerStatus,
                                                                                               Collection<AttachmentUpload> uploads,
                                                                                               boolean allowDuplicated,
                                                                                               Expansions expansions)
                                                                                        throws ServiceException

Deprecated. since 7.0.1. Use addAttachmentsCompletionStage(ContentId, ContentStatus, Collection, boolean, Expansions) instead.

Specified by:

addAttachments in interface RemoteAttachmentService

Throws:

ServiceException

addAttachmentsCompletionStage

public CompletionStage<PageResponse<Content>> addAttachmentsCompletionStage(ContentId contentId,
                                                                            Collection<AttachmentUpload> uploads)
                                                                     throws ServiceException

Description copied from interface: RemoteAttachmentService

Add one or more attachments to a piece of Content.

Specified by:

addAttachmentsCompletionStage in interface RemoteAttachmentService

Parameters:

contentId - the id of the content to attach to

uploads - the attachments being uploaded

Returns:

the attachments added

Throws:

ServiceException

addAttachmentsCompletionStage

public CompletionStage<PageResponse<Content>> addAttachmentsCompletionStage(ContentId contentId,
                                                                            ContentStatus status,
                                                                            Collection<AttachmentUpload> uploads)
                                                                     throws ServiceException

Specified by:

addAttachmentsCompletionStage in interface RemoteAttachmentService

Throws:

ServiceException

addAttachmentsCompletionStage

public CompletionStage<PageResponse<Content>> addAttachmentsCompletionStage(ContentId containerId,
                                                                            ContentStatus containerStatus,
                                                                            Collection<AttachmentUpload> uploads,
                                                                            boolean allowDuplicated,
                                                                            Expansions expansions)
                                                                     throws ServiceException

Specified by:

addAttachmentsCompletionStage in interface RemoteAttachmentService

Throws:

ServiceException

find

public RemoteAttachmentService.RemoteAttachmentFinder find(Expansion... expansions)

Specified by:

find in interface RemoteAttachmentService

update

@Deprecated
public com.atlassian.util.concurrent.Promise<Content> update(Content attachment)
                                                                  throws ServiceException

Deprecated. since 7.0.1. Use updateCompletionStage(Content) instead.

Description copied from interface: RemoteAttachmentService

Updates the non-data parts of an Attachment Content instance.

This method can be used to update the container, filename, media-type and comment of an Attachment.

Specified by:

update in interface RemoteAttachmentService

Parameters:

attachment - the attachment to update, must include an id

Returns:

the updated attachment as stored in the database

Throws:

ServiceException

updateData

@Deprecated
public com.atlassian.util.concurrent.Promise<Content> updateData(ContentId attachmentId,
                                                                             AttachmentUpload upload)
                                                                      throws ServiceException

Deprecated. since 7.0.1. Use updateDataCompletionStage(ContentId, AttachmentUpload) instead.

Description copied from interface: RemoteAttachmentService

Updates the data part of an Attachment Content instance.

Specified by:

updateData in interface RemoteAttachmentService

Parameters:

attachmentId - the id of the attachment to update

upload - the new content of the Attachment

Returns:

the updated attachment as stored in the database

Throws:

ServiceException

delete

@Deprecated
public com.atlassian.util.concurrent.Promise<Void> delete(Content attachmentContent)
                                                               throws ServiceException

Deprecated. since 7.0.1. Use deleteCompletionStage(Content) instead.

Description copied from interface: RemoteAttachmentService

Removes an Attachment from the system.

Specified by:

delete in interface RemoteAttachmentService

Parameters:

attachmentContent - the content to remove

Throws:

ServiceException - if the content cannot be found, or cannot be deleted

updateCompletionStage

public CompletionStage<Content> updateCompletionStage(Content attachment)
                                               throws ServiceException

Description copied from interface: RemoteAttachmentService

Updates the non-data parts of an Attachment Content instance.

This method can be used to update the container, filename, media-type and comment of an Attachment.

Specified by:

updateCompletionStage in interface RemoteAttachmentService

Parameters:

attachment - the attachment to update, must include an id

Returns:

the updated attachment as stored in the database

Throws:

ServiceException

updateDataCompletionStage

public CompletionStage<Content> updateDataCompletionStage(ContentId attachmentId,
                                                          AttachmentUpload upload)
                                                   throws ServiceException

Description copied from interface: RemoteAttachmentService

Updates the data part of an Attachment Content instance.

Specified by:

updateDataCompletionStage in interface RemoteAttachmentService

Parameters:

attachmentId - the id of the attachment to update

upload - the new content of the Attachment

Returns:

the updated attachment as stored in the database

Throws:

ServiceException

deleteCompletionStage

public CompletionStage<Void> deleteCompletionStage(Content attachmentContent)
                                            throws ServiceException

Description copied from interface: RemoteAttachmentService

Removes an Attachment from the system.

Specified by:

deleteCompletionStage in interface RemoteAttachmentService

Parameters:

attachmentContent - the content to remove

Throws:

ServiceException - if the content cannot be found, or cannot be deleted

validator

public AttachmentService.Validator validator()

Remote validation not supported

Throws:

UnsupportedOperationException