src/edu/internet2/middleware/shibboleth/common/ShibResource.java

   1 /*
   2  * The Shibboleth License, Version 1.
   3  * Copyright (c) 2002
   4  * University Corporation for Advanced Internet Development, Inc.
   5  * All rights reserved
   6  *
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * Redistributions of source code must retain the above copyright notice, this
  12  * list of conditions and the following disclaimer.
  13  *
  14  * Redistributions in binary form must reproduce the above copyright notice,
  15  * this list of conditions and the following disclaimer in the documentation
  16  * and/or other materials provided with the distribution, if any, must include
  17  * the following acknowledgment: "This product includes software developed by
  18  * the University Corporation for Advanced Internet Development
  19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
  20  * may appear in the software itself, if and wherever such third-party
  21  * acknowledgments normally appear.
  22  *
  23  * Neither the name of Shibboleth nor the names of its contributors, nor
  24  * Internet2, nor the University Corporation for Advanced Internet Development,
  25  * Inc., nor UCAID may be used to endorse or promote products derived from this
  26  * software without specific prior written permission. For written permission,
  27  * please contact shibboleth@shibboleth.org
  28  *
  29  * Products derived from this software may not be called Shibboleth, Internet2,
  30  * UCAID, or the University Corporation for Advanced Internet Development, nor
  31  * may Shibboleth appear in their name, without prior written permission of the
  32  * University Corporation for Advanced Internet Development.
  33  *
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
  39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
  40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
  41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
  42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  48  */
  49
  50 package edu.internet2.middleware.shibboleth.common;
  51
  52 import java.io.File;
  53 import java.io.IOException;
  54 import java.io.InputStream;
  55 import java.net.MalformedURLException;
  56 import java.net.URI;
  57 import java.net.URISyntaxException;
  58 import java.net.URL;
  59
  60 /**
  61  * Manages access to shibboleth file-based resources in a consistent fashion.
  62  */
  63 public class ShibResource {
  64
  65         private URL resource;
  66         public ShibResource(String name) throws ResourceNotAvailableException {
  67                 this(name, Object.class);
  68         }
  69
  70         public ShibResource(String name, Class requester) throws ResourceNotAvailableException {
  71                 try {
  72                         resource = new URL(name);
  73                 } catch (MalformedURLException e) {
  74                         resource = requester.getResource(name);
  75                 }
  76                 if (resource == null) {
  77                         throw new ResourceNotAvailableException("ShibResource could not be found at the specified location.");
  78                 }
  79         }
  80
  81         /**
  82          * Returns an input stream to read the resource contents
  83          */
  84         public InputStream getInputStream() throws IOException {
  85                 return resource.openStream();
  86         }
  87
  88         /**
  89          * Returns a <code>File</code> representation of the resource
  90          */
  91         public File getFile() throws IOException {
  92                 try {
  93                         File file = new File(new URI(resource.toString().replaceAll("\\s", "%20")));
  94                         return file;
  95                 } catch (URISyntaxException e) {
  96                         throw new ResourceNotAvailableException("File could not be loaded from specified resource: " + e);
  97                 } catch (IllegalArgumentException e) {
  98                         throw new ResourceNotAvailableException("File could not be loaded from specified resource: " + e);
  99                 }
 100         }
 101
 102         /**
 103          * Returns a <code>URL</code> pointer to the resource
 104          */
 105         public URL getURL() throws IOException {
 106                 return resource;
 107         }
 108
 109         public class ResourceNotAvailableException extends IOException {
 110
 111                 public ResourceNotAvailableException(String message) {
 112                         super(message);
 113                 }
 114         }
 115
 116 }