|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectome.services.scripts.ScriptRepoHelper
public class ScriptRepoHelper
Strategy used by the ScriptRepository for registering, loading, and saving files.
Field Summary | |
---|---|
protected org.apache.commons.logging.Log |
log
|
static org.apache.commons.io.filefilter.IOFileFilter |
SCRIPT_FILTER
IOFileFilter instance used during iterate() to find the
matching scripts in the given directory. |
static String |
SCRIPT_REPO
Id used by all script repositories. |
Constructor Summary | |
---|---|
ScriptRepoHelper(Executor ex,
String sessionUuid,
Roles roles)
|
|
ScriptRepoHelper(File dir,
Executor ex,
Principal p,
Roles roles)
|
|
ScriptRepoHelper(String uuid,
File dir,
Executor ex,
Principal p,
Roles roles)
|
Method Summary | |
---|---|
ome.model.core.OriginalFile |
addOrReplace(RepoFile repoFile,
Long old)
|
protected ome.model.core.OriginalFile |
addOrReplace(ome.util.SqlAction sqlAction,
ServiceFactory sf,
RepoFile repoFile,
Long old)
|
int |
countInDb()
|
int |
countInDb(ome.util.SqlAction sql)
|
int |
countOnDisk()
Returns the number of files which match SCRIPT_FILTER in
dir . |
boolean |
delete(long id)
|
Long |
findInDb(RepoFile file,
boolean scriptsOnly)
|
Long |
findInDb(ome.util.SqlAction sql,
RepoFile repoFile,
boolean scriptsOnly)
Looks to see if a path is contained in the repository. |
Long |
findInDb(String path,
boolean scriptsOnly)
|
static String |
getDefaultScriptDir()
Directory which will be used as the root of this repository if no directory is passed to a constructor. |
String |
getScriptDir()
Returns the actual root of this repository. |
String |
getUuid()
Uuid of this repository. |
List<Long> |
idsInDb()
|
List<Long> |
idsInDb(ome.util.SqlAction sql)
|
boolean |
isInRepo(long id)
|
boolean |
isInRepo(ome.util.SqlAction sql,
long id)
|
Iterator<File> |
iterate()
|
ome.model.core.OriginalFile |
load(long id,
boolean check)
|
ome.model.core.OriginalFile |
load(long id,
org.hibernate.Session s,
ome.util.SqlAction sqlAction,
boolean check)
|
List<ome.model.core.OriginalFile> |
loadAll(boolean modificationCheck)
Walks all files in the repository (via iterate() and adds them
if not found in the database. |
void |
modificationCheck()
Checks if |
String |
read(String path)
|
long |
removeMissingFilesFromDb(ome.util.SqlAction sqlAction,
org.hibernate.Session session,
List<ome.model.core.OriginalFile> filesOnDisk)
Given the current files on disk, #unregister(Long, Session)
all files which have been removed from disk. |
protected void |
unregister(Long old,
ome.util.SqlAction sqlAction)
Unregisters a given file from the script repository by setting its Repo uuid to null. |
ome.model.core.OriginalFile |
update(RepoFile repoFile,
Long id)
|
RepoFile |
write(RepoFile repo,
String text)
|
RepoFile |
write(String path,
String text)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String SCRIPT_REPO
public static final org.apache.commons.io.filefilter.IOFileFilter SCRIPT_FILTER
IOFileFilter
instance used during iterate()
to find the
matching scripts in the given directory.
protected final org.apache.commons.logging.Log log
Constructor Detail |
---|
public ScriptRepoHelper(Executor ex, String sessionUuid, Roles roles)
#ScriptRepoHelper(String, File, Executor, Principal)
public ScriptRepoHelper(File dir, Executor ex, Principal p, Roles roles)
#ScriptRepoHelper(String, File, Executor, Principal)
public ScriptRepoHelper(String uuid, File dir, Executor ex, Principal p, Roles roles)
uuid
- Allows setting a non-default uuid for this script service.
Primarily for testing, since services rely on the repository
name for finding one another.dir
- The directory used by the repo as its root. Other constructors
use getDefaultScriptDir()
internally.ex
- p
- Method Detail |
---|
public static String getDefaultScriptDir()
public String getScriptDir()
getDefaultScriptDir()
public String getUuid()
SCRIPT_REPO
.
public int countOnDisk()
SCRIPT_FILTER
in
dir
. Uses iterate()
internally.
public int countInDb()
public int countInDb(ome.util.SqlAction sql)
public List<Long> idsInDb()
public List<Long> idsInDb(ome.util.SqlAction sql)
public boolean isInRepo(long id)
public boolean isInRepo(ome.util.SqlAction sql, long id)
public Long findInDb(String path, boolean scriptsOnly)
public Long findInDb(RepoFile file, boolean scriptsOnly)
public Long findInDb(ome.util.SqlAction sql, RepoFile repoFile, boolean scriptsOnly)
public Iterator<File> iterate()
public List<ome.model.core.OriginalFile> loadAll(boolean modificationCheck)
iterate()
and adds them
if not found in the database.
If modificationCheck is true, then a change in the sha1 for a file in
the repository will cause the old file to be removed from the repository
(uuid == null)and a new file created in its place.
modificationCheck
-
public ome.model.core.OriginalFile addOrReplace(RepoFile repoFile, Long old)
repoFile
- old
-
protected ome.model.core.OriginalFile addOrReplace(ome.util.SqlAction sqlAction, ServiceFactory sf, RepoFile repoFile, Long old)
public long removeMissingFilesFromDb(ome.util.SqlAction sqlAction, org.hibernate.Session session, List<ome.model.core.OriginalFile> filesOnDisk)
#unregister(Long, Session)
all files which have been removed from disk.
protected void unregister(Long old, ome.util.SqlAction sqlAction)
public ome.model.core.OriginalFile update(RepoFile repoFile, Long id)
public String read(String path) throws IOException
IOException
public RepoFile write(String path, String text) throws IOException
IOException
public RepoFile write(RepoFile repo, String text) throws IOException
IOException
public ome.model.core.OriginalFile load(long id, boolean check)
public ome.model.core.OriginalFile load(long id, org.hibernate.Session s, ome.util.SqlAction sqlAction, boolean check)
public void modificationCheck()
public boolean delete(long id)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Version: 4.3.4-dbcbce5a-b4
Copyright © 2009 The University of Dundee. All Rights Reserved.