View Javadoc
1   package org.apache.maven.plugins.help;
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 java.io.IOException;
23  import java.util.List;
24  import java.util.Map;
25  
26  import org.apache.commons.lang3.time.DateFormatUtils;
27  import org.apache.maven.plugin.MojoExecutionException;
28  import org.apache.maven.plugins.annotations.Mojo;
29  import org.apache.maven.plugins.annotations.Parameter;
30  import org.apache.maven.project.MavenProject;
31  
32  /**
33   * Displays a list of the profiles which are currently active for this build.
34   *
35   * @since 2.0
36   */
37  @Mojo( name = "active-profiles", aggregator = true )
38  public class ActiveProfilesMojo
39      extends AbstractHelpMojo
40  {
41      // ----------------------------------------------------------------------
42      // Mojo parameters
43      // ----------------------------------------------------------------------
44  
45      /**
46       * This is the list of projects currently slated to be built by Maven.
47       */
48      @Parameter( defaultValue = "${reactorProjects}", required = true, readonly = true )
49      private List<MavenProject> projects;
50  
51      // ----------------------------------------------------------------------
52      // Public methods
53      // ----------------------------------------------------------------------
54  
55      /** {@inheritDoc} */
56      public void execute()
57          throws MojoExecutionException
58      {
59          StringBuilder message = new StringBuilder();
60  
61          for ( MavenProject project : projects )
62          {
63              getActiveProfileStatement( project, message );
64  
65              message.append( LS ).append( LS );
66          }
67  
68          if ( output != null )
69          {
70              String formattedDateTime = DateFormatUtils.ISO_8601_EXTENDED_DATETIME_TIME_ZONE_FORMAT
71                  .format( System.currentTimeMillis() );
72              StringBuilder sb = new StringBuilder();
73              sb.append( "Created by: " ).append( getClass().getName() ).append( LS );
74              sb.append( "Created on: " ).append( formattedDateTime ).append( LS ).append( LS );
75              sb.append( message.toString() );
76  
77              try
78              {
79                  writeFile( output, sb );
80              }
81              catch ( IOException e )
82              {
83                  throw new MojoExecutionException( "Cannot write active profiles to output: " + output, e );
84              }
85  
86              getLog().info( "Active profile report written to: " + output );
87          }
88          else
89          {
90              getLog().info( message );
91          }
92      }
93  
94      // ----------------------------------------------------------------------
95      // Private methods
96      // ----------------------------------------------------------------------
97  
98      /**
99       * Method to get the active profiles for the project
100      *
101      * @param project   the current project
102      * @param message   the object where the information will be appended to
103      */
104     private void getActiveProfileStatement( MavenProject project, StringBuilder message )
105     {
106         Map<String, List<String>> activeProfileIds = project.getInjectedProfileIds();
107 
108         message.append( LS );
109         message.append( "Active Profiles for Project \'" ).append( project.getId() ).append( "\':" );
110         message.append( LS ).append( LS );
111 
112         if ( activeProfileIds.isEmpty() )
113         {
114             message.append( "There are no active profiles." );
115         }
116         else
117         {
118             message.append( "The following profiles are active:" ).append( LS );
119 
120             for ( Map.Entry<String, List<String>> entry : activeProfileIds.entrySet() )
121             {
122                 for ( String profileId : entry.getValue() )
123                 {
124                     message.append( LS ).append( " - " ).append( profileId );
125                     message.append( " (source: " ).append( entry.getKey() ).append( ")" );
126                 }
127             }
128         }
129 
130         message.append( LS );
131     }
132 
133 }