View Javadoc
1   package org.apache.maven.profiles;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.model.Activation;
23  import org.apache.maven.model.Profile;
24  import org.apache.maven.model.building.ModelProblem;
25  import org.apache.maven.model.building.ModelProblemCollector;
26  import org.apache.maven.model.profile.DefaultProfileActivationContext;
27  import org.apache.maven.model.profile.ProfileSelector;
28  import org.apache.maven.profiles.activation.ProfileActivationException;
29  import org.codehaus.plexus.MutablePlexusContainer;
30  import org.codehaus.plexus.PlexusContainer;
31  import org.codehaus.plexus.component.annotations.Requirement;
32  import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
33  import org.codehaus.plexus.logging.Logger;
34  
35  import java.util.ArrayList;
36  import java.util.LinkedHashMap;
37  import java.util.List;
38  import java.util.Map;
39  import java.util.Properties;
40  import org.apache.maven.model.building.ModelProblemCollectorRequest;
41  
42  /**
43   * DefaultProfileManager
44   */
45  @Deprecated
46  public class DefaultProfileManager
47      implements ProfileManager
48  {
49  
50      @Requirement
51      private Logger logger;
52  
53      @Requirement
54      private ProfileSelector profileSelector;
55  
56      private List<String> activatedIds = new ArrayList<>();
57  
58      private List<String> deactivatedIds = new ArrayList<>();
59  
60      private List<String> defaultIds = new ArrayList<>();
61  
62      private Map<String, Profile> profilesById = new LinkedHashMap<>();
63  
64      private Properties requestProperties;
65  
66      /**
67       * @deprecated without passing in the system properties, the SystemPropertiesProfileActivator will not work
68       *             correctly in embedded environments.
69       */
70      @Deprecated
71      public DefaultProfileManager( PlexusContainer container )
72      {
73          this( container, null );
74      }
75  
76      /**
77       * the properties passed to the profile manager are the props that
78       * are passed to maven, possibly containing profile activator properties
79       *
80       */
81      public DefaultProfileManager( PlexusContainer container, Properties props )
82      {
83          try
84          {
85              this.profileSelector = container.lookup( ProfileSelector.class );
86              this.logger = ( (MutablePlexusContainer) container ).getLogger();
87          }
88          catch ( ComponentLookupException e )
89          {
90              throw new IllegalStateException( e );
91          }
92          this.requestProperties = props;
93      }
94  
95      public Properties getRequestProperties()
96      {
97          return requestProperties;
98      }
99  
100     public Map<String, Profile> getProfilesById()
101     {
102         return profilesById;
103     }
104 
105     /* (non-Javadoc)
106     * @see org.apache.maven.profiles.ProfileManager#addProfile(org.apache.maven.model.Profile)
107     */
108     public void addProfile( Profile profile )
109     {
110         String profileId = profile.getId();
111 
112         Profile existing = profilesById.get( profileId );
113         if ( existing != null )
114         {
115             logger.warn( "Overriding profile: \'" + profileId + "\' (source: " + existing.getSource()
116                 + ") with new instance from source: " + profile.getSource() );
117         }
118 
119         profilesById.put( profile.getId(), profile );
120 
121         Activation activation = profile.getActivation();
122 
123         if ( activation != null && activation.isActiveByDefault() )
124         {
125             activateAsDefault( profileId );
126         }
127     }
128 
129     /* (non-Javadoc)
130     * @see org.apache.maven.profiles.ProfileManager#explicitlyActivate(java.lang.String)
131     */
132     public void explicitlyActivate( String profileId )
133     {
134         if ( !activatedIds.contains( profileId ) )
135         {
136             logger.debug( "Profile with id: \'" + profileId + "\' has been explicitly activated." );
137 
138             activatedIds.add( profileId );
139         }
140     }
141 
142     /* (non-Javadoc)
143     * @see org.apache.maven.profiles.ProfileManager#explicitlyActivate(java.util.List)
144     */
145     public void explicitlyActivate( List<String> profileIds )
146     {
147         for ( String profileId1 : profileIds )
148         {
149             explicitlyActivate( profileId1 );
150         }
151     }
152 
153     /* (non-Javadoc)
154     * @see org.apache.maven.profiles.ProfileManager#explicitlyDeactivate(java.lang.String)
155     */
156     public void explicitlyDeactivate( String profileId )
157     {
158         if ( !deactivatedIds.contains( profileId ) )
159         {
160             logger.debug( "Profile with id: \'" + profileId + "\' has been explicitly deactivated." );
161 
162             deactivatedIds.add( profileId );
163         }
164     }
165 
166     /* (non-Javadoc)
167     * @see org.apache.maven.profiles.ProfileManager#explicitlyDeactivate(java.util.List)
168     */
169     public void explicitlyDeactivate( List<String> profileIds )
170     {
171         for ( String profileId1 : profileIds )
172         {
173             explicitlyDeactivate( profileId1 );
174         }
175     }
176 
177     /* (non-Javadoc)
178     * @see org.apache.maven.profiles.ProfileManager#getActiveProfiles()
179     */
180     public List getActiveProfiles()
181         throws ProfileActivationException
182     {
183         DefaultProfileActivationContext context = new DefaultProfileActivationContext();
184         context.setActiveProfileIds( activatedIds );
185         context.setInactiveProfileIds( deactivatedIds );
186         context.setSystemProperties( System.getProperties() );
187         context.setUserProperties( requestProperties );
188 
189         final List<ProfileActivationException> errors = new ArrayList<>();
190 
191         List<Profile> profiles =
192             profileSelector.getActiveProfiles( profilesById.values(), context, new ModelProblemCollector()
193             {
194 
195                 public void add( ModelProblemCollectorRequest req )
196                 {
197                     if ( !ModelProblem.Severity.WARNING.equals( req.getSeverity() ) )
198                     {
199                         errors.add( new ProfileActivationException( req.getMessage(), req.getException() ) );
200                     }
201                 }
202             } );
203 
204         if ( !errors.isEmpty() )
205         {
206             throw errors.get( 0 );
207         }
208 
209         return profiles;
210     }
211 
212     /* (non-Javadoc)
213      * @see org.apache.maven.profiles.ProfileManager#addProfiles(java.util.List)
214      */
215     public void addProfiles( List<Profile> profiles )
216     {
217         for ( Profile profile1 : profiles )
218         {
219             addProfile( profile1 );
220         }
221     }
222 
223     public void activateAsDefault( String profileId )
224     {
225         if ( !defaultIds.contains( profileId ) )
226         {
227             defaultIds.add( profileId );
228         }
229     }
230 
231     public List<String> getExplicitlyActivatedIds()
232     {
233         return activatedIds;
234     }
235 
236     public List<String>  getExplicitlyDeactivatedIds()
237     {
238         return deactivatedIds;
239     }
240 
241     public List getIdsActivatedByDefault()
242     {
243         return defaultIds;
244     }
245 
246 }