Examples of hudson.XmlFile

hudson.XmlFile
Represents an XML data file that Jenkins uses as a data file.
Evolving data format

Changing data format requires a particular care so that users with the old data format can migrate to the newer data format smoothly.
Adding a field is the easiest. When you read an old XML that does not have any data, the newly added field is left to the VM-default value (if you let XStream create the object, such as {@link #read()} — which is the majority), or to the value initialized by theconstructor (if the object is created via new and then its value filled by XStream, such as {@link #unmarshal(Object)}.)
Removing a field requires that you actually leave the field with transient keyword. When you read the old XML, XStream will set the value to this field. But when the data is saved, the field will no longer will be written back to XML. (It might be possible to tweak XStream so that we can simply remove fields from the class. Any help appreciated.)
Changing the data structure is usually a combination of the two above. You'd leave the old data store with transient, and then add the new data. When you are reading the old XML, only the old field will be set. When you are reading the new XML, only the new field will be set. You'll then need to alter the code so that it will be able to correctly handle both situations, and that as soon as you see data in the old field, you'll have to convert that into the new data structure, so that the next save operation will write the new data (otherwise you'll end up losing the data, because old fields will be never written back.)
In some limited cases (specifically when the class is the root object to be read from XML, such as {@link Descriptor}), it is possible to completely and drastically change the data format. See {@link Descriptor#load()} for more about this technique.
There's a few other possibilities, such as implementing a custom {@link Converter} for XStream, or {@link XStream#alias(String,Class) registering an alias}. @author Kohsuke Kawaguchi

        nl.add(new DummyNode());
        nl.add(new EphemeralNode());


        File tmp = File.createTempFile("test","test");
        try {
            XmlFile x = new XmlFile(Hudson.XSTREAM, tmp);
            x.write(nl);


            String xml = FileUtils.readFileToString(tmp);
            System.out.println(xml);
            assertEquals(4,xml.split("\n").length);


            NodeList back = (NodeList)x.read();


            assertEquals(1,back.size());
            assertEquals(DummyNode.class,back.get(0).getClass());
        } finally {
            tmp.delete();

View Full Code Here

    public XmlFile getConfigFile()
    {
        securityService.checkPermission(Hudson.ADMINISTER);
        // Hudson.getConfigFile() is not public, so we have to duplicate some muck here
        File f = new File(getWorkingDirectory(), "config.xml");
        return new XmlFile(Hudson.XSTREAM, f);
    }

View Full Code Here

    /**
     * Loads the data from the disk into this object.
     */
    public synchronized void load() throws IOException {
        UpdateSite defaultSite = new UpdateSite("default", config.getUpdateCenterUrl() + "update-center.json");
        XmlFile file = getConfigFile();
        if(file.exists()) {
            try {
                sites.replaceBy(((PersistedList)file.unmarshal(sites)).toList());
            } catch (IOException e) {
                LOGGER.log(Level.WARNING, "Failed to load "+file, e);
            }
            for (UpdateSite site : sites) {
                // replace the legacy site with the new site

View Full Code Here

            }
        }
    }


    private XmlFile getConfigFile() {
        return new XmlFile(XSTREAM,new File(Hudson.getInstance().root,
                                    UpdateCenter.class.getName()+".xml"));
    }

View Full Code Here

            return;
        }
        if (req.getMethod().equals("POST")) {
            // submission
            checkPermission(CONFIGURE);
            XmlFile configXmlFile = getConfigFile();
            AtomicFileWriter out = new AtomicFileWriter(configXmlFile.getFile());
            try {
                try {
                    // this allows us to use UTF-8 for storing data,
                    // plus it checks any well-formedness issue in the submitted
                    // data
                    Transformer t = TransformerFactory.newInstance()
                            .newTransformer();
                    t.transform(new StreamSource(req.getReader()),
                            new StreamResult(out));
                    out.close();
                } catch (TransformerException e) {
                    throw new IOException2("Failed to persist configuration.xml", e);
                }


                // try to reflect the changes by reloading
                new XmlFile(Items.XSTREAM, out.getTemporaryFile()).unmarshal(this);
                onLoad(getParent(), getRootDir().getName());


                // if everything went well, commit this new version
                out.commit();
            } finally {

View Full Code Here


    /**
     * The file we save our configuration.
     */
    public static XmlFile getConfigFile(File dir) {
        return new XmlFile(XSTREAM,new File(dir,"config.xml"));
    }

View Full Code Here


    /**
     * The file we save our configuration.
     */
    private static XmlFile getConfigFile(File file) {
        return new XmlFile(XSTREAM,file);
    }

View Full Code Here

     */
    /*package*/ static Fingerprint load(byte[] md5sum) throws IOException {
        return load(getFingerprintFile(md5sum));
    }
    /*package*/ static Fingerprint load(File file) throws IOException {
        XmlFile configFile = getConfigFile(file);
        if(!configFile.exists())
            return null;


        long start=0;
        if(logger.isLoggable(Level.FINE))
            start = System.currentTimeMillis();


        try {
            Fingerprint f = (Fingerprint) configFile.read();
            if(logger.isLoggable(Level.FINE))
                logger.fine("Loading fingerprint "+file+" took "+(System.currentTimeMillis()-start)+"ms");
            return f;
        } catch (IOException e) {
            if(file.exists() && file.length()==0) {

View Full Code Here

     * Loads the other data from disk if it's available.
     */
    private synchronized void load() {
        properties.clear();


        XmlFile config = getConfigFile();
        try {
            if(config.exists())
                config.unmarshal(this);
        } catch (IOException e) {
            LOGGER.log(Level.SEVERE, "Failed to load "+config,e);
        }


        // remove nulls that have failed to load

View Full Code Here


    /**
     * The file we save our configuration.
     */
    protected final XmlFile getConfigFile() {
        return new XmlFile(XSTREAM,new File(getRootDir(),id +"/config.xml"));
    }

View Full Code Here

0 1 2 3 4 5 6 7 8

TOP

Related Classes of hudson.XmlFile

com.attask.jenkins.scaffolding.Scaffold

com.attask.jenkins.templates.ImplementationBuildWrapper

com.thoughtworks.xstream.io.xml.XppReader

de.pellepelster.jenkins.walldisplay.WallDisplayPlugin

hudson.logging.LogRecorder

hudson.matrix.MatrixProject

hudson.model.AbstractItem

hudson.model.ComputerSet

hudson.model.Descriptor

hudson.model.Fingerprint

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of hudson.XmlFile

Evolving data format

Related Classes of hudson.XmlFile