se.litsec.opensaml.utils.spring.StringToLocalizedStringConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensaml3-ext Show documentation

OpenSAML 3.X utility extension library

There is a newer version: 1.4.5

/*
 * The opensaml-ext project is an open-source package that extends OpenSAML
 * with useful extensions and utilities.
 *
 * More details on 
 * Copyright (C) 2017 Litsec AB
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package se.litsec.opensaml.utils.spring;

import org.springframework.core.convert.converter.Converter;

import se.litsec.opensaml.core.LocalizedString;

/**
 * Utility class for transforming strings into OpenSAML LocalizedStrings.
 * 
 * The strings being converted MUST start with the language identifier followed by a hyphen. For example, the string
 * "en-Hello" will be translated to the localized string "Hello" in English. If no language indicator is given, a
 * {@code LocalizedString} with no language tag will be created.
 * 
 * 
 * @author Martin Lindström ([email protected])
 */
public class StringToLocalizedStringConverter implements Converter {

  /**
   * Converts strings on the format {@code -}. The string "en-Hello" will give a
   * LocalizedString where:
   * 
   * {@code
   * ls.getLanguage() => "en"
   * ls.getLocalString() => "Hello"}
   * 
   */
  @Override
  public LocalizedString convert(String source) {    
    return new LocalizedString(source);
  }

}