Package com.atlassian.confluence.plugins.rest.jackson2.resources

Class I18nResource

java.lang.Object

com.atlassian.confluence.plugins.rest.jackson2.resources.AbstractResource

com.atlassian.confluence.plugins.rest.jackson2.resources.I18nResource

@Path("/i18n")
public class I18nResource
extends AbstractResource

Rest resource for accessing translations in Confluence.

Field Summary

Fields inherited from class com.atlassian.confluence.plugins.rest.jackson2.resources.AbstractResource

authContext, uriInfo, userAccessor

Constructor Summary

Constructors

Constructor	Description
I18nResource(UserAccessor userAccessor, com.atlassian.plugin.PluginAccessor pluginAccessor, LocaleManager localeManager, I18NBeanFactory i18NBeanFactory, HttpContext httpContext, SpacePermissionManager spacePermissionManager)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	get(Set<String> pluginKeys, boolean rawValue)	Returns the text for the given plugin keys.
jakarta.ws.rs.core.Response	getI18n(String pluginKey, boolean rawValue)	Returns the text for the given plugin key.

Methods inherited from class com.atlassian.confluence.plugins.rest.jackson2.resources.AbstractResource

createRequestContext, getAnonymousUserUriBuilder, getAttachmentUriBuilder, getContentUriBuilder, getCurrentUser, getMissingUserUriBuilder, getSpaceUriBuilder, getUserUriBuilder

Methods inherited from class java.lang.Object

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

Constructor Details

I18nResource

@Inject
public I18nResource(UserAccessor userAccessor,
 com.atlassian.plugin.PluginAccessor pluginAccessor,
 LocaleManager localeManager,
 I18NBeanFactory i18NBeanFactory,
 HttpContext httpContext,
 SpacePermissionManager spacePermissionManager)

Method Details

get

@GET
@Produces({"application/xml","application/json"})
public jakarta.ws.rs.core.Response get(@QueryParam("pluginKeys")
 Set<String> pluginKeys,
 @QueryParam("rawValue") @DefaultValue("false")
 boolean rawValue)

Returns the text for the given plugin keys.

Returns:

all the translated keys for the given plugin keys.

getI18n

@GET
@Produces("application/json")
@Path("/{key}")
public jakarta.ws.rs.core.Response getI18n(@PathParam("key")
 String pluginKey,
 @QueryParam("rawValue") @DefaultValue("false")
 boolean rawValue)

Returns the text for the given plugin key. If the specified plugin key does not exist, or the caller does not have permission to access the plugin texts, the response is HTTP 404 (not found). Note that only JSON is returned. An example URL including a plugin key would look like this: http://host/confluence/rest/prototype2/1/i18n/com.atlassian.confluence.tinymceplugin

Parameters:

pluginKey - The plugin key as it is defined in the atlassian-plugin.xml.

Returns:

all the translated keys for the given plugin key.