1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.updater.service;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.Collection;
39 import java.util.List;
40
41
42 /**
43 * Update Service Interface
44 */
45 public interface IUpdateService
46 {
47 int STATUS_NO_UPDATE = 0;
48 int STATUS_REGULAR_UPDATE = 1;
49 int STATUS_CRITICAL_UPDATE = 2;
50
51 /**
52 * Download the plugin package
53 * @param strPluginName The plugin name
54 * @param strVersion The plugin version
55 * @throws UpdaterDownloadException If an exception occurs during download
56 */
57 void downloadPlugin( String strPluginName, String strVersion )
58 throws UpdaterDownloadException;
59
60 /**
61 * Download the plugin package
62 * @param strPluginName The plugin name
63 * @param strVersion The new plugin version
64 * @param strVersionFrom The current plugin version
65 * @throws UpdaterDownloadException If an exception occurs during download
66 */
67 void downloadPluginUpgrade( String strPluginName, String strVersion, String strVersionFrom )
68 throws UpdaterDownloadException;
69
70 /**
71 * Gets available update for a list of plugins
72 * @param listPlugins The list of plugins
73 * @return A list of updates available for the given list of plugins
74 */
75 List<UpdateInfos> getUpdateInfos( Collection<Plugin> listPlugins );
76
77 /**
78 * Gets available plugins not already installed
79 * @param listPlugins The list of installed plugins
80 * @return New plugins infos list
81 */
82 List<NewInfos> getNewPluginsInfos( Collection<Plugin> listPlugins );
83
84 /**
85 * Returns the updater status : (no update available, regular updates
86 * available or critical updates available.
87 * @return The status
88 */
89 int getStatus( );
90
91 /**
92 * Returns the number of regular updates available
93 * @return the number of regular updates available
94 */
95 int getRegularUpdateCount();
96
97 /**
98 * Returns the number of critical updates available
99 * @return the number of critical updates available
100 */
101 int getCriticalUpdateCount();
102
103 /**
104 * Check for updates and update the status
105 * @param listPlugins The list of installed plugins
106 */
107 void checkUpdate( Collection<Plugin> listPlugins );
108
109 /**
110 * Deploy a plugin (downloaded => deploy)
111 * @param strPluginName The plugin name
112 * @param strVersion The update version
113 */
114 void deployPlugin( String strPluginName, String strVersion );
115 }