SamplePatch


1   /*
2    * Copyright (C) 2005 Alfresco, Inc.
3    *
4    * Licensed under the Mozilla Public License version 1.1 
5    * with a permitted attribution clause. You may obtain a
6    * copy of the License at
7    *
8    *   http://www.alfresco.org/legal/license.txt
9    *
10   * Unless required by applicable law or agreed to in writing,
11   * software distributed under the License is distributed on an
12   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific
14   * language governing permissions and limitations under the
15   * License.
16   */
17  package org.alfresco.repo.admin.patch;
18  
19  import org.alfresco.service.transaction.TransactionService;
20  
21  public class SamplePatch extends AbstractPatch
22  {
23      public static final String   MSG_SUCCESS = "SamplePatch applied successfully";
24      public static final String   MSG_FAILURE = "SamplePatch failed to apply";
25      
26      private boolean mustFail;
27  
28      /**
29       * Default constructor for Spring config
30       */
31      public SamplePatch()
32      {
33      }
34      
35      /**
36       * Overrides the base class version to do nothing, i.e. it does not self-register
37       */
38      @Override  
39      public void init()
40      {
41      }
42      
43      /**
44       * Helper constructor for some tests.  Default properties are set automatically.
45       * 
46       * @param mustFail true if this instance must always fail to apply
47       */
48      /* protected */ SamplePatch(boolean mustFail, TransactionService transactionService)
49      {
50          this.mustFail = mustFail;
51          setTransactionService(transactionService);
52          setId("SamplePatch");
53          setDescription("This is a sample patch");
54          setFixesFromSchema(0);
55          setFixesToSchema(1000);
56          setTargetSchema(1001);
57      }
58      
59      /**
60       * Does nothing
61       * 
62       * @return Returns a success or failure message dependent on the constructor used
63       */
64      @Override  
65      protected String   applyInternal() throws Exception  
66      {
67          if (mustFail)
68          {
69              throw new Exception  (MSG_FAILURE);
70          }
71          else
72          {
73              return MSG_SUCCESS;
74          }
75      }
76  }
77
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags