@Override
@Test
public void testRepresentation() throws Exception {
GetMethod getMethod =
executeGet(
getUriBuilder(PageResource.class).build(getWiki(), "Main", "WebHome").toString());
Assert.assertEquals(getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
Page page = (Page) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
Link link = getFirstLinkByRelation(page, Relations.OBJECTS);
Assert.assertNotNull(link);
getMethod = executeGet(link.getHref());
Assert.assertEquals(getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
Objects objects = (Objects) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
Assert.assertFalse(objects.getObjectSummaries().isEmpty());
for (ObjectSummary objectSummary : objects.getObjectSummaries()) {
link = getFirstLinkByRelation(objectSummary, Relations.OBJECT);
getMethod = executeGet(link.getHref());
Assert.assertEquals(
getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
Object object = (Object) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
checkLinks(objectSummary);
for (Property property : object.getProperties()) {
checkLinks(property);
}
}
}
public static Space createSpace(
ObjectFactory objectFactory, URI baseUri, String wikiName, String spaceName, Document home) {
Space space = objectFactory.createSpace();
space.setId(Utils.getSpaceId(wikiName, spaceName));
space.setWiki(wikiName);
space.setName(spaceName);
if (home != null) {
space.setHome(home.getPrefixedFullName());
space.setXwikiRelativeUrl(home.getURL("view"));
space.setXwikiAbsoluteUrl(home.getExternalURL("view"));
}
String pagesUri = uri(baseUri, PagesResource.class, wikiName, spaceName);
Link pagesLink = objectFactory.createLink();
pagesLink.setHref(pagesUri);
pagesLink.setRel(Relations.PAGES);
space.getLinks().add(pagesLink);
if (home != null) {
String homeUri = uri(baseUri, PageResource.class, wikiName, spaceName, home.getName());
Link homeLink = objectFactory.createLink();
homeLink.setHref(homeUri);
homeLink.setRel(Relations.HOME);
space.getLinks().add(homeLink);
}
String searchUri = uri(baseUri, SpaceSearchResource.class, wikiName, spaceName);
Link searchLink = objectFactory.createLink();
searchLink.setHref(searchUri);
searchLink.setRel(Relations.SEARCH);
space.getLinks().add(searchLink);
return space;
}
@Override
public Properties getObjectProperties(
String wikiName,
String spaceName,
String pageName,
String className,
Integer objectNumber,
Boolean withPrettyNames)
throws XWikiRestException {
try {
DocumentInfo documentInfo =
getDocumentInfo(wikiName, spaceName, pageName, null, null, true, false);
Document doc = documentInfo.getDocument();
com.xpn.xwiki.objects.BaseObject baseObject = getBaseObject(doc, className, objectNumber);
if (baseObject == null) {
throw new WebApplicationException(Status.NOT_FOUND);
}
Object object =
DomainObjectFactory.createObject(
objectFactory,
uriInfo.getBaseUri(),
Utils.getXWikiContext(componentManager),
doc,
baseObject,
false,
Utils.getXWikiApi(componentManager),
withPrettyNames);
Properties properties = objectFactory.createProperties();
properties.getProperties().addAll(object.getProperties());
String objectUri =
Utils.createURI(
uriInfo.getBaseUri(),
ObjectResource.class,
doc.getWiki(),
Utils.getSpacesFromSpaceId(doc.getSpace()),
doc.getName(),
object.getClassName(),
object.getNumber())
.toString();
Link objectLink = objectFactory.createLink();
objectLink.setHref(objectUri);
objectLink.setRel(Relations.OBJECT);
properties.getLinks().add(objectLink);
return properties;
} catch (XWikiException e) {
throw new XWikiRestException(e);
}
}
public static ObjectSummary createObjectSummary(
ObjectFactory objectFactory,
URI baseUri,
XWikiContext xwikiContext,
Document doc,
BaseObject xwikiObject,
boolean useVersion,
XWiki xwikiApi,
Boolean withPrettyNames)
throws XWikiException {
ObjectSummary objectSummary = objectFactory.createObjectSummary();
fillObjectSummary(
objectSummary, objectFactory, baseUri, doc, xwikiObject, xwikiApi, withPrettyNames);
Link objectLink =
getObjectLink(objectFactory, baseUri, doc, xwikiObject, useVersion, Relations.OBJECT);
objectSummary.getLinks().add(objectLink);
String propertiesUri;
if (useVersion) {
propertiesUri =
uri(
baseUri,
ObjectPropertiesAtPageVersionResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
doc.getVersion(),
xwikiObject.getClassName(),
xwikiObject.getNumber());
} else {
propertiesUri =
uri(
baseUri,
ObjectPropertiesResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
xwikiObject.getClassName(),
xwikiObject.getNumber());
}
Link propertyLink = objectFactory.createLink();
propertyLink.setHref(propertiesUri);
propertyLink.setRel(Relations.PROPERTIES);
objectSummary.getLinks().add(propertyLink);
return objectSummary;
}
public static Comment createComment(
ObjectFactory objectFactory,
URI baseUri,
Document doc,
com.xpn.xwiki.api.Object xwikiComment,
XWiki xwikiApi,
Boolean withPrettyNames) {
Comment comment = objectFactory.createComment();
comment.setId(xwikiComment.getNumber());
com.xpn.xwiki.api.Property property = xwikiComment.getProperty("author");
if (property != null) {
comment.setAuthor((String) property.getValue());
if (withPrettyNames) {
comment.setAuthorName(xwikiApi.getUserName((String) property.getValue(), false));
}
}
property = xwikiComment.getProperty("date");
if (property != null) {
Calendar calendar = Calendar.getInstance();
calendar.setTime((Date) property.getValue());
comment.setDate(calendar);
}
property = xwikiComment.getProperty("highlight");
if (property != null) {
comment.setHighlight((String) property.getValue());
}
property = xwikiComment.getProperty("comment");
if (property != null) {
comment.setText((String) property.getValue());
}
property = xwikiComment.getProperty("replyto");
if (property != null) {
comment.setReplyTo((Integer) property.getValue());
}
String pageUri = uri(baseUri, PageResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
Link pageLink = objectFactory.createLink();
pageLink.setHref(pageUri);
pageLink.setRel(Relations.PAGE);
comment.getLinks().add(pageLink);
return comment;
}
public static PageSummary createPageSummary(
ObjectFactory objectFactory,
URI baseUri,
Document doc,
XWiki xwikiApi,
Boolean withPrettyNames)
throws XWikiException {
PageSummary pageSummary = objectFactory.createPageSummary();
fillPageSummary(pageSummary, objectFactory, baseUri, doc, false, xwikiApi, withPrettyNames);
String pageUri = uri(baseUri, PageResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
Link pageLink = objectFactory.createLink();
pageLink.setHref(pageUri);
pageLink.setRel(Relations.PAGE);
pageSummary.getLinks().add(pageLink);
return pageSummary;
}
@GET
public Property getClassProperty(
@PathParam("wikiName") String wikiName,
@PathParam("className") String className,
@PathParam("propertyName") String propertyName)
throws XWikiException {
String database = Utils.getXWikiContext(componentManager).getDatabase();
try {
Utils.getXWikiContext(componentManager).setDatabase(wikiName);
com.xpn.xwiki.api.Class xwikiClass = Utils.getXWikiApi(componentManager).getClass(className);
if (xwikiClass == null) {
throw new WebApplicationException(Status.NOT_FOUND);
}
Class clazz =
DomainObjectFactory.createClass(
objectFactory, uriInfo.getBaseUri(), wikiName, xwikiClass);
for (Property property : clazz.getProperties()) {
if (property.getName().equals(propertyName)) {
String classUri =
UriBuilder.fromUri(uriInfo.getBaseUri())
.path(ClassResource.class)
.build(wikiName, xwikiClass.getName())
.toString();
Link classLink = objectFactory.createLink();
classLink.setHref(classUri);
classLink.setRel(Relations.CLASS);
property.getLinks().add(classLink);
return property;
}
}
throw new WebApplicationException(Status.NOT_FOUND);
} finally {
Utils.getXWiki(componentManager).setDatabase(database);
}
}
private Object getObject(String className) throws Exception {
GetMethod getMethod =
executeGet(
getUriBuilder(ObjectsResource.class).build(getWiki(), "Main", "WebHome").toString());
Assert.assertEquals(getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
Objects objects = (Objects) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
Assert.assertFalse(objects.getObjectSummaries().isEmpty());
for (ObjectSummary objectSummary : objects.getObjectSummaries()) {
if (objectSummary.getClassName().equals(className)) {
Link link = getFirstLinkByRelation(objectSummary, Relations.OBJECT);
Assert.assertNotNull(link);
getMethod = executeGet(link.getHref());
Assert.assertEquals(
getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
Object object = (Object) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
return object;
}
}
/* If no object of that class is found, then create a new one */
Object object = objectFactory.createObject();
object.setClassName(className);
PostMethod postMethod =
executePostXml(
getUriBuilder(ObjectsResource.class).build(getWiki(), "Main", "WebHome").toString(),
object,
"Admin",
"admin");
Assert.assertEquals(
getHttpMethodInfo(postMethod), HttpStatus.SC_CREATED, postMethod.getStatusCode());
object = (Object) unmarshaller.unmarshal(postMethod.getResponseBodyAsStream());
return object;
}
public static Attachment createAttachmentAtVersion(
ObjectFactory objectFactory,
URI baseUri,
com.xpn.xwiki.api.Attachment xwikiAttachment,
String xwikiRelativeUrl,
String xwikiAbsoluteUrl,
XWiki xwikiApi,
Boolean withPrettyNames) {
Attachment attachment = new Attachment();
fillAttachment(
attachment,
objectFactory,
baseUri,
xwikiAttachment,
xwikiRelativeUrl,
xwikiAbsoluteUrl,
xwikiApi,
withPrettyNames);
Document doc = xwikiAttachment.getDocument();
String attachmentUri =
uri(
baseUri,
AttachmentVersionResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
xwikiAttachment.getFilename(),
xwikiAttachment.getVersion());
Link attachmentLink = objectFactory.createLink();
attachmentLink.setHref(attachmentUri);
attachmentLink.setRel(Relations.ATTACHMENT_DATA);
attachment.getLinks().add(attachmentLink);
return attachment;
}
private static Link getObjectLink(
ObjectFactory objectFactory,
URI baseUri,
Document doc,
BaseObject xwikiObject,
boolean useVersion,
String relation) {
String objectUri;
if (useVersion) {
objectUri =
uri(
baseUri,
ObjectAtPageVersionResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
doc.getVersion(),
xwikiObject.getClassName(),
xwikiObject.getNumber());
} else {
objectUri =
uri(
baseUri,
ObjectResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
xwikiObject.getClassName(),
xwikiObject.getNumber());
}
Link objectLink = objectFactory.createLink();
objectLink.setHref(objectUri);
objectLink.setRel(relation);
return objectLink;
}
private static void fillAttachment(
Attachment attachment,
ObjectFactory objectFactory,
URI baseUri,
com.xpn.xwiki.api.Attachment xwikiAttachment,
String xwikiRelativeUrl,
String xwikiAbsoluteUrl,
XWiki xwikiApi,
Boolean withPrettyNames) {
Document doc = xwikiAttachment.getDocument();
attachment.setId(
String.format("%s@%s", doc.getPrefixedFullName(), xwikiAttachment.getFilename()));
attachment.setName(xwikiAttachment.getFilename());
attachment.setSize(xwikiAttachment.getFilesize());
attachment.setVersion(xwikiAttachment.getVersion());
attachment.setPageId(doc.getPrefixedFullName());
attachment.setPageVersion(doc.getVersion());
attachment.setMimeType(xwikiAttachment.getMimeType());
attachment.setAuthor(xwikiAttachment.getAuthor());
if (withPrettyNames) {
attachment.setAuthorName(xwikiApi.getUserName(xwikiAttachment.getAuthor(), false));
}
Calendar calendar = Calendar.getInstance();
calendar.setTime(xwikiAttachment.getDate());
attachment.setDate(calendar);
attachment.setXwikiRelativeUrl(xwikiRelativeUrl);
attachment.setXwikiAbsoluteUrl(xwikiAbsoluteUrl);
String pageUri = uri(baseUri, PageResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
Link pageLink = objectFactory.createLink();
pageLink.setHref(pageUri);
pageLink.setRel(Relations.PAGE);
attachment.getLinks().add(pageLink);
}
public static Page createPage(
ObjectFactory objectFactory,
URI baseUri,
URI self,
Document doc,
boolean useVersion,
XWiki xwikiApi,
Boolean withPrettyNames)
throws XWikiException {
Page page = objectFactory.createPage();
fillPageSummary(page, objectFactory, baseUri, doc, useVersion, xwikiApi, withPrettyNames);
page.setMajorVersion(doc.getRCSVersion().at(0));
page.setMinorVersion(doc.getRCSVersion().at(1));
page.setLanguage(doc.getLanguage());
page.setCreator(doc.getCreator());
if (withPrettyNames) {
page.setCreatorName(xwikiApi.getUserName(doc.getCreator(), false));
}
Calendar calendar = Calendar.getInstance();
calendar.setTime(doc.getCreationDate());
page.setCreated(calendar);
page.setModifier(doc.getContentAuthor());
if (withPrettyNames) {
page.setModifierName(xwikiApi.getUserName(doc.getContentAuthor(), false));
}
calendar = Calendar.getInstance();
calendar.setTime(doc.getContentUpdateDate());
page.setModified(calendar);
page.setComment(doc.getComment());
page.setContent(doc.getContent());
if (self != null) {
Link pageLink = objectFactory.createLink();
pageLink.setHref(self.toString());
pageLink.setRel(Relations.SELF);
page.getLinks().add(pageLink);
}
com.xpn.xwiki.api.Class xwikiClass = doc.getxWikiClass();
if (xwikiClass != null) {
String classUri = uri(baseUri, ClassResource.class, doc.getWiki(), xwikiClass.getName());
Link classLink = objectFactory.createLink();
classLink.setHref(classUri);
classLink.setRel(Relations.CLASS);
page.getLinks().add(classLink);
}
return page;
}
public static Xwiki createXWikiRoot(ObjectFactory objectFactory, URI baseUri, String version) {
Xwiki xwiki = objectFactory.createXwiki().withVersion(version);
String wikisUri = uri(baseUri, WikisResource.class);
Link wikisLink = objectFactory.createLink();
wikisLink.setHref(wikisUri);
wikisLink.setRel(Relations.WIKIS);
xwiki.getLinks().add(wikisLink);
String syntaxesUri = uri(baseUri, SyntaxesResource.class);
Link syntaxesLink = objectFactory.createLink();
syntaxesLink.setHref(syntaxesUri);
syntaxesLink.setRel(Relations.SYNTAXES);
xwiki.getLinks().add(syntaxesLink);
return xwiki;
}
@Override
public Property getObjectProperty(
String wikiName,
String spaceName,
String pageName,
String version,
String className,
Integer objectNumber,
String propertyName,
Boolean withPrettyNames)
throws XWikiRestException {
try {
DocumentInfo documentInfo =
getDocumentInfo(wikiName, spaceName, pageName, null, version, true, false);
Document doc = documentInfo.getDocument();
XWikiDocument xwikiDocument =
Utils.getXWiki(componentManager)
.getDocument(doc.getPrefixedFullName(), Utils.getXWikiContext(componentManager));
xwikiDocument =
Utils.getXWiki(componentManager)
.getDocument(
xwikiDocument, doc.getVersion(), Utils.getXWikiContext(componentManager));
com.xpn.xwiki.objects.BaseObject baseObject =
xwikiDocument.getObject(className, objectNumber);
if (baseObject == null) {
throw new WebApplicationException(Status.NOT_FOUND);
}
Object object =
DomainObjectFactory.createObject(
objectFactory,
uriInfo.getBaseUri(),
Utils.getXWikiContext(componentManager),
doc,
baseObject,
true,
Utils.getXWikiApi(componentManager),
withPrettyNames);
for (Property property : object.getProperties()) {
if (property.getName().equals(propertyName)) {
String objectUri =
Utils.createURI(
uriInfo.getBaseUri(),
ObjectAtPageVersionResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
version,
object.getClassName(),
object.getNumber())
.toString();
Link objectLink = objectFactory.createLink();
objectLink.setHref(objectUri);
objectLink.setRel(Relations.OBJECT);
property.getLinks().add(objectLink);
return property;
}
}
throw new WebApplicationException(Status.NOT_FOUND);
} catch (XWikiException e) {
throw new XWikiRestException(e);
}
}
public static Translations createTranslations(
ObjectFactory objectFactory, URI baseUri, Document doc) throws XWikiException {
Translations translations = objectFactory.createTranslations();
List<String> languages = doc.getTranslationList();
if (!languages.isEmpty()) {
if (!doc.getDefaultLanguage().equals("")) {
translations.setDefault(doc.getDefaultLanguage());
Translation translation = objectFactory.createTranslation();
translation.setLanguage(doc.getDefaultLanguage());
/* Add the default page with the default translation explicitely */
String pageTranslationUri =
uri(baseUri, PageResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
Link pageTranslationLink = objectFactory.createLink();
pageTranslationLink.setHref(pageTranslationUri);
pageTranslationLink.setRel(Relations.PAGE);
translation.getLinks().add(pageTranslationLink);
String historyUri =
uri(baseUri, PageHistoryResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
Link historyLink = objectFactory.createLink();
historyLink.setHref(historyUri);
historyLink.setRel(Relations.HISTORY);
translation.getLinks().add(historyLink);
translations.getTranslations().add(translation);
}
}
for (String language : languages) {
Translation translation = objectFactory.createTranslation();
translation.setLanguage(language);
String pageTranslationUri =
uri(
baseUri,
PageTranslationResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
language);
Link pageTranslationLink = objectFactory.createLink();
pageTranslationLink.setHref(pageTranslationUri);
pageTranslationLink.setRel(Relations.PAGE);
translation.getLinks().add(pageTranslationLink);
String historyUri =
uri(
baseUri,
PageTranslationHistoryResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
language);
Link historyLink = objectFactory.createLink();
historyLink.setHref(historyUri);
historyLink.setRel(Relations.HISTORY);
translation.getLinks().add(historyLink);
translations.getTranslations().add(translation);
}
return translations;
}
@Test
public void testPUTPropertyFormUrlEncoded() throws Exception {
final String TAG_VALUE = UUID.randomUUID().toString();
GetMethod getMethod =
executeGet(
getUriBuilder(PageResource.class).build(getWiki(), "Main", "WebHome").toString());
Assert.assertEquals(getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
Page page = (Page) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
Link link = getFirstLinkByRelation(page, Relations.OBJECTS);
Assert.assertNotNull(link);
getMethod = executeGet(link.getHref());
Assert.assertEquals(getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
Objects objects = (Objects) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
Assert.assertFalse(objects.getObjectSummaries().isEmpty());
Object currentObject = null;
for (ObjectSummary objectSummary : objects.getObjectSummaries()) {
if (objectSummary.getClassName().equals("XWiki.TagClass")) {
link = getFirstLinkByRelation(objectSummary, Relations.OBJECT);
Assert.assertNotNull(link);
getMethod = executeGet(link.getHref());
Assert.assertEquals(
getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
currentObject = (Object) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
break;
}
}
Assert.assertNotNull(currentObject);
Property tagsProperty = getProperty(currentObject, "tags");
Assert.assertNotNull(tagsProperty);
Link tagsPropertyLink = getFirstLinkByRelation(tagsProperty, Relations.SELF);
Assert.assertNotNull(tagsPropertyLink);
NameValuePair[] nameValuePairs = new NameValuePair[1];
nameValuePairs[0] = new NameValuePair("property#tags", TAG_VALUE);
PostMethod postMethod =
executePostForm(
String.format("%s?method=PUT", tagsPropertyLink.getHref()),
nameValuePairs,
"Admin",
"admin");
Assert.assertEquals(
getHttpMethodInfo(postMethod), HttpStatus.SC_ACCEPTED, postMethod.getStatusCode());
getMethod =
executeGet(
getUriBuilder(ObjectResource.class)
.build(
getWiki(),
"Main",
"WebHome",
currentObject.getClassName(),
currentObject.getNumber())
.toString());
Assert.assertEquals(HttpStatus.SC_OK, getMethod.getStatusCode());
currentObject = (Object) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
tagsProperty = getProperty(currentObject, "tags");
Assert.assertEquals(TAG_VALUE, tagsProperty.getValue());
}
@Test
public void testPUTPropertyWithTextPlain() throws Exception {
final String TAG_VALUE = UUID.randomUUID().toString();
/* Make sure that an Object with the TagClass exists. */
Object objectToBeUpdated = getObject("XWiki.TagClass");
GetMethod getMethod =
executeGet(
getUriBuilder(PageResource.class).build(getWiki(), "Main", "WebHome").toString());
Assert.assertEquals(getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
Page page = (Page) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
Link link = getFirstLinkByRelation(page, Relations.OBJECTS);
Assert.assertNotNull(link);
getMethod = executeGet(link.getHref());
Assert.assertEquals(getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
Objects objects = (Objects) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
Assert.assertFalse(objects.getObjectSummaries().isEmpty());
Object currentObject = null;
for (ObjectSummary objectSummary : objects.getObjectSummaries()) {
if (objectSummary.getClassName().equals("XWiki.TagClass")) {
link = getFirstLinkByRelation(objectSummary, Relations.OBJECT);
Assert.assertNotNull(link);
getMethod = executeGet(link.getHref());
Assert.assertEquals(
getHttpMethodInfo(getMethod), HttpStatus.SC_OK, getMethod.getStatusCode());
currentObject = (Object) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
break;
}
}
Assert.assertNotNull(currentObject);
Property tagsProperty = getProperty(currentObject, "tags");
Assert.assertNotNull(tagsProperty);
Link tagsPropertyLink = getFirstLinkByRelation(tagsProperty, Relations.SELF);
Assert.assertNotNull(tagsPropertyLink);
PutMethod putMethod =
executePut(tagsPropertyLink.getHref(), TAG_VALUE, MediaType.TEXT_PLAIN, "Admin", "admin");
Assert.assertEquals(
getHttpMethodInfo(putMethod), HttpStatus.SC_ACCEPTED, putMethod.getStatusCode());
getMethod =
executeGet(
getUriBuilder(ObjectResource.class)
.build(
getWiki(),
"Main",
"WebHome",
currentObject.getClassName(),
currentObject.getNumber())
.toString());
Assert.assertEquals(HttpStatus.SC_OK, getMethod.getStatusCode());
currentObject = (Object) unmarshaller.unmarshal(getMethod.getResponseBodyAsStream());
tagsProperty = getProperty(currentObject, "tags");
Assert.assertEquals(TAG_VALUE, tagsProperty.getValue());
}
/* This method is used to fill the "common part" of a Page and a PageSummary */
private static void fillPageSummary(
PageSummary pageSummary,
ObjectFactory objectFactory,
URI baseUri,
Document doc,
boolean useVersion,
XWiki xwikiApi,
Boolean withPrettyNames)
throws XWikiException {
pageSummary.setWiki(doc.getWiki());
pageSummary.setFullName(doc.getFullName());
pageSummary.setId(doc.getPrefixedFullName());
pageSummary.setSpace(doc.getSpace());
pageSummary.setName(doc.getName());
pageSummary.setTitle(doc.getDisplayTitle());
pageSummary.setXwikiRelativeUrl(doc.getURL("view"));
pageSummary.setXwikiAbsoluteUrl(doc.getExternalURL("view"));
pageSummary.setTranslations(createTranslations(objectFactory, baseUri, doc));
pageSummary.setSyntax(doc.getSyntaxId());
pageSummary.setVersion(doc.getVersion());
pageSummary.setAuthor(doc.getAuthor());
if (withPrettyNames) {
pageSummary.setAuthorName(xwikiApi.getUserName(doc.getAuthor(), false));
}
Document parent = Utils.getParentDocument(doc, xwikiApi);
pageSummary.setParent(doc.getParent());
// parentId must not be set if the parent document does not exist.
if (parent != null && !parent.isNew()) {
pageSummary.setParentId(parent.getPrefixedFullName());
} else {
pageSummary.setParentId("");
}
String spaceUri = uri(baseUri, SpaceResource.class, doc.getWiki(), doc.getSpace());
Link spaceLink = objectFactory.createLink();
spaceLink.setHref(spaceUri);
spaceLink.setRel(Relations.SPACE);
pageSummary.getLinks().add(spaceLink);
if (parent != null) {
String parentUri =
uri(baseUri, PageResource.class, parent.getWiki(), parent.getSpace(), parent.getName());
Link parentLink = objectFactory.createLink();
parentLink.setHref(parentUri);
parentLink.setRel(Relations.PARENT);
pageSummary.getLinks().add(parentLink);
}
String historyUri =
uri(baseUri, PageHistoryResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
Link historyLink = objectFactory.createLink();
historyLink.setHref(historyUri);
historyLink.setRel(Relations.HISTORY);
pageSummary.getLinks().add(historyLink);
if (!doc.getChildren().isEmpty()) {
String pageChildrenUri =
uri(baseUri, PageChildrenResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
Link pageChildrenLink = objectFactory.createLink();
pageChildrenLink.setHref(pageChildrenUri);
pageChildrenLink.setRel(Relations.CHILDREN);
pageSummary.getLinks().add(pageChildrenLink);
}
if (!doc.getComments().isEmpty()) {
String commentsUri;
if (useVersion) {
commentsUri =
uri(
baseUri,
CommentsVersionResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
doc.getVersion());
} else {
commentsUri =
uri(baseUri, CommentsResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
}
Link commentsLink = objectFactory.createLink();
commentsLink.setHref(commentsUri);
commentsLink.setRel(Relations.COMMENTS);
pageSummary.getLinks().add(commentsLink);
}
if (!doc.getAttachmentList().isEmpty()) {
String attachmentsUri;
if (useVersion) {
attachmentsUri =
uri(
baseUri,
AttachmentsAtPageVersionResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
doc.getVersion());
} else {
attachmentsUri =
uri(baseUri, AttachmentsResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
}
Link attachmentsLink = objectFactory.createLink();
attachmentsLink.setHref(attachmentsUri);
attachmentsLink.setRel(Relations.ATTACHMENTS);
pageSummary.getLinks().add(attachmentsLink);
}
if (!doc.getxWikiObjects().keySet().isEmpty()) {
String objectsUri;
if (useVersion) {
objectsUri =
uri(
baseUri,
ObjectsAtPageVersionResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
doc.getVersion());
} else {
objectsUri =
uri(baseUri, ObjectsResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
}
Link objectsLink = objectFactory.createLink();
objectsLink.setHref(objectsUri);
objectsLink.setRel(Relations.OBJECTS);
pageSummary.getLinks().add(objectsLink);
}
com.xpn.xwiki.api.Object tagsObject = doc.getObject("XWiki.TagClass", 0);
if (tagsObject != null) {
if (tagsObject.getProperty("tags") != null) {
String tagsUri =
uri(baseUri, PageTagsResource.class, doc.getWiki(), doc.getSpace(), doc.getName());
Link tagsLink = objectFactory.createLink();
tagsLink.setHref(tagsUri);
tagsLink.setRel(Relations.TAGS);
pageSummary.getLinks().add(tagsLink);
}
}
String syntaxesUri = uri(baseUri, SyntaxesResource.class);
Link syntaxesLink = objectFactory.createLink();
syntaxesLink.setHref(syntaxesUri);
syntaxesLink.setRel(Relations.SYNTAXES);
pageSummary.getLinks().add(syntaxesLink);
}
public static Class createClass(
ObjectFactory objectFactory,
URI baseUri,
String wikiName,
com.xpn.xwiki.api.Class xwikiClass) {
Class clazz = objectFactory.createClass();
clazz.setId(xwikiClass.getName());
clazz.setName(xwikiClass.getName());
for (java.lang.Object xwikiPropertyClassObject : xwikiClass.getProperties()) {
PropertyClass xwikiPropertyClass = (PropertyClass) xwikiPropertyClassObject;
Property property = objectFactory.createProperty();
property.setName(xwikiPropertyClass.getName());
property.setType(xwikiPropertyClass.getxWikiClass().getName());
for (java.lang.Object xwikiPropertyObject : xwikiPropertyClass.getProperties()) {
com.xpn.xwiki.api.Property xwikiProperty = (com.xpn.xwiki.api.Property) xwikiPropertyObject;
java.lang.Object value = xwikiProperty.getValue();
Attribute attribute = objectFactory.createAttribute();
attribute.setName(xwikiProperty.getName());
if (value != null) {
attribute.setValue(value.toString());
} else {
attribute.setValue("");
}
property.getAttributes().add(attribute);
}
String propertyUri =
uri(
baseUri,
ClassPropertyResource.class,
wikiName,
xwikiClass.getName(),
xwikiPropertyClass.getName());
Link propertyLink = objectFactory.createLink();
propertyLink.setHref(propertyUri);
propertyLink.setRel(Relations.SELF);
property.getLinks().add(propertyLink);
clazz.getProperties().add(property);
}
String classUri = uri(baseUri, ClassResource.class, wikiName, xwikiClass.getName());
Link classLink = objectFactory.createLink();
classLink.setHref(classUri);
classLink.setRel(Relations.SELF);
clazz.getLinks().add(classLink);
String propertiesUri =
uri(baseUri, ClassPropertiesResource.class, wikiName, xwikiClass.getName());
Link propertyLink = objectFactory.createLink();
propertyLink.setHref(propertiesUri);
propertyLink.setRel(Relations.PROPERTIES);
clazz.getLinks().add(propertyLink);
String objectsUri =
uri(baseUri, AllObjectsForClassNameResource.class, wikiName, xwikiClass.getName());
Link objectsLink = objectFactory.createLink();
objectsLink.setHref(objectsUri);
objectsLink.setRel(Relations.OBJECTS);
clazz.getLinks().add(objectsLink);
return clazz;
}
public static Object createObject(
ObjectFactory objectFactory,
URI baseUri,
XWikiContext xwikiContext,
Document doc,
BaseObject xwikiObject,
boolean useVersion,
XWiki xwikiApi,
Boolean withPrettyNames)
throws XWikiException {
Object object = objectFactory.createObject();
fillObjectSummary(object, objectFactory, baseUri, doc, xwikiObject, xwikiApi, withPrettyNames);
BaseClass xwikiClass = xwikiObject.getXClass(xwikiContext);
for (java.lang.Object propertyClassObject : xwikiClass.getProperties()) {
com.xpn.xwiki.objects.classes.PropertyClass propertyClass =
(com.xpn.xwiki.objects.classes.PropertyClass) propertyClassObject;
Property property = objectFactory.createProperty();
for (java.lang.Object o : propertyClass.getProperties()) {
BaseProperty baseProperty = (BaseProperty) o;
Attribute attribute = objectFactory.createAttribute();
attribute.setName(baseProperty.getName());
/* Check for null values in order to prevent NPEs */
if (baseProperty.getValue() != null) {
attribute.setValue(baseProperty.getValue().toString());
} else {
attribute.setValue("");
}
property.getAttributes().add(attribute);
}
if (propertyClass instanceof ListClass) {
ListClass listClass = (ListClass) propertyClass;
List allowedValueList = listClass.getList(xwikiContext);
if (!allowedValueList.isEmpty()) {
Formatter f = new Formatter();
for (int i = 0; i < allowedValueList.size(); i++) {
if (i != allowedValueList.size() - 1) {
f.format("%s,", allowedValueList.get(i).toString());
} else {
f.format("%s", allowedValueList.get(i).toString());
}
}
Attribute attribute = objectFactory.createAttribute();
attribute.setName(Constants.ALLOWED_VALUES_ATTRIBUTE_NAME);
attribute.setValue(f.toString());
property.getAttributes().add(attribute);
}
}
property.setName(propertyClass.getName());
property.setType(propertyClass.getClassType());
if (xwikiObject.get(propertyClass.getName()) != null) {
property.setValue(xwikiObject.get(propertyClass.getName()).toFormString());
} else {
property.setValue("");
}
String propertyUri;
if (useVersion) {
propertyUri =
uri(
baseUri,
ObjectPropertyAtPageVersionResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
doc.getVersion(),
xwikiObject.getClassName(),
xwikiObject.getNumber(),
propertyClass.getName());
} else {
propertyUri =
uri(
baseUri,
ObjectPropertyResource.class,
doc.getWiki(),
doc.getSpace(),
doc.getName(),
xwikiObject.getClassName(),
xwikiObject.getNumber(),
propertyClass.getName());
}
Link propertyLink = objectFactory.createLink();
propertyLink.setHref(propertyUri);
propertyLink.setRel(Relations.SELF);
property.getLinks().add(propertyLink);
object.getProperties().add(property);
}
Link objectLink =
getObjectLink(objectFactory, baseUri, doc, xwikiObject, useVersion, Relations.SELF);
object.getLinks().add(objectLink);
return object;
}
public static Wiki createWiki(ObjectFactory objectFactory, URI baseUri, String wikiName) {
Wiki wiki = objectFactory.createWiki().withId(wikiName).withName(wikiName);
String spacesUri = uri(baseUri, SpacesResource.class, wikiName);
Link spacesLink = objectFactory.createLink();
spacesLink.setHref(spacesUri);
spacesLink.setRel(Relations.SPACES);
wiki.getLinks().add(spacesLink);
String classesUri = uri(baseUri, ClassesResource.class, wikiName);
Link classesLink = objectFactory.createLink();
classesLink.setHref(classesUri);
classesLink.setRel(Relations.CLASSES);
wiki.getLinks().add(classesLink);
String modificationsUri = uri(baseUri, ModificationsResource.class, wikiName);
Link modificationsLink = objectFactory.createLink();
modificationsLink.setHref(modificationsUri);
modificationsLink.setRel(Relations.MODIFICATIONS);
wiki.getLinks().add(modificationsLink);
String searchUri = uri(baseUri, WikiSearchResource.class, wikiName);
Link searchLink = objectFactory.createLink();
searchLink.setHref(searchUri);
searchLink.setRel(Relations.SEARCH);
wiki.getLinks().add(searchLink);
String queryUri = uri(baseUri, WikiSearchQueryResource.class, wikiName);
Link queryLink = objectFactory.createLink();
queryLink.setHref(queryUri);
queryLink.setRel(Relations.QUERY);
wiki.getLinks().add(queryLink);
return wiki;
}
public static HistorySummary createHistorySummary(
ObjectFactory objectFactory,
URI baseUri,
String wikiName,
String spaceName,
String pageName,
String language,
Version version,
String modifier,
Date modified,
String comment,
XWiki xwikiApi,
Boolean withPrettyNames) {
HistorySummary historySummary = objectFactory.createHistorySummary();
String pageId = Utils.getPageId(wikiName, spaceName, pageName);
historySummary.setPageId(pageId);
historySummary.setWiki(wikiName);
historySummary.setSpace(spaceName);
historySummary.setName(pageName);
historySummary.setVersion(version.toString());
historySummary.setMajorVersion(version.at(0));
historySummary.setMinorVersion(version.at(1));
historySummary.setComment(comment);
historySummary.setModifier(modifier);
if (withPrettyNames) {
historySummary.setModifierName(xwikiApi.getUserName(modifier, false));
}
historySummary.setLanguage(language);
Calendar calendar = Calendar.getInstance();
calendar.setTime(modified);
historySummary.setModified(calendar);
if (language == null) {
String pageUri =
uri(baseUri, PageVersionResource.class, wikiName, spaceName, pageName, version);
Link pageLink = objectFactory.createLink();
pageLink.setHref(pageUri);
pageLink.setRel(Relations.PAGE);
historySummary.getLinks().add(pageLink);
} else {
String pageUri =
uri(
baseUri,
PageTranslationVersionResource.class,
wikiName,
spaceName,
pageName,
language,
version);
Link pageLink = objectFactory.createLink();
pageLink.setHref(pageUri);
pageLink.setRel(Relations.PAGE);
historySummary.getLinks().add(pageLink);
}
return historySummary;
}
