Class L10nDecorator

java.lang.Object

hudson.model.Descriptor<PageDecorator>

hudson.model.PageDecorator

hudson.plugins.translation.L10nDecorator

All Implemented Interfaces:

ExtensionPoint, Describable<PageDecorator>, Saveable, Loadable, OnMaster

@Extension
public class L10nDecorator
extends PageDecorator

PageDecorator that adds the translation dialog.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	L10nDecorator.SubmissionEntry

Nested classes/interfaces inherited from class Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
final ContributedL10nStore	store

Fields inherited from class PageDecorator

ALL

Fields inherited from class Descriptor

clazz

Fields inherited from interface Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
L10nDecorator()

Method Summary

Modifier and Type	Method	Description
List<Msg>	decode(org.kohsuke.stapler.StaplerRequest2 request)	Does the opposite of encodeRecording(StaplerRequest2).
void	doSubmit(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, String locale)	Handles the submission from the browser, storing the contributed translations locally on this Jenkins instance.
String	encodeRecording(org.kohsuke.stapler.StaplerRequest2 request)	Encrypts the recorded resource bundle list into an opaque, tamper-proof token that round-trips through the browser.
String	getPrimaryTranslationLocale(org.kohsuke.stapler.StaplerRequest2 req)	Looks at Accept-Language header manually and decide which locale this user is likely capable of translating.
Collection<Msg>	getRecording(org.kohsuke.stapler.StaplerRequest2 request)
List<Locales.Entry>	listLocales()
void	startRecording(org.kohsuke.stapler.StaplerRequest2 request)	Activate the recording of the localized resources.

Methods inherited from class PageDecorator

all, getDescriptor, getUrl

Methods inherited from class Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class Object

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

Field Details

store

public final ContributedL10nStore store

Constructor Details

L10nDecorator

public L10nDecorator()

Method Details

listLocales

public List<Locales.Entry> listLocales()

startRecording

public void startRecording(org.kohsuke.stapler.StaplerRequest2 request)

Activate the recording of the localized resources.

getRecording

public Collection<Msg> getRecording(org.kohsuke.stapler.StaplerRequest2 request)

encodeRecording

public String encodeRecording(org.kohsuke.stapler.StaplerRequest2 request)

Encrypts the recorded resource bundle list into an opaque, tamper-proof token that round-trips through the browser.

decode

public List<Msg> decode(org.kohsuke.stapler.StaplerRequest2 request)

Does the opposite of encodeRecording(StaplerRequest2).

getPrimaryTranslationLocale

public String getPrimaryTranslationLocale(org.kohsuke.stapler.StaplerRequest2 req)

Looks at Accept-Language header manually and decide which locale this user is likely capable of translating.

doSubmit

public void doSubmit(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp,
 @QueryParameter
 String locale)
              throws IOException,
jakarta.servlet.ServletException

Handles the submission from the browser, storing the contributed translations locally on this Jenkins instance.

Throws:

IOException

jakarta.servlet.ServletException