rhbz831894 - Refactor REST namespaces.

Refactor namespaces used for REST endpoints to prepare for a better strctured API version while keeping backwards compatibility.
zanata · Aug 7, 2012 · 3c29d35 · 3c29d35
1 parent 92f42ee
commit 3c29d35
Show file tree

Hide file tree

Showing 22 changed files with 92 additions and 53 deletions.
diff --git a/zanata-common-api/src/main/java/org/zanata/common/Namespaces.java b/zanata-common-api/src/main/java/org/zanata/common/Namespaces.java
@@ -5,6 +5,7 @@ public final class Namespaces
 
    public static final String ZANATA_PREFIX = "z";
    public static final String ZANATA_API = "http://zanata.org/namespace/api/";
+   public static final String ZANATA_OLD = "";
    public static final String COMMENT = ZANATA_API + "comment/";
    public static final String GETTEXT = ZANATA_API + "gettext/";
    public static final String ZANATA_CONFIG = "http://zanata.org/namespace/config/";

diff --git a/zanata-common-api/src/main/java/org/zanata/common/package-info.java b/zanata-common-api/src/main/java/org/zanata/common/package-info.java
@@ -1,3 +1,4 @@
-@javax.xml.bind.annotation.XmlSchema(namespace = org.zanata.common.Namespaces.ZANATA_API)
+@javax.xml.bind.annotation.XmlSchema(namespace = org.zanata.common.Namespaces.ZANATA_API,
+      elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
 package org.zanata.common;
 
diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/Account.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/Account.java
@@ -16,6 +16,7 @@
 import org.hibernate.validator.Length;
 import org.hibernate.validator.NotEmpty;
 import org.hibernate.validator.NotNull;
+import org.zanata.common.Namespaces;
 import org.zanata.rest.MediaTypes;
 import org.zanata.rest.MediaTypes.Format;
 
@@ -129,7 +130,7 @@ public void setEnabled(boolean enabled)
       this.enabled = enabled;
    }
 
-   @XmlElement(name = "role")
+   @XmlElement(name = "role", namespace = Namespaces.ZANATA_OLD)
    public Set<String> getRoles()
    {
       return roles;
@@ -140,7 +141,7 @@ public void setRoles(Set<String> roles)
       this.roles = roles;
    }
 
-   @XmlElement(name = "tribe")
+   @XmlElement(name = "tribe", namespace = Namespaces.ZANATA_OLD)
    public Set<String> getTribes()
    {
       return tribes;

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/Glossary.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/Glossary.java
@@ -32,6 +32,7 @@
 import org.codehaus.jackson.annotate.JsonIgnoreProperties;
 import org.codehaus.jackson.annotate.JsonPropertyOrder;
 import org.codehaus.jackson.annotate.JsonWriteNullProperties;
+import org.zanata.common.Namespaces;
 import org.zanata.rest.MediaTypes;
 import org.zanata.rest.MediaTypes.Format;
 import org.zanata.rest.dto.resource.LocaleList;
@@ -60,8 +61,8 @@ public class Glossary implements Serializable, HasMediaType
 
    private LocaleList targetLocales = new LocaleList();
 
-   @XmlElementWrapper(name = "source-locales", required = false)
-   @XmlElement(name = "locale")
+   @XmlElementWrapper(name = "source-locales", required = false, namespace = Namespaces.ZANATA_OLD)
+   @XmlElement(name = "locale", namespace = Namespaces.ZANATA_OLD)
    public LocaleList getSourceLocales()
    {
       return sourceLocales;
@@ -72,8 +73,8 @@ public void setSourceLocales(LocaleList sourceLocales)
       this.sourceLocales = sourceLocales;
    }
 
-   @XmlElementWrapper(name = "target-locales", required = false)
-   @XmlElement(name = "locale")
+   @XmlElementWrapper(name = "target-locales", required = false, namespace = Namespaces.ZANATA_OLD)
+   @XmlElement(name = "locale", namespace = Namespaces.ZANATA_OLD)
    public LocaleList getTargetLocales()
    {
       return targetLocales;
@@ -84,8 +85,8 @@ public void setTargetLocales(LocaleList targetLocales)
       this.targetLocales = targetLocales;
    }
 
-   @XmlElementWrapper(name = "glossary-entries")
-   @XmlElement(name="glossary-entry")
+   @XmlElementWrapper(name = "glossary-entries", namespace = Namespaces.ZANATA_OLD)
+   @XmlElement(name="glossary-entry", namespace = Namespaces.ZANATA_OLD)
    public List<GlossaryEntry> getGlossaryEntries()
    {
       if (glossaryEntries == null)

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/GlossaryEntry.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/GlossaryEntry.java
@@ -33,6 +33,7 @@
 import org.codehaus.jackson.annotate.JsonPropertyOrder;
 import org.codehaus.jackson.annotate.JsonWriteNullProperties;
 import org.zanata.common.LocaleId;
+import org.zanata.common.Namespaces;
 
 /**
  *
@@ -56,7 +57,7 @@ public class GlossaryEntry implements Serializable
 
    private String sourcereference;
 
-   @XmlElement(name = "glossary-term")
+   @XmlElement(name = "glossary-term", namespace = Namespaces.ZANATA_OLD)
    public List<GlossaryTerm> getGlossaryTerms()
    {
       if (glossaryTerms == null)
@@ -83,7 +84,7 @@ public void setSrcLang(LocaleId srcLang)
       this.srcLang = srcLang;
    }
 
-   @XmlElement(name = "source-reference", required = false)
+   @XmlElement(name = "source-reference", required = false, namespace = Namespaces.ZANATA_OLD)
    public String getSourcereference()
    {
       return sourcereference;

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/GlossaryTerm.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/GlossaryTerm.java
@@ -72,7 +72,7 @@ public void setLocale(LocaleId locale)
       this.locale = locale;
    }
 
-   @XmlElement(name = "content", required = false)
+   @XmlElement(name = "content", required = false, namespace = Namespaces.ZANATA_OLD)
    public String getContent()
    {
       return content;
@@ -83,7 +83,7 @@ public void setContent(String content)
       this.content = content;
    }
 
-   @XmlElement(name = "comment")
+   @XmlElement(name = "comment", namespace = Namespaces.ZANATA_OLD)
    public List<String> getComments()
    {
       if (comments == null)

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/Person.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/Person.java
@@ -13,6 +13,7 @@
 import org.hibernate.validator.Email;
 import org.hibernate.validator.NotEmpty;
 import org.hibernate.validator.NotNull;
+import org.zanata.common.Namespaces;
 
 @XmlType(name = "personType")
 @XmlRootElement(name = "person")
@@ -69,7 +70,7 @@ public void setName(String name)
     * 
     * @return set of Links managed by this resource
     */
-   @XmlElement(name = "link", required = false)
+   @XmlElement(name = "link", required = false, namespace = Namespaces.ZANATA_OLD)
    public Links getLinks()
    {
       return links;

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/Project.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/Project.java
@@ -88,7 +88,7 @@ public void setType(ProjectType type)
 
    @NotEmpty
    @Length(max = 80)
-   @XmlElement(name = "name", required = true)
+   @XmlElement(name = "name", required = true, namespace = Namespaces.ZANATA_OLD)
    public String getName()
    {
       return name;
@@ -100,7 +100,7 @@ public void setName(String name)
    }
 
    @Length(max = 80)
-   @XmlElement(name = "description", required = false)
+   @XmlElement(name = "description", required = false, namespace = Namespaces.ZANATA_OLD)
    public String getDescription()
    {
       return description;
@@ -130,8 +130,8 @@ public Links getLinks(boolean createIfNull)
       return links;
    }
 
-   @XmlElementWrapper(name = "project-iterations")
-   @XmlElementRef
+   @XmlElementWrapper(name = "project-iterations", namespace = Namespaces.ZANATA_OLD)
+   @XmlElementRef(namespace = Namespaces.ZANATA_OLD)
    public List<ProjectIteration> getIterations()
    {
       return iterations;
@@ -149,7 +149,7 @@ public List<ProjectIteration> getIterations(boolean createIfNull)
       return getIterations();
    }
 
-   @XmlElement(name = "status", required = false)
+   @XmlElement(name = "status", required = false, namespace = Namespaces.ZANATA_OLD)
    public EntityStatus getStatus()
    {
       return status;

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/ProjectIteration.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/ProjectIteration.java
@@ -33,6 +33,7 @@
 import org.codehaus.jackson.annotate.JsonPropertyOrder;
 import org.codehaus.jackson.annotate.JsonWriteNullProperties;
 import org.zanata.common.EntityStatus;
+import org.zanata.common.Namespaces;
 import org.zanata.rest.MediaTypes;
 import org.zanata.rest.MediaTypes.Format;
 
@@ -80,7 +81,7 @@ public void setId(String id)
     * 
     * @return set of Links managed by this resource
     */
-   @XmlElement(name = "link", required = false)
+   @XmlElement(name = "link", required = false, namespace = Namespaces.ZANATA_OLD)
    public Links getLinks()
    {
       return links;
@@ -98,7 +99,7 @@ public Links getLinks(boolean createIfNull)
       return links;
    }
 
-   @XmlElement(name = "status", required = false)
+   @XmlElement(name = "status", required = false, namespace = Namespaces.ZANATA_OLD)
    public EntityStatus getStatus()
    {
       return status;

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/ProjectList.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/ProjectList.java
@@ -8,6 +8,7 @@
 import javax.xml.bind.annotation.XmlType;
 
 import org.codehaus.jackson.annotate.JsonValue;
+import org.zanata.common.Namespaces;
 
 /**
  * 
@@ -22,7 +23,7 @@ public class ProjectList implements Serializable, HasSample<ProjectList>
 
    private List<Project> projects;
 
-   @XmlElementRef
+   @XmlElementRef(namespace = Namespaces.ZANATA_OLD)
    @JsonValue
    public List<Project> getProjects()
    {

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/VersionInfo.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/VersionInfo.java
@@ -9,6 +9,7 @@
 import org.codehaus.jackson.annotate.JsonIgnoreProperties;
 import org.codehaus.jackson.annotate.JsonTypeName;
 import org.codehaus.jackson.annotate.JsonWriteNullProperties;
+import org.zanata.common.Namespaces;
 
 /**
  * Holds version info
@@ -43,13 +44,13 @@ public VersionInfo(VersionInfo other)
       this(other.versionNo, other.buildTimeStamp);
    }
 
-   @XmlElement(name = "versionNo")
+   @XmlElement(name = "versionNo", namespace = Namespaces.ZANATA_OLD)
    public String getVersionNo()
    {
       return versionNo;
    }
 
-   @XmlElement(name = "buildTimeStamp")
+   @XmlElement(name = "buildTimeStamp", namespace = Namespaces.ZANATA_OLD)
    public String getBuildTimeStamp()
    {
       return buildTimeStamp;

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/package-info.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/package-info.java
@@ -1,3 +1,4 @@
-@javax.xml.bind.annotation.XmlSchema(namespace = org.zanata.common.Namespaces.ZANATA_API)
+@javax.xml.bind.annotation.XmlSchema(namespace = org.zanata.common.Namespaces.ZANATA_API,
+      elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
 package org.zanata.rest.dto;
 
diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/AbstractResourceMeta.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/AbstractResourceMeta.java
@@ -47,8 +47,8 @@ public AbstractResourceMeta(String name)
       this.name = name;
    }
 
-   @XmlElementWrapper(name = "extensions", required = false)
-   @XmlElement(name = "extension")
+   @XmlElementWrapper(name = "extensions", required = false, namespace = Namespaces.ZANATA_OLD)
+   @XmlElement(name = "extension", namespace = Namespaces.ZANATA_OLD)
    public ExtensionSet<AbstractResourceMetaExtension> getExtensions()
    {
       return extensions;
@@ -102,7 +102,7 @@ public void setContentType(ContentType contentType)
       this.contentType = contentType;
    }
 
-   @XmlElement(name = "name", required = true)
+   @XmlElement(name = "name", required = true, namespace = Namespaces.ZANATA_OLD)
    public String getName()
    {
       return name;

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/Resource.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/Resource.java
@@ -11,6 +11,7 @@
 import org.codehaus.jackson.annotate.JsonIgnoreProperties;
 import org.codehaus.jackson.annotate.JsonPropertyOrder;
 import org.codehaus.jackson.annotate.JsonWriteNullProperties;
+import org.zanata.common.Namespaces;
 import org.zanata.rest.dto.DTOUtil;
 
 @XmlType(name = "resourceType", propOrder = { "textFlows" })
@@ -33,7 +34,7 @@ public Resource(String name)
       super(name);
    }
 
-   @XmlElementWrapper(name = "text-flows", required = false)
+   @XmlElementWrapper(name = "text-flows", required = false, namespace = Namespaces.ZANATA_OLD)
    @XmlElement(name = "text-flow", namespace=org.zanata.common.Namespaces.ZANATA_API)
    public List<TextFlow> getTextFlows()
    {

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/ResourceMetaList.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/ResourceMetaList.java
@@ -8,6 +8,7 @@
 import javax.xml.bind.annotation.XmlType;
 
 import org.codehaus.jackson.annotate.JsonValue;
+import org.zanata.common.Namespaces;
 import org.zanata.rest.dto.DTOUtil;
 import org.zanata.rest.dto.HasSample;
 
@@ -25,7 +26,7 @@ public class ResourceMetaList implements Serializable, HasSample<ResourceMetaLis
 
    private List<ResourceMeta> resources;
 
-   @XmlElement(name = "resource", required = true)
+   @XmlElement(name = "resource", required = true, namespace = Namespaces.ZANATA_OLD)
    @JsonValue
    public List<ResourceMeta> getResources()
    {

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/TextContainer.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/TextContainer.java
@@ -33,6 +33,7 @@
 import org.codehaus.jackson.annotate.JsonIgnore;
 import org.codehaus.jackson.annotate.JsonProperty;
 import org.zanata.common.HasContents;
+import org.zanata.common.Namespaces;
 
 /**
  * This class contains string contents for a single translatable message.
@@ -52,7 +53,7 @@ class TextContainer implements Serializable, HasContents
     * NB: If this message has plural forms, this field will be empty.
     * @see #contents
     */
-   @XmlElement(name = "content", required = false)
+   @XmlElement(name = "content", required = false, namespace = Namespaces.ZANATA_OLD)
    @JsonProperty("content")
    private String content;
 
@@ -61,8 +62,8 @@ class TextContainer implements Serializable, HasContents
     * NB: If this message has no plural forms, this field will be empty.
     * @see #content
     */
-   @XmlElementWrapper(name = "contents")
-   @XmlElement(name = "content")
+   @XmlElementWrapper(name = "contents", namespace = Namespaces.ZANATA_OLD)
+   @XmlElement(name = "content", namespace = Namespaces.ZANATA_OLD)
    @JsonProperty("contents")
    private List<String> contents;
 

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/TextFlow.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/TextFlow.java
@@ -102,6 +102,7 @@ public void setId(String id)
    /**
     * @return whether this message supports plurals
     */
+   @XmlElement(namespace = Namespaces.ZANATA_OLD)
    public boolean isPlural()
    {
       return plural;
@@ -127,8 +128,8 @@ public void setLang(LocaleId lang)
       this.lang = lang;
    }
 
-   @XmlElementWrapper(name = "extensions", required = false)
-   @XmlElement(name = "extension")
+   @XmlElementWrapper(name = "extensions", required = false, namespace = Namespaces.ZANATA_OLD)
+   @XmlElement(name = "extension", namespace = Namespaces.ZANATA_OLD)
    public ExtensionSet<TextFlowExtension> getExtensions()
    {
       return extensions;

diff --git a/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/TextFlowTarget.java b/zanata-common-api/src/main/java/org/zanata/rest/dto/resource/TextFlowTarget.java
@@ -73,7 +73,7 @@ public void setState(ContentState state)
     * 
     * @return
     */
-   @XmlElement(name = "description", required = false)
+   @XmlElement(name = "description", required = false, namespace = Namespaces.ZANATA_OLD)
    public String getDescription()
    {
       return description;
@@ -84,8 +84,8 @@ public void setDescription(String description)
       this.description = description;
    }
 
-   @XmlElementWrapper(name = "extensions", required = false)
-   @XmlElement(name = "extension")
+   @XmlElementWrapper(name = "extensions", required = false, namespace = Namespaces.ZANATA_OLD)
+   @XmlElement(name = "extension", namespace = Namespaces.ZANATA_OLD)
    public ExtensionSet<TextFlowTargetExtension> getExtensions()
    {
       return extensions;