View Javadoc

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 java.io.InputStream;
37  import java.io.Serializable;
38  
39  
40  /**
41   * Blob Store Service Interface. <i>*InputStream</i> methods should be used for very large blobs.
42   */
43  public interface IBlobStoreService extends Serializable
44  {
45      /**
46       * Store a blob
47       * @param blob The blob
48       * @return The key of the blob
49       */
50      String store( byte[] blob );
51  
52      /**
53       * Stores an input stream
54       * @param inputStream the input stream
55       * @return The key of the blob
56       */
57      String storeInputStream( InputStream inputStream );
58  
59      /**
60       * Get a blob
61       * @param strKey The key of the blob
62       * @return  The blob
63       */
64      byte[] getBlob( String strKey );
65  
66      /**
67       * Gets a blob as {@link InputStream}
68       * @param strKey the key
69       * @return the {@link InputStream}
70       */
71      InputStream getBlobInputStream( String strKey );
72  
73      /**
74       * Update a blob
75       * @param strKey The key of the blob
76       * @param blob The new blob
77       */
78      void update( String strKey, byte[] blob );
79  
80      /**
81       * Updates a blob key with the inputstream
82       * @param strKey the blob key
83       * @param inputStream the input stream
84       */
85      void updateInputStream( String strKey, InputStream inputStream );
86  
87      /**
88       * Delete a blob
89       * @param strKey The key of the blob
90       */
91      void delete( String strKey );
92  
93      /**
94       * Gets the blob URL.
95       *
96       * @param strKey the str key
97       * @return the blob url
98       */
99      String getBlobUrl( String strKey );
100 
101     /**
102      * Gets the file download url (for {@link BlobStoreFileItem})
103      * @param strKey the
104      * @return the download link
105      */
106     String getFileUrl( String strKey );
107 
108     /**
109      * Gets the blobstore name
110      * @return the blobstore name
111      */
112     String getName(  );
113 
114     /**
115      * Sets the blobstore name
116      * @param strName the name
117      */
118     void setName( String strName );
119 }