package org.astrogrid.samp.web; import java.lang.reflect.InvocationHandler; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.lang.reflect.Proxy; import java.util.Collection; import java.util.Enumeration; import java.util.HashSet; import java.util.Hashtable; import java.util.MissingResourceException; import java.util.ResourceBundle; import java.util.logging.Logger; /** * ResourceBundle for internationalising the Web Profile authorization * dialogue. * * @author Mark Taylor * @since 15 Jul 2011 */ public class AuthResourceBundle extends ResourceBundle { private final Hashtable map_; private static final Logger logger_ = Logger.getLogger( AuthResourceBundle.class.getName() ); /** * Constructs default (English) instance. */ public AuthResourceBundle() { this( getDefaultContent() ); } /** * Constructs a bundle based on a Content implementation. * * @param content contains information required for bundle */ protected AuthResourceBundle( Content content ) { map_ = new Hashtable(); Method[] methods = getContentMethods(); Object[] noArgs = new Object[ 0 ]; for ( int im = 0; im < methods.length; im++ ) { Method method = methods[ im ]; String mname = method.getName(); try { map_.put( method.getName(), method.invoke( content, noArgs ) ); } catch ( IllegalAccessException e ) { throw (RuntimeException) new RuntimeException( "Failed to call method " + method.getName() ) .initCause( e ); } catch ( InvocationTargetException e ) { throw (RuntimeException) new RuntimeException( "Failed to call method " + method.getName() ) .initCause( e ); } } checkHasAllKeys( this ); } protected final Object handleGetObject( String key ) { return map_.get( key ); } public final Enumeration getKeys() { return map_.keys(); } /** * Returns a Content object based on a bundle which has the keys * that AuthResourceBundle is supposed to have. * If any of the required keys are missing, the result falls back * to a default bundle. * * @param bundle resource bundle * @return content object guaranteed to have non-null contents for * all its attributes */ public static Content getAuthContent( final ResourceBundle bundle ) { try { checkHasAllKeys( bundle ); } catch ( MissingResourceException e ) { logger_.warning( "Some keys missing from localised auth resource " + "bundle; using English" ); return getDefaultContent(); } InvocationHandler ihandler = new InvocationHandler() { public Object invoke( Object proxy, Method method, Object[] args ) throws Throwable { String key = method.getName(); Class rclazz = method.getReturnType(); if ( String.class.equals( rclazz ) ) { return bundle.getString( key ); } else { throw new RuntimeException( "Unsuitable return type " + rclazz.getName() + " (shouldn't happen)" ); } } }; return (Content) Proxy .newProxyInstance( AuthResourceBundle.class.getClassLoader(), new Class[] { Content.class }, ihandler ); } /** * Returns all the methods of the Content interface which correspond * to AuthResourceBundle entries. * * @return resource bundle methods, all have no arguments and return String */ static Method[] getContentMethods() { return Content.class.getMethods(); } /** * Determines if a bundle has all the required keys for this class. * * @param bundle bundle to test * @return true iff bundle has all required keys */ static void checkHasAllKeys( ResourceBundle bundle ) { Collection bkeys = new HashSet(); for ( Enumeration en = bundle.getKeys(); en.hasMoreElements(); ) { bkeys.add( en.nextElement() ); } Collection mnames = new HashSet(); Method[] methods = getContentMethods(); for ( int im = 0; im < methods.length; im++ ) { mnames.add( methods[ im ].getName() ); } mnames.removeAll( bkeys ); if ( ! mnames.isEmpty() ) { throw new MissingResourceException( "Missing resources " + mnames, AuthResourceBundle.class.getName(), mnames.iterator().next().toString() ); } } /** * Returns a default Content implementation. * * @return english content */ private static Content getDefaultContent() { return new AuthResourceBundle_en.EnglishContent(); } /** * Returns a string suitable for entry into a .properties file * for a given Method of a given Content object. * * @param content auth resource content * @param method Content method (public String x()) */ private static String toPropertyString( Content content, Method method ) { try { String value = (String) method.invoke( content, new Object[ 0 ] ); value = value.replaceAll( "\n", "\\\\n" ); StringBuffer sbuf = new StringBuffer(); sbuf.append( method.getName() ) .append( '=' ); for ( int i = 0; i < value.length(); i++ ) { char c = value.charAt( i ); if ( c == '\n' ) { sbuf.append( "\\n" ); } else if ( c >= 32 && c < 128 ) { sbuf.append( c ); } else { String xs = Integer.toHexString( (int) c ); sbuf.append( "\\u" ); for ( int j = xs.length(); j < 4; j++ ) { sbuf.append( '0' ); } sbuf.append( xs ); } } return sbuf.toString(); } catch ( IllegalAccessException e ) { throw (RuntimeException) new RuntimeException( "Failed to call method " + method.getName() ) .initCause( e ); } catch ( InvocationTargetException e ) { throw (RuntimeException) new RuntimeException( "Failed to call method " + method.getName() ) .initCause( e ); } } /** * Writes a template .properties file. Sensitive to the locale. */ public static void main( String[] args ) { ResourceBundle lBundle = ResourceBundle.getBundle( AuthResourceBundle.class.getName() ); Content lContent = getAuthContent( lBundle ); Content dContent = getDefaultContent(); Method[] methods = getContentMethods(); System.out.println( "# Template for " + AuthResourceBundle.class.getName() + "_xx.properties file," ); System.out.println( "# giving localised text " + "for Web Profile client authorization dialogue." ); System.out.println( "# Please fill in language-specific values for " + "each key, as in the example." ); System.out.println( "# Follow the capitalization and punctuation " + "of the English version." ); System.out.println( "# Long lines should be broken up with return " + "characters (\\n)." ); System.out.println( "# Encoding is ISO 8859-1; " + "see java.util.Properties docs for detailed " + "syntax." ); System.out.println( "#" ); System.out.println( "# Alternatively, implement " + AuthResourceBundle.class.getName() + "_xx" ); System.out.println( "# using " + AuthResourceBundle_en.class.getName() + " as an example." ); System.out.println(); for ( int im = 0; im < methods.length; im++ ) { Method method = methods[ im ]; System.out.println( "# " + toPropertyString( dContent, method ) ); System.out.println( toPropertyString( lContent, method ) ); } } /** * Defines the keys and value types required for a bundle of this class. * See the English language implementation in * {@link AuthResourceBundle_en} for example text. * *
All methods have no arguments and return a String.
* The methods with names
* that end "Lines" should return text which contains
* line breaks (\n characters). Each such line will
* be displayed as it stands in the GUI, so it shouldn't be too long.
*
*
The method names define the keys which can be used if a * property resource file is used to supply the content. */ public static interface Content { /** * Returns the title for the confirmation window. */ String windowTitle(); /** * Returns lines introducing the registration request. */ String appIntroductionLines(); /** * Returns the word meaning "Name" (initial capitalised). */ String nameWord(); /** * Returns the word meaning "Origin" (initial capitalised). */ String originWord(); /** * Returns the word meaning "undeclared" (not capitalised). */ String undeclaredWord(); /** * Returns lines suitable explaining the privileges that a * registered client will have. */ String privilegeWarningLines(); /** * Returns lines with advice on whether you should accept or decline. */ String adviceLines(); /** * Returns a line asking whether to authorize (yes/no). */ String questionLine(); /** * Returns the word meaning "Yes" (initial capitalised). */ String yesWord(); /** * Returns the word meaning "No" (initial capitalised). */ String noWord(); } }