FileDocCategorySizeDatePackage
PreprocessorUtil.javaAPI DocGlassfish v2 API8684Fri May 04 22:35:28 BST 2007com.sun.appserv.server.util

PreprocessorUtil

public class PreprocessorUtil extends Object
PreprocessorUtil is a utility class for managing the bytecode preprocessor(s). The list of preprocessors are passed in as a string array to the initialize method. If there is a problem initialize any of the preprocessors, all preprocessing is disabled.

Fields Summary
private static boolean
_preprocessorEnabled
private static com.sun.appserv.BytecodePreprocessor[]
_preprocessor
Constructors Summary
Methods Summary
public static booleaninit(java.lang.String[] ppClassNames)
Initializes the preprocessor utility with the associated class names array arugment.

param
ppClassNames - the String array of preprocessor class names.
return
- true if successful, otherwise false. All preprocessors must successfully initialize for true to be returned.

             
    
                                                      
                  
        if (ppClassNames != null) {
            setupPreprocessor(ppClassNames);
        }
        return _preprocessorEnabled;
    
public static booleanisPreprocessorEnabled()
Indicates whether or not the preprocessor is enabled

return
- true of the preprocessor is enabled, otherwise false.

        return _preprocessorEnabled;
    
public static byte[]processClass(java.lang.String className, byte[] classBytes)
Processes a class through the preprocessor.

param
className - the class name.
param
classBytes - the class byte array.
return
- the processed class byte array.

        Logger _logger = LogDomains.getLogger(LogDomains.CMN_LOGGER);
        byte[] goodBytes = classBytes;
        if (_preprocessorEnabled) {            
            if (_preprocessor != null) {
                // Loop through all of the defined preprocessors...
                for (int i=0; i < _preprocessor.length; i++) {
                    classBytes = 
                        _preprocessor[i].preprocess(className, classBytes);
                    _logger.fine("[PreprocessorUtil.processClass] Preprocessor "
                        + i + " Processed Class: " + className); 
                    // Verify the preprocessor returned some bytes
                    if (classBytes != null){                           
                        goodBytes = classBytes;
                    }
                    else{
                        _logger.log(Level.SEVERE, 
                            "bytecodepreprocessor.preprocess_failed", 
                            new String[] {className,
                                          _preprocessor[i].getClass().getName()});
                            
                        // If were on the 1st preprocessor
                        if (i == 0){
                            _logger.log(
                                Level.SEVERE, 
                                "bytecodepreprocessor.resetting_original", 
                                className);
                        }
                        // We're on the 2nd or nth preprocessor.
                        else{
                            _logger.log(
                                Level.SEVERE, 
                                "bytecodepreprocessor.resetting_last_good",
                                className);
                        }                        
                    }                        
                }
            }
        }
        return goodBytes;               
    
private static synchronized voidsetupPreprocessor(java.lang.String[] ppClassNames)

        Logger _logger = LogDomains.getLogger(LogDomains.CMN_LOGGER);

        if (_preprocessor != null)
            // The preprocessors have already been set up.
            return;

        try {            
            _preprocessor = new BytecodePreprocessor[ppClassNames.length];
            for (int i = 0; i < ppClassNames.length; i++) {                
                String ppClassName = ppClassNames[i].trim();            
                Class ppClass = Class.forName(ppClassName);
                if (ppClass != null){
                    _preprocessor[i] = (BytecodePreprocessor)
                                                        ppClass.newInstance();
                    if (_preprocessor[i] instanceof BytecodePreprocessor){
                        _preprocessor[i] = 
                            (BytecodePreprocessor)_preprocessor[i];
                        _preprocessorEnabled = true;
                    } else {                    
                        _logger.log(Level.SEVERE, 
                            "bytecodepreprocessor.invalid_type", 
                            ppClassName);     
                        _logger.log(Level.SEVERE, 
                            "bytecodepreprocessor.disabled");                 
                        _preprocessorEnabled = false;
                    }
                }
                if (_preprocessor[i] != null){
                    if (!_preprocessor[i].initialize(new Hashtable())) {
                        _logger.log(Level.SEVERE, 
                            "bytecodepreprocessor.failed_init", 
                            ppClassName); 
                        _logger.log(Level.SEVERE, 
                            "bytecodepreprocessor.disabled");
                        _preprocessorEnabled = false;
                    }                    
                } else {
                    _logger.log(Level.SEVERE, 
                        "bytecodepreprocessor.failed_init", 
                        ppClassName); 
                    _logger.log(Level.SEVERE, 
                        "bytecodepreprocessor.disabled"); 
                    _preprocessorEnabled = false;
                }
            }
        } catch (Throwable t) {            
            _logger.log(Level.SEVERE, "bytecodepreprocessor.setup_ex", t); 
            _logger.log(Level.SEVERE, "bytecodepreprocessor.disabled"); 
            _preprocessorEnabled = false;
            return;
        }