1 /*
2 * Copyright (c) 2002-2017, 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.deployment.service.vcs;
35
36 import fr.paris.lutece.plugins.deployment.business.CommandResult;
37 import fr.paris.lutece.plugins.deployment.business.vcs.AbstractVCSUser;
38 import fr.paris.lutece.util.ReferenceList;
39
40 public interface IVCSService<T extends AbstractVCSUser>
41 {
42 void init( );
43
44 /**
45 * Get the ReferenceList of the tags of a site
46 *
47 * @param strUrlSite
48 * the Url of the repo
49 * @param user
50 * the VCS user
51 * @param strSiteName
52 * the name of the site
53 * @return the ReferenceList of the tags of the repo
54 */
55 ReferenceList getTagsSite( String strUrlSite, T user, String strSiteName );
56
57 /**
58 * Perform the checkout of the site
59 *
60 * @param strSiteName
61 * the site name
62 * @param strUrl
63 * the url of the repo
64 * @param user
65 * the VCS user
66 * @param commandResult
67 * the command result
68 * @param strBranch
69 * the branch
70 * @param strTag
71 * the tag
72 * @return
73 */
74 String doCheckoutSite( String strSiteName, String strUrl, T user, CommandResult commandResult, String strBranch, String strTag );
75
76 /**
77 * Get the reference list of the upgrades SQL Files
78 *
79 * @param strSiteName
80 * the site name
81 * @param strUrlSite
82 * the url of the repo
83 * @param user
84 * the VCS user
85 * @return the reference list of the upgrades files
86 */
87 ReferenceList getUpgradesFiles( String strSiteName, String strUrlSite, T user );
88
89 /**
90 * Get the artifact id of the site in the VCS (it's often the site name)
91 *
92 * @param strPathRepo
93 * the path of the repository
94 * @return the artifact id of the site
95 */
96 String getArtifactId( String strPathRepo );
97
98 /**
99 * Check if the repo is public or private
100 *
101 * @return true if the repo is private, false otherwise
102 */
103 boolean isPrivate( );
104
105 /**
106 * Check if the provided VCS User is authorized to access to repo
107 *
108 * @param strRepoUrl
109 * @param user
110 */
111 void checkAuthentication( String strRepoUrl, T user );
112 }