com.atlassian.confluence.plugins.rest.manager
Interface RestAttachmentManager

All Known Implementing Classes:
DefaultRestAttachmentManager

public interface RestAttachmentManager

Responsible for managing AttachmentEntity objects. This manager responsible for conversion from Confluence's API objects (eg Attachment, to a REST level AttachmentEntity. It also checks if user has permissions to view the attachments.


Method Summary
 AttachmentEntity convertToAttachmentEntity(Attachment attachment)
          Convert a Confluence model object into its REST representation.
 AttachmentEntityList createAttachmentEntityListForContent(ContentEntityObject object)
          Create a AttachmentEntityList object for the given ContentEntityObject
 AttachmentEntity getAttachmentEntity(Long attachmentId)
          Gets the AttachmentEntity object for the given id.
 

Method Detail

getAttachmentEntity

AttachmentEntity getAttachmentEntity(Long attachmentId)
Gets the AttachmentEntity object for the given id. A convenience method that packages up retrieving the Confluence attachment and converting it to a REST object. null is returned if the current user is not permitted to view the attachment or if no attachment object can be found for the given id

Parameters:
attachmentId - the id of the attahcment to retrieve
Returns:
the converted attachment object or null if not permitted or doesn't exist

convertToAttachmentEntity

AttachmentEntity convertToAttachmentEntity(Attachment attachment)
Convert a Confluence model object into its REST representation.

Parameters:
attachment -
Returns:
the equivalent unexpanded ContentEntity

createAttachmentEntityListForContent

AttachmentEntityList createAttachmentEntityListForContent(ContentEntityObject object)
Create a AttachmentEntityList object for the given ContentEntityObject

Parameters:
object -
Returns:


Copyright © 2003-2011 Atlassian. All Rights Reserved.