com.wadpam.open.i18n.web

Class I18nController

java.lang.Object

com.wadpam.open.i18n.web.I18nController

@Controller
@RequestMapping(value="{domain}/i18n")
public class I18nController
extends Object

The i18n controller implements all REST methods related to translations. There methods should preferably only be user by some kind of backoffice interface to manage the translations. Any app side integration should be in the Controller och Service accessed by the app (the app should not access the REST interface directly).

Version:

$id$ - $Revision$

Author:

mattiaslevin, sophea sophea

Constructor Summary

Constructors

Constructor and Description
I18nController()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.web.servlet.view.RedirectView	addTranslation(javax.servlet.http.HttpServletRequest request, org.springframework.web.util.UriComponentsBuilder uriBuilder, String domain, String parent, String locale, String string, String imageUrl, String linkUrl) Add a localized translation.
org.springframework.http.ResponseEntity<Ji18nTranslation>	deleteTranslation(javax.servlet.http.HttpServletRequest request, String id) Delete a localized translation by id
org.springframework.http.ResponseEntity<Ji18nTranslation>	deleteTranslation(javax.servlet.http.HttpServletRequest request, String parent, String locale) Delete a localized translation for a specific local and parent
org.springframework.http.ResponseEntity<Collection<Ji18nTranslation>>	deleteTranslationsForParent(javax.servlet.http.HttpServletRequest request, String parent) Delete all localized translation for a specific parent
org.springframework.http.ResponseEntity<Ji18nTranslation>	getTranslation(javax.servlet.http.HttpServletRequest request, String id) Get a localized translation by id as KeyString
org.springframework.http.ResponseEntity<Ji18nTranslation>	getTranslation(javax.servlet.http.HttpServletRequest request, String parent, String locale) Get a localized translation for a specific locale and parent.
org.springframework.http.ResponseEntity<Map<String,Ji18nTranslation>>	getTranslationsForLocaleForParents(javax.servlet.http.HttpServletRequest request, String[] parents, String locale) Get localized translation in a specific locale for a list fo parents.
org.springframework.http.ResponseEntity<Collection<Ji18nTranslation>>	getTranslationsForParent(javax.servlet.http.HttpServletRequest request, String parent) Get all localized translation for a specific parent.
org.springframework.http.ResponseEntity<Map<String,Collection<Ji18nTranslation>>>	getTranslationsForParents(javax.servlet.http.HttpServletRequest request, String[] parents) Get all localized translation for a list fo parents.
void	setTranslationService(TranslationService translationService)

Methods inherited from class java.lang.Object

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

Constructor Detail

I18nController

public I18nController()

Method Detail

addTranslation

@RequestMapping(value="",
                method=POST)
public org.springframework.web.servlet.view.RedirectView addTranslation(javax.servlet.http.HttpServletRequest request,
                                                                              org.springframework.web.util.UriComponentsBuilder uriBuilder,
                                                                              @PathVariable
                                                                              String domain,
                                                                              @RequestParam(required=true)
                                                                              String parent,
                                                                              @RequestParam(required=true)
                                                                              String locale,
                                                                              @RequestParam(required=false)
                                                                              String string,
                                                                              @RequestParam(required=false)
                                                                              String imageUrl,
                                                                              @RequestParam(required=false)
                                                                              String linkUrl)

Add a localized translation.

Parameters:

parent - the parent resource being translated

locale - the locale

string - localized string value

imageUrl - localized image

linkUrl - localized url

Returns:

redirect to the newly created translation

getTranslation

@RequestMapping(value="{id}",
                method=GET)
public org.springframework.http.ResponseEntity<Ji18nTranslation> getTranslation(javax.servlet.http.HttpServletRequest request,
                                                                                      @PathVariable
                                                                                      String id)

Get a localized translation by id as KeyString

Parameters:

id - the id of the translation

Returns:

the translation

getTranslation

@RequestMapping(value="",
                method=GET,
                params={"parent","locale"})
public org.springframework.http.ResponseEntity<Ji18nTranslation> getTranslation(javax.servlet.http.HttpServletRequest request,
                                                                                      @RequestParam(required=true)
                                                                                      String parent,
                                                                                      @RequestParam(required=true)
                                                                                      String locale)

Get a localized translation for a specific locale and parent.

Parameters:

parent - the parent key resource being translated

locale - the locale

Returns:

the translation

getTranslationsForParent

@RequestMapping(value="",
                method=GET,
                params="parent")
public org.springframework.http.ResponseEntity<Collection<Ji18nTranslation>> getTranslationsForParent(javax.servlet.http.HttpServletRequest request,
                                                                                                            @RequestParam(required=true)
                                                                                                            String parent)

Get all localized translation for a specific parent.

Parameters:

parent - the parent key resource being translated

Returns:

a list of translations

getTranslationsForParents

@RequestMapping(value="",
                method=GET,
                params="parents")
public org.springframework.http.ResponseEntity<Map<String,Collection<Ji18nTranslation>>> getTranslationsForParents(javax.servlet.http.HttpServletRequest request,
                                                                                                                         @RequestParam(required=true)
                                                                                                                         String[] parents)

Get all localized translation for a list fo parents.

Parameters:

parents - a list of parents

Returns:

a map of translations

getTranslationsForLocaleForParents

@RequestMapping(value="",
                method=GET,
                params={"parents","locale"})
public org.springframework.http.ResponseEntity<Map<String,Ji18nTranslation>> getTranslationsForLocaleForParents(javax.servlet.http.HttpServletRequest request,
                                                                                                                      @RequestParam(required=true)
                                                                                                                      String[] parents,
                                                                                                                      @RequestParam(required=true)
                                                                                                                      String locale)

Get localized translation in a specific locale for a list fo parents.

Parameters:

parents - a list

locale - the locale

Returns:

a list of translations

deleteTranslation

@RequestMapping(value="{id}",
                method=DELETE)
public org.springframework.http.ResponseEntity<Ji18nTranslation> deleteTranslation(javax.servlet.http.HttpServletRequest request,
                                                                                         @PathVariable
                                                                                         String id)

Delete a localized translation by id

Parameters:

id - the id of the translation

Returns:

the translation

deleteTranslation

@RequestMapping(value="",
                method=DELETE,
                params="locale")
public org.springframework.http.ResponseEntity<Ji18nTranslation> deleteTranslation(javax.servlet.http.HttpServletRequest request,
                                                                                         @RequestParam(required=true)
                                                                                         String parent,
                                                                                         @RequestParam(required=true)
                                                                                         String locale)

Delete a localized translation for a specific local and parent

Parameters:

parent - the parent resource being translated

locale - the locale

Returns:

the translation

deleteTranslationsForParent

@RequestMapping(value="",
                method=DELETE,
                params="parent")
public org.springframework.http.ResponseEntity<Collection<Ji18nTranslation>> deleteTranslationsForParent(javax.servlet.http.HttpServletRequest request,
                                                                                                               @RequestParam(required=true)
                                                                                                               String parent)

Delete all localized translation for a specific parent

Parameters:

parent - the parent resource being deleted

Returns:

a list of translations

setTranslationService

public void setTranslationService(TranslationService translationService)