View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.scm.command.tag;
20  
21  import org.apache.maven.scm.CommandParameter;
22  import org.apache.maven.scm.CommandParameters;
23  import org.apache.maven.scm.CommandParameters.SignOption;
24  import org.apache.maven.scm.ScmException;
25  import org.apache.maven.scm.ScmFileSet;
26  import org.apache.maven.scm.ScmResult;
27  import org.apache.maven.scm.ScmTagParameters;
28  import org.apache.maven.scm.command.AbstractCommand;
29  import org.apache.maven.scm.provider.ScmProviderRepository;
30  
31  /**
32   * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
33   * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
34   */
35  public abstract class AbstractTagCommand extends AbstractCommand {
36      /**
37       * @param repository TODO
38       * @param fileSet TODO
39       * @param tagName TODO
40       * @param message TODO
41       * @return TODO
42       * @throws ScmException if any
43       * @deprecated use method {@link #executeTagCommand(ScmProviderRepository, ScmFileSet, String, ScmTagParameters)}
44       */
45      protected ScmResult executeTagCommand(
46              ScmProviderRepository repository, ScmFileSet fileSet, String tagName, String message) throws ScmException {
47          return executeTagCommand(repository, fileSet, tagName, new ScmTagParameters(message));
48      }
49  
50      protected abstract ScmResult executeTagCommand(
51              ScmProviderRepository repository, ScmFileSet fileSet, String tagName, ScmTagParameters scmTagParameters)
52              throws ScmException;
53  
54      /**
55       * {@inheritDoc}
56       */
57      public ScmResult executeCommand(ScmProviderRepository repository, ScmFileSet fileSet, CommandParameters parameters)
58              throws ScmException {
59          String tagName = parameters.getString(CommandParameter.TAG_NAME);
60  
61          ScmTagParameters scmTagParameters = parameters.getScmTagParameters(CommandParameter.SCM_TAG_PARAMETERS);
62  
63          String message = parameters.getString(CommandParameter.MESSAGE, null);
64  
65          if (message != null) {
66              // if message was passed by CommandParameter.MESSAGE then use it.
67              scmTagParameters.setMessage(message);
68          }
69  
70          if (scmTagParameters.getMessage() == null) {
71              // if message hasn't been passed nor by ScmTagParameters nor by CommandParameter.MESSAGE then use default.
72              scmTagParameters.setMessage("[maven-scm] copy for tag " + tagName);
73          }
74  
75          SignOption signOption = parameters.getSignOption(CommandParameter.SIGN_OPTION);
76          if (signOption != null) {
77              scmTagParameters.setSignOption(signOption);
78          }
79          return executeTagCommand(repository, fileSet, tagName, scmTagParameters);
80      }
81  }