Coverage Report

Coverage Report - fr.paris.lutece.plugins.blobstore.business.filesystem.IFileSystemBlobStoreHome

Classes in this File

 /*
  * Copyright (c) 2002-2014, Mairie de Paris
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  *  1. Redistributions of source code must retain the above copyright notice
  *     and the following disclaimer.
  *
  *  2. Redistributions in binary form must reproduce the above copyright notice
  *     and the following disclaimer in the documentation and/or other materials
  *     provided with the distribution.
  *
  *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
  *     contributors may be used to endorse or promote products derived from
  *     this software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  *
  * License 1.0
  */
 package fr.paris.lutece.plugins.blobstore.business.filesystem;
 
 import fr.paris.lutece.plugins.blobstore.business.BytesBlobStore;
 import fr.paris.lutece.plugins.blobstore.business.InputStreamBlobStore;
 
 import java.io.IOException;
 import java.io.InputStream;
 
 
 /**
  * The Interface IFileSystemBlobStoreHome.
  */
 public interface IFileSystemBlobStoreHome
 {
     /**
      * Creation of an instance of record physical file.
      *
      * @param blobStore The instance of the physical file which contains the
      *            informations to store
      * @param strBasePath base directory
      * @param depth the depth
      * @throws IOException ioe
      * @throws FileAlreadyExistsException already exists
      */
     void create( final BytesBlobStore blobStore, final String strBasePath, final Integer depth )
         throws IOException, FileAlreadyExistsException;
 
     /**
      * Update of physical file which is specified in parameter.
      *
      * @param blobStore the blob store
      * @param strBasePath base directory
      * @param depth the depth
      * @throws IOException ioe
      */
     void update( final BytesBlobStore blobStore, final String strBasePath, final Integer depth )
         throws IOException;
 
     /**
      * Update of physical file which is specified in parameter.
      *
      * @param blobStore The instance of the record physicalFile which contains
      *            the informations to update
      * @param strBasePath base directory
      * @param depth the depth
      * @throws IOException ioe
      */
     void updateInputStream( final InputStreamBlobStore blobStore, final String strBasePath, final Integer depth )
         throws IOException;
 
     /**
      * Delete the physical file whose identifier is specified in parameter.
      *
      * @param strKey The identifier of the record physical file
      * @param strBasePath base directory
      * @param depth the depth
      * @return <code>true</code> if the file is removed, <code>false</code>
      *         otherwise.
      * @throws IOException ioe
      */
     boolean remove( final String strKey, final String strBasePath, final Integer depth )
         throws IOException;
 
     /**
      * Returns an instance of a physical file whose identifier is specified in
      * parameter.
      *
      * @param strKey The file primary key
      * @param strBasePath base directory
      * @param depth the depth
      * @return an instance of physical file
      * @throws IOException ioe
      */
     BytesBlobStore findByPrimaryKey( final String strKey, final String strBasePath, final Integer depth )
         throws IOException;
 
     /**
      * Returns an instance of a physical file whose identifier is specified in
      * parameter.
      *
      * @param strKey The file primary key
      * @param strBasePath base directory
      * @param depth the depth
      * @return an instance of physical file
      * @throws IOException ioe
      */
     InputStream findByPrimaryKeyInputStream( final String strKey, final String strBasePath, final Integer depth )
         throws IOException;
 
     /**
      * Creation of an instance of record physical file.
      *
      * @param blobStore The instance of the physical file which contains the
      *            inputstream to store
      * @param strBasePath base directory
      * @param depth the depth
      * @throws FileAlreadyExistsException already exists
      * @throws IOException ioe
      */
     void createInputStream( final InputStreamBlobStore blobStore, final String strBasePath, final Integer depth )
         throws FileAlreadyExistsException, IOException;
 }

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.business.filesystem;
35
36		import fr.paris.lutece.plugins.blobstore.business.BytesBlobStore;
37		import fr.paris.lutece.plugins.blobstore.business.InputStreamBlobStore;
38
39		import java.io.IOException;
40		import java.io.InputStream;
41
42
43		/**
44		* The Interface IFileSystemBlobStoreHome.
45		*/
46		public interface IFileSystemBlobStoreHome
47		{
48		/**
49		* Creation of an instance of record physical file.
50		*
51		* @param blobStore The instance of the physical file which contains the
52		* informations to store
53		* @param strBasePath base directory
54		* @param depth the depth
55		* @throws IOException ioe
56		* @throws FileAlreadyExistsException already exists
57		*/
58		void create( final BytesBlobStore blobStore, final String strBasePath, final Integer depth )
59		throws IOException, FileAlreadyExistsException;
60
61		/**
62		* Update of physical file which is specified in parameter.
63		*
64		* @param blobStore the blob store
65		* @param strBasePath base directory
66		* @param depth the depth
67		* @throws IOException ioe
68		*/
69		void update( final BytesBlobStore blobStore, final String strBasePath, final Integer depth )
70		throws IOException;
71
72		/**
73		* Update of physical file which is specified in parameter.
74		*
75		* @param blobStore The instance of the record physicalFile which contains
76		* the informations to update
77		* @param strBasePath base directory
78		* @param depth the depth
79		* @throws IOException ioe
80		*/
81		void updateInputStream( final InputStreamBlobStore blobStore, final String strBasePath, final Integer depth )
82		throws IOException;
83
84		/**
85		* Delete the physical file whose identifier is specified in parameter.
86		*
87		* @param strKey The identifier of the record physical file
88		* @param strBasePath base directory
89		* @param depth the depth
90		* @return <code>true</code> if the file is removed, <code>false</code>
91		* otherwise.
92		* @throws IOException ioe
93		*/
94		boolean remove( final String strKey, final String strBasePath, final Integer depth )
95		throws IOException;
96
97		/**
98		* Returns an instance of a physical file whose identifier is specified in
99		* parameter.
100		*
101		* @param strKey The file primary key
102		* @param strBasePath base directory
103		* @param depth the depth
104		* @return an instance of physical file
105		* @throws IOException ioe
106		*/
107		BytesBlobStore findByPrimaryKey( final String strKey, final String strBasePath, final Integer depth )
108		throws IOException;
109
110		/**
111		* Returns an instance of a physical file whose identifier is specified in
112		* parameter.
113		*
114		* @param strKey The file primary key
115		* @param strBasePath base directory
116		* @param depth the depth
117		* @return an instance of physical file
118		* @throws IOException ioe
119		*/
120		InputStream findByPrimaryKeyInputStream( final String strKey, final String strBasePath, final Integer depth )
121		throws IOException;
122
123		/**
124		* Creation of an instance of record physical file.
125		*
126		* @param blobStore The instance of the physical file which contains the
127		* inputstream to store
128		* @param strBasePath base directory
129		* @param depth the depth
130		* @throws FileAlreadyExistsException already exists
131		* @throws IOException ioe
132		*/
133		void createInputStream( final InputStreamBlobStore blobStore, final String strBasePath, final Integer depth )
134		throws FileAlreadyExistsException, IOException;
135		}