VFSContextFactory


1   /*
2    * JBoss, Home of Professional Open Source
3    * Copyright 2005, JBoss Inc., and individual contributors as indicated
4    * by the @authors tag. See the copyright.txt in the distribution for a
5    * full listing of individual contributors.
6    *
7    * This is free software; you can redistribute it and/or modify it
8    * under the terms of the GNU Lesser General Public License as
9    * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22  package org.jboss.virtual.spi;
23  
24  import java.net.URI  ;
25  import java.net.URL  ;
26  import java.io.IOException  ;
27  
28  /**
29   * The entry point to obtaining a VFSContext for a given URL/URI root mount point
30   *
31   * @author Scott.Stark@jboss.org
32   * @author adrian@jboss.org
33   * @version $Revision: 44217 $
34   */
35  public interface VFSContextFactory
36  {
37     /**
38      * Get the URL protocols/URI schemes this factory supports
39      * 
40      * @return list of supported protocols.
41      */
42     String  [] getProtocols();
43  
44     /**
45      * Obtain a vfs context for the given root url.
46      * 
47      * @param rootURL - the URL for the root of the virtual context
48      * @return the vfs context
49      * @throws IOException - thrown if the root cannot be opened/accessed
50      */
51     VFSContext getVFS(URL   rootURL) throws IOException  ;
52     /**
53      * Obtain a vfs context for the given root uri.
54      * 
55      * @param rootURI - the URI for the root of the virtual context
56      * @return the vfs context
57      * @throws IOException - thrown if the root cannot be opened/accessed
58      */
59     VFSContext getVFS(URI   rootURI) throws IOException  ;
60  }
61
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags