PluggableArchivists


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23  
24  package com.sun.enterprise.deployment.archivist;
25  
26  import com.sun.enterprise.deployment.deploy.shared.AbstractArchive;
27  
28  import java.io.File  ;
29  import java.io.IOException  ;
30  import javax.enterprise.deploy.shared.ModuleType  ;
31  
32  /**
33   * This interface defines APIs to plug new archivists inside the 
34   * DOL library. By default, the DOL will use the ArchivistFactory
35   * to instanciate new archivists but if a implementation of this 
36   * class is registered, the DOL with use that one.
37   *
38   * @author Jerome Dochez
39   */
40  public interface PluggableArchivists {
41      
42      /** 
43       * @return a new Archivist implementation for the type passed. 
44       * Supported types are defined in the application.xml DTD 
45       */
46      public Archivist getArchivistForType(ModuleType   type);
47      
48      /** 
49       * @return a new Archivist implementation for the archive file type
50       * Supported J2EE modules are defined in the J2EE platform spec
51       */
52      public Archivist getArchivistForArchive(File   jarFileOrDirectory) throws IOException  ;
53      
54      /** 
55       * @return a new Archivist implementation for the archive file type
56       * Supported J2EE modules are defined in the J2EE platform spec
57       */
58      public Archivist getArchivistForArchive(String   path) throws IOException  ;
59      
60      /** 
61       * @return a new Archivist implementation for the archive file type
62       * Supported J2EE modules are defined in the J2EE platform spec
63       */
64      public Archivist getArchivistForArchive(AbstractArchive archive) throws IOException  ;       
65      
66  }
67
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags