Coverage Report - fr.paris.lutece.plugins.blobstore.service.IBlobStoreClientService
 
Classes in this File Line Coverage Branch Coverage Complexity
IBlobStoreClientService
N/A
N/A
1
 
 1  
 /*
 2  
  * Copyright (c) 2002-2014, Mairie de Paris
 3  
  * All rights reserved.
 4  
  *
 5  
  * Redistribution and use in source and binary forms, with or without
 6  
  * modification, are permitted provided that the following conditions
 7  
  * are met:
 8  
  *
 9  
  *  1. Redistributions of source code must retain the above copyright notice
 10  
  *     and the following disclaimer.
 11  
  *
 12  
  *  2. Redistributions in binary form must reproduce the above copyright notice
 13  
  *     and the following disclaimer in the documentation and/or other materials
 14  
  *     provided with the distribution.
 15  
  *
 16  
  *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 17  
  *     contributors may be used to endorse or promote products derived from
 18  
  *     this software without specific prior written permission.
 19  
  *
 20  
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 21  
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 22  
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 23  
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 24  
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 25  
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 26  
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 27  
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 28  
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 29  
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 30  
  * POSSIBILITY OF SUCH DAMAGE.
 31  
  *
 32  
  * License 1.0
 33  
  */
 34  
 package fr.paris.lutece.plugins.blobstore.service;
 35  
 
 36  
 import org.apache.commons.fileupload.FileItem;
 37  
 
 38  
 
 39  
 /**
 40  
  *
 41  
  * IBlobStoreClientService
 42  
  *
 43  
  */
 44  
 public interface IBlobStoreClientService
 45  
 {
 46  
     /**
 47  
     * Get the file name given an url
 48  
     * @param strUrl the url
 49  
     * @return the file name
 50  
     * @throws BlobStoreClientException exception if there is an issue
 51  
     */
 52  
     String getFileName( String strUrl ) throws BlobStoreClientException;
 53  
 
 54  
     /**
 55  
      * Do delete a file in the blobstore webapp
 56  
      * @param strBaseUrl the base url
 57  
      * @param strBlobStore the blobstore service name
 58  
      * @param strBlobKey the blob key
 59  
      * @return the deleted blob key
 60  
      * @throws BlobStoreClientException exception if there is an issue
 61  
      */
 62  
     String doDeleteFile( String strBaseUrl, String strBlobStore, String strBlobKey )
 63  
         throws BlobStoreClientException;
 64  
 
 65  
     /**
 66  
      * Do upload a file in the blobstore webapp
 67  
      * @param strBaseUrl the base url
 68  
      * @param fileItem the file to upload
 69  
      * @param strBlobStore the blobstore service name
 70  
      * @return the uploaded file blob key
 71  
      * @throws BlobStoreClientException exception if there is an issue
 72  
      */
 73  
     String doUploadFile( String strBaseUrl, FileItem fileItem, String strBlobStore )
 74  
         throws BlobStoreClientException;
 75  
 
 76  
     /**
 77  
      * Get the file url
 78  
      * @param strBaseUrl the base url
 79  
      * @param strBlobStore the blobstore service name
 80  
      * @param strBlobKey the blob key
 81  
      * @return the file url
 82  
      * @throws BlobStoreClientException exception if there is an issue
 83  
      */
 84  
     String getFileUrl( String strBaseUrl, String strBlobStore, String strBlobKey )
 85  
         throws BlobStoreClientException;
 86  
 
 87  
     /**
 88  
      * Download the file to the file path
 89  
      * @param strUrl the url of the file
 90  
      * @param strFilePath the file path
 91  
      * @throws BlobStoreClientException exception if there is an error
 92  
      */
 93  
     void doDownloadFile( String strUrl, String strFilePath )
 94  
         throws BlobStoreClientException;
 95  
 
 96  
     /**
 97  
      * Download the file
 98  
      * @param strUrl the url of the file
 99  
      * @return a {@link FileItem}
 100  
      * @throws BlobStoreClientException exception if there is an error
 101  
      */
 102  
     FileItem doDownloadFile( String strUrl ) throws BlobStoreClientException;
 103  
 }