| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| VfsScriptService | 40 | 3 | 0% | 2 | 0 |
| 1 | /* | |
| 2 | * See the NOTICE file distributed with this work for additional | |
| 3 | * information regarding copyright ownership. | |
| 4 | * | |
| 5 | * This is free software; you can redistribute it and/or modify it | |
| 6 | * under the terms of the GNU Lesser General Public License as | |
| 7 | * published by the Free Software Foundation; either version 2.1 of | |
| 8 | * the License, or (at your option) any later version. | |
| 9 | * | |
| 10 | * This software is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 | * Lesser General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU Lesser General Public | |
| 16 | * License along with this software; if not, write to the Free | |
| 17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
| 18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
| 19 | */ | |
| 20 | package org.xwiki.vfs.script; | |
| 21 | ||
| 22 | import javax.inject.Inject; | |
| 23 | import javax.inject.Named; | |
| 24 | import javax.inject.Singleton; | |
| 25 | ||
| 26 | import org.xwiki.component.annotation.Component; | |
| 27 | import org.xwiki.script.service.ScriptService; | |
| 28 | import org.xwiki.vfs.VfsManager; | |
| 29 | import org.xwiki.vfs.VfsResourceReference; | |
| 30 | ||
| 31 | /** | |
| 32 | * Offers scripting APIs for the VFS module. | |
| 33 | * | |
| 34 | * @version $Id: af1f34967cb41262fd23ec8af5aaac4f2fe4007e $ | |
| 35 | * @since 7.4M2 | |
| 36 | */ | |
| 37 | @Component | |
| 38 | @Named("vfs") | |
| 39 | @Singleton | |
| 40 | public class VfsScriptService implements ScriptService | |
| 41 | { | |
| 42 | @Inject | |
| 43 | private VfsManager vfsManager; | |
| 44 | ||
| 45 | /** | |
| 46 | * Generate a relative VFS URL to access a resource inside an archive. | |
| 47 | * | |
| 48 | * @param reference the reference to a file inside a an archive. | |
| 49 | * For example {@code attach:space.page@my.zip/path/to/file}. | |
| 50 | * @return a relative URL that can be used to access the content of a file inside an archive (ZIP, EAR, TAR.GZ, etc) | |
| 51 | * or null if the URL couldn't be constructed | |
| 52 | */ | |
| 53 | 4 | public String url(VfsResourceReference reference) |
| 54 | { | |
| 55 | 4 | try { |
| 56 | 4 | return this.vfsManager.getURL(reference); |
| 57 | } catch (Exception e) { | |
| 58 | 1 | return null; |
| 59 | } | |
| 60 | } | |
| 61 | } |