Package 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	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	Description
RemoteAttachmentServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)

Method Summary

Modifier and Type	Method	Description
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)
CompletionStage<PageResponse<Content>>	addAttachmentsCompletionStage(ContentId contentId, Collection<AttachmentUpload> uploads)	Add one or more attachments to a piece of Content.
CompletionStage<Void>	deleteCompletionStage(Content attachmentContent)	Removes an Attachment from the system.
RemoteAttachmentService.RemoteAttachmentFinder	find(Expansion... expansions)
CompletionStage<Void>	moveAttachmentCompletionStage(ContentId contentId, ContentId attachmentId, ContentId newContentId)	Moves an Attachment from a page to new page.
CompletionStage<Void>	moveAttachmentCompletionStage(ContentId contentId, ContentId attachmentId, ContentId newContentId, String newName)	Moves an Attachment from a page to new page and also rename it.
CompletionStage<Void>	removeAttachmentCompletionStage(ContentId contentId, ContentId attachmentId)	Trashes an attachment associated with an attachmentId.
CompletionStage<Void>	removeAttachmentVersionCompletionStage(ContentId contentId, ContentId attachmentId, int version)	Removes a specific version of an attachment associated with given content.
CompletionStage<Content>	updateCompletionStage(Content attachment)	Updates the non-data parts of an Attachment Content instance.
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, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfGenericListResponse, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, newExperimentalRestWebTarget, newWebTarget, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postVoidCompletionStage, putCompletionStage, putVoidCompletionStage

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteAttachmentServiceImpl

public RemoteAttachmentServiceImpl(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Since:

9.0

Method Details

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

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

moveAttachmentCompletionStage

public CompletionStage<Void> moveAttachmentCompletionStage(ContentId contentId,
 ContentId attachmentId,
 ContentId newContentId)
                                                    throws ServiceException

Description copied from interface: RemoteAttachmentService

Moves an Attachment from a page to new page.

Specified by:

moveAttachmentCompletionStage in interface RemoteAttachmentService

attachmentId - the attachment that should be moved.

newContentId - the id of the new page attachment should be on.

Throws:

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

moveAttachmentCompletionStage

public CompletionStage<Void> moveAttachmentCompletionStage(ContentId contentId,
 ContentId attachmentId,
 ContentId newContentId,
 String newName)
                                                    throws ServiceException

Description copied from interface: RemoteAttachmentService

Moves an Attachment from a page to new page and also rename it.

Specified by:

moveAttachmentCompletionStage in interface RemoteAttachmentService

attachmentId - the attachment that should be moved.

newContentId - the id of the new page attachment should be on.

newName - the new name for the attachment if required.

Throws:

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

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

removeAttachmentCompletionStage

public CompletionStage<Void> removeAttachmentCompletionStage(ContentId contentId,
 ContentId attachmentId)
                                                      throws ServiceException

Description copied from interface: RemoteAttachmentService

Trashes an attachment associated with an attachmentId.

Specified by:

removeAttachmentCompletionStage in interface RemoteAttachmentService

Parameters:

contentId - the id of the container/page to which attachment belongs

attachmentId - the id of the attachment to trash

Throws:

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

removeAttachmentVersionCompletionStage

public CompletionStage<Void> removeAttachmentVersionCompletionStage(ContentId contentId,
 ContentId attachmentId,
 int version)

Description copied from interface: RemoteAttachmentService

Removes a specific version of an attachment associated with given content.

Specified by:

removeAttachmentVersionCompletionStage in interface RemoteAttachmentService

Parameters:

contentId - The id of the content to which the attachment belongs.

attachmentId - The id of the attachment to be removed.

version - The version of the attachment to be removed.

Returns:

a completion stage that, when completed, signifies that the attachment version has been successfully removed.

validator

public AttachmentService.Validator validator()

Remote validation not supported

Throws:

UnsupportedOperationException