1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.extension.repository.internal

File ExtensionSerializer.java

 

Code metrics

0
0
0
1
79
23
0
-
-
0
-

Classes

Class Line # Actions
ExtensionSerializer 44 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.extension.repository.internal;
21   
22    import java.io.InputStream;
23    import java.io.OutputStream;
24    import java.net.URL;
25   
26    import javax.xml.parsers.ParserConfigurationException;
27    import javax.xml.transform.TransformerException;
28   
29    import org.xwiki.component.annotation.Role;
30    import org.xwiki.extension.Extension;
31    import org.xwiki.extension.InvalidExtensionException;
32    import org.xwiki.extension.repository.internal.core.DefaultCoreExtension;
33    import org.xwiki.extension.repository.internal.core.DefaultCoreExtensionRepository;
34    import org.xwiki.extension.repository.internal.local.DefaultLocalExtension;
35    import org.xwiki.extension.repository.internal.local.DefaultLocalExtensionRepository;
36   
37    /**
38    * Local repository storage serialization tool.
39    *
40    * @version $Id: fe1f065e0ee722a45d16231d1b868f9ecd451bf3 $
41    * @since 6.4M1
42    */
43    @Role
 
44    public interface ExtensionSerializer
45    {
46    /**
47    * Load an extension descriptor as local extension instance.
48    *
49    * @param repository the repository
50    * @param descriptor the descriptor content
51    * @return the {@link Extension} instance
52    * @throws InvalidExtensionException error when trying to parse extension descriptor
53    */
54    DefaultLocalExtension loadLocalExtensionDescriptor(DefaultLocalExtensionRepository repository,
55    InputStream descriptor) throws InvalidExtensionException;
56   
57    /**
58    * Load an extension descriptor as core extension instance.
59    *
60    * @param repository the repository
61    * @param url the core extension {@link URL}
62    * @param descriptor the descriptor content
63    * @return the {@link Extension} instance
64    * @throws InvalidExtensionException error when trying to parse extension descriptor
65    */
66    DefaultCoreExtension loadCoreExtensionDescriptor(DefaultCoreExtensionRepository repository, URL url,
67    InputStream descriptor) throws InvalidExtensionException;
68   
69    /**
70    * Save local extension descriptor.
71    *
72    * @param extension the extension to save
73    * @param os the stream where to write the serialized version of the extension descriptor
74    * @throws ParserConfigurationException error when serializing
75    * @throws TransformerException error when serializing
76    */
77    void saveExtensionDescriptor(Extension extension, OutputStream os)
78    throws ParserConfigurationException, TransformerException;
79    }