org.exoplatform.wiki.service.impl
Class WikiRestServiceImpl

java.lang.Object
  org.exoplatform.wiki.service.impl.WikiRestServiceImpl

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer, WikiRestService

public class WikiRestServiceImpl
extends Object
implements WikiRestService, org.exoplatform.services.rest.resource.ResourceContainer

Created by The eXo Platform SAS Author : viet nguyen viet.nguyen@exoplatform.com Jun 20, 2010

Constructor Summary

WikiRestServiceImpl(WikiService wikiService, org.exoplatform.wiki.rendering.RenderingService renderingService)

Method Summary

Attachment	createAttachment(ObjectFactory objectFactory, URI baseUri, AttachmentImpl pageAttachment, String xwikiRelativeUrl, String xwikiAbsoluteUrl)
Page	createPage(ObjectFactory objectFactory, URI baseUri, URI self, PageImpl doc)
PageSummary	createPageSummary(ObjectFactory objectFactory, URI baseUri, PageImpl doc)
Space	createSpace(ObjectFactory objectFactory, URI baseUri, String wikiName, String spaceName, Page home)
Attachments	getAttachments(javax.ws.rs.core.UriInfo uriInfo, String wikiType, String wikiOwner, String pageId, Integer start, Integer number)
javax.ws.rs.core.Response	getHelpSyntaxPage(String syntaxId, String portalUrl) Return the help syntax page.
javax.ws.rs.core.Response	getImage(javax.ws.rs.core.UriInfo uriInfo, String wikiType, String wikiOwner, String pageId, String imageId, Integer width)
Spaces	getLastVisitedSpaces(javax.ws.rs.core.UriInfo uriInfo, Integer offset, Integer limit)
Page	getPage(javax.ws.rs.core.UriInfo uriInfo, String wikiType, String wikiOwner, String pageId)
Pages	getPages(javax.ws.rs.core.UriInfo uriInfo, String wikiType, String wikiOwner, Integer start, Integer number, String parentFilterExpression)
javax.ws.rs.core.Response	getRelated(String path)
Space	getSpace(javax.ws.rs.core.UriInfo uriInfo, String wikiType, String wikiOwner)
Spaces	getSpaces(javax.ws.rs.core.UriInfo uriInfo, String wikiType, Integer start, Integer number)
javax.ws.rs.core.Response	getTreeData(String type, String path, String currentPath, Boolean showExcerpt, String depth)
javax.ws.rs.core.Response	getWikiPageContent(String sessionKey, String wikiContextKey, boolean isMarkup, String data)
javax.ws.rs.core.Response	removeDraft(String draftName) Remove the draft
javax.ws.rs.core.Response	saveDraft(String wikiType, String wikiOwner, String pageId, String pageRevision, String lastDraftName, boolean isNewPage, long clientTime, String title, String content, String isMarkup) Save draft title and content for a page specified by the given page params
javax.ws.rs.core.Response	searchAccessibleSpaces(String keyword)
javax.ws.rs.core.Response	searchData(String keyword, String wikiType, String wikiOwner)
javax.ws.rs.core.Response	upload(String wikiType, String wikiOwner, String pageId)

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiRestServiceImpl

public WikiRestServiceImpl(WikiService wikiService,
                           org.exoplatform.wiki.rendering.RenderingService renderingService)

Method Detail

getWikiPageContent

public javax.ws.rs.core.Response getWikiPageContent(String sessionKey,
                                                    String wikiContextKey,
                                                    boolean isMarkup,
                                                    String data)

Specified by:

getWikiPageContent in interface WikiRestService

Parameters:

sessionKey - key is used to retrieve the editor input value from the session.

isMarkup - if true then markup content is returned else html content is returned

Returns:

the instance of javax.ws.rs.core.Response

upload

public javax.ws.rs.core.Response upload(String wikiType,
                                        String wikiOwner,
                                        String pageId)

getTreeData

public javax.ws.rs.core.Response getTreeData(String type,
                                             String path,
                                             String currentPath,
                                             Boolean showExcerpt,
                                             String depth)

getRelated

public javax.ws.rs.core.Response getRelated(String path)

getSpaces

public Spaces getSpaces(@Context
                        javax.ws.rs.core.UriInfo uriInfo,
                        String wikiType,
                        Integer start,
                        Integer number)

getLastVisitedSpaces

public Spaces getLastVisitedSpaces(@Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   Integer offset,
                                   Integer limit)

getSpace

public Space getSpace(@Context
                      javax.ws.rs.core.UriInfo uriInfo,
                      String wikiType,
                      String wikiOwner)

getPages

public Pages getPages(@Context
                      javax.ws.rs.core.UriInfo uriInfo,
                      String wikiType,
                      String wikiOwner,
                      Integer start,
                      Integer number,
                      String parentFilterExpression)

getPage

public Page getPage(@Context
                    javax.ws.rs.core.UriInfo uriInfo,
                    String wikiType,
                    String wikiOwner,
                    String pageId)

getAttachments

public Attachments getAttachments(@Context
                                  javax.ws.rs.core.UriInfo uriInfo,
                                  String wikiType,
                                  String wikiOwner,
                                  String pageId,
                                  Integer start,
                                  Integer number)

searchData

public javax.ws.rs.core.Response searchData(String keyword,
                                            String wikiType,
                                            String wikiOwner)
                                     throws Exception

Throws:

Exception

getImage

public javax.ws.rs.core.Response getImage(@Context
                                          javax.ws.rs.core.UriInfo uriInfo,
                                          String wikiType,
                                          String wikiOwner,
                                          String pageId,
                                          String imageId,
                                          Integer width)

createSpace

public Space createSpace(ObjectFactory objectFactory,
                         URI baseUri,
                         String wikiName,
                         String spaceName,
                         Page home)

createPage

public Page createPage(ObjectFactory objectFactory,
                       URI baseUri,
                       URI self,
                       PageImpl doc)
                throws Exception

Throws:

Exception

createPageSummary

public PageSummary createPageSummary(ObjectFactory objectFactory,
                                     URI baseUri,
                                     PageImpl doc)
                              throws IllegalArgumentException,
                                     javax.ws.rs.core.UriBuilderException,
                                     Exception

Throws:

IllegalArgumentException

javax.ws.rs.core.UriBuilderException

Exception

createAttachment

public Attachment createAttachment(ObjectFactory objectFactory,
                                   URI baseUri,
                                   AttachmentImpl pageAttachment,
                                   String xwikiRelativeUrl,
                                   String xwikiAbsoluteUrl)
                            throws Exception

Throws:

Exception

getHelpSyntaxPage

public javax.ws.rs.core.Response getHelpSyntaxPage(String syntaxId,
                                                   String portalUrl)

Return the help syntax page. The syntax id have to replaced all special characters: Character '/' have to replace to "SLASH" Character '.' have to replace to "DOT" Sample: "confluence/1.0" will be replaced to "confluenceSLASH1DOT0"

Parameters:

syntaxId - The id of syntax to show in help page

portalUrl - The current portal url

Returns:

The response that contains help page

searchAccessibleSpaces

public javax.ws.rs.core.Response searchAccessibleSpaces(String keyword)

saveDraft

public javax.ws.rs.core.Response saveDraft(String wikiType,
                                           String wikiOwner,
                                           String pageId,
                                           String pageRevision,
                                           String lastDraftName,
                                           boolean isNewPage,
                                           long clientTime,
                                           String title,
                                           String content,
                                           String isMarkup)

Save draft title and content for a page specified by the given page params

Parameters:

wikiType - type of wiki to save draft

wikiOwner - owner of wiki to save draft

pageId - name of page to save draft

pageRevision - the target revision of target page

lastDraftName - name of the draft page of last saved draft request

isNewPage - The draft for new page or not

title - draft title

content - draft content

isMarkup - content is markup or html. True if is markup.

Returns:

Response with status HTTPStatus.ACCEPTED if saving process is performed successfully with status HTTPStatus.INTERNAL_ERROR if there is any unknown error in the saving process

removeDraft

public javax.ws.rs.core.Response removeDraft(String draftName)

Remove the draft

Parameters:

draftName - The name of draft to remove

Returns:

Status.OK if remove draft success HTTPStatus.INTERNAL_ERROR if there's error occur when remove draft