View Javadoc
1   /*
2    * Copyright 2012 Brian Matthews
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package com.btmatthews.maven.plugins.crx;
18  
19  import java.io.File;
20  import java.io.IOException;
21  
22  /**
23   * Implementations read and write CRX archives.
24   *
25   * @author <a href="mailto:brian@btmatthews.com">Brian Matthews</a>
26   * @since 1.1.0
27   */
28  public interface ArchiveHelper {
29  
30      /**
31       * Generate the CRX file writing the header, public key, signature and data.
32       *
33       * @param crxFile    The target CRX file.
34       * @param crxArchive The CRX archive.
35       * @throws IOException If there was an error writing the CRX file.
36       */
37      void writeArchive(File crxFile, CRXArchive crxArchive) throws IOException;
38  
39      /**
40       * Read the CRX archive from a file loading the header, public key, signature and data.
41       *
42       * @param crxFile The source CRX file.
43       * @return The CRX archive.
44       * @throws IOException If there was an error reading the CRX file.
45       */
46      CRXArchive readArchive(File crxFile) throws IOException;
47  }