|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The middleware level API for the File Catalog component. This is
the interface that this service exposes to the other middleware
components, which is not necessarily the final API seen by the
user.
Method Summary | |
void |
createFile(FCEntry[] entries)
Registers a new File Catalog entry with all status information specified. |
FCEntry[] |
getFileCatalogEntry(java.lang.String[] lfns)
Get the detailed metadata about LFNs. |
StringPair[] |
getGuidForLfn(java.lang.String[] lfns)
Retrieves list of guids for given Lfns. |
StringPair[] |
getLfnForGuid(java.lang.String[] guids)
Retrieves list of lfns for given guid. |
java.lang.String[] |
locate(java.lang.String startDir,
java.lang.String pattern,
long limit)
Returns list of matching LFNs from all subdirectories of the path given in the first argument. |
void |
mkdir(java.lang.String[] directories,
boolean createParents,
boolean copyPermFromParent)
Make a set of new directories. |
void |
mv(StringPair[] entries)
Renames a set of LFNs, symlinks or directories. |
FCEntry[] |
readDir(java.lang.String path,
java.lang.String pattern,
long limit,
long offset,
boolean withPermissions)
Read the directory given in the path argument, restricted to the pattern given in the second argument. |
void |
rmdir(java.lang.String[] directories)
Remove a directory. |
void |
symlink(StringPair[] symlinks,
boolean copyPermFromParent)
Create symlinks by passing source LFN (string1) and target LFN (string2) pairs. |
void |
unlink(java.lang.String[] lfns)
Delete an LFN, symlink or virtual directory. |
void |
updateModifyTime(java.lang.String[] lfns,
long time)
Update the modification time for the given entries. |
void |
updateValidityTime(java.lang.String[] lfns,
long time)
Update the validity time for the given entries. |
Methods inherited from interface org.glite.data.catalog.service.fas.FASBase |
checkPermission, getPermission, setPermission |
Methods inherited from interface org.glite.data.catalog.service.ServiceBase |
getInterfaceVersion, getSchemaVersion, getServiceMetadata, getVersion |
Method Detail |
public void mkdir(java.lang.String[] directories, boolean createParents, boolean copyPermFromParent) throws InternalException, InvalidArgumentException, AuthorizationException, ExistsException, NotExistsException
directories
- The entries in the directory. This may be null for normal directories
but is mandatory for virtual directories.
The entry names may also be 'short', i.e. not start with a '/'
in which case they will be treated as names in the local directory.createParents
- If set to true, instead of giving an error
if the parent directories do not exist, they will be created if
possible
AuthorizationException
- No access right to create a directory or one of the parents.
ExistsException
- The path or directory already exists.
NotExistsException
- One of the parent directories does not exists and
'createParents' is false.
InvalidArgumentException
- The path format is invalid
InternalException
- InvalidArgumentException
.
ExistsException
.
NotExistsException
.
AuthorizationException
.
public void rmdir(java.lang.String[] directories) throws InternalException, AuthorizationException, ExistsException, NotExistsException
directories
- The directory LFN to remove.
AuthorizationException
- No access right to remove a directory or an entry in it.
ExistsException
- The directory, to be removed, is not empty and 'recursive' flag is false.
NotExistsException
- The directory, to be removed, does not exits.
InvalidArgumentException
- The LFN format is not valid.
InvalidArgumentException
.
NotExistsException
.
AuthorizationException
.
ExistsException
.
InternalException
public void createFile(FCEntry[] entries) throws InternalException, AuthorizationException, ExistsException, NotExistsException, InvalidArgumentException
entries
- FCEntry to register
AuthorizationException
- No access right to create new entry in the parent directory.
ExistsException
- The file or guid already exists.
NotExistsException
- One of the parent path elemenets does not exists.
InvalidArgumentException
- The status information on the new entry is invalid.
InternalException
- InvalidArgumentException
.
InvalidArgumentException
.
ExistsException
.
ExistsException
.
NotExistsException
.
AuthorizationException
.
public void symlink(StringPair[] symlinks, boolean copyPermFromParent) throws InternalException, AuthorizationException, ExistsException, NotExistsException, InvalidArgumentException
ln -s b a
would be implemented as symlink({"a", "b"}, true)
.
symlinks
- Symlinks to register.
AuthorizationException
- No access right to create new entry in the parent directory.
ExistsException
- The file or Guid already exists.
NotExistsException
- One of the parent path elemenets does not exists.
InvalidArgumentException
- The status information on the new entry is invalid, e.g. type is not symlink.
InternalException
- InvalidArgumentException
.
ExistsException
.
NotExistsException
.
AuthorizationException
.
public void unlink(java.lang.String[] lfns) throws InternalException, AuthorizationException, NotExistsException
lfns
- The lfn to unlink
AuthorizationException
- No access right to delete the entry.
NotExistsException
- One of lfns does not exists.
InvalidArgumentException
InternalException
- InvalidArgumentException
.
NotExistsException
.
InvalidArgumentException
.
AuthorizationException
.
public void mv(StringPair[] entries) throws InternalException, AuthorizationException, ExistsException, NotExistsException
entries
- StringPair
object, containing
the old name as string1 and the new name as string2.
AuthorizationException
- No access right to create the new entry.
ExistsException
- The destination entry already exists.
InvalidArgumentException
- Some part of the argument is invalid.
NotExistsException
- The source entry does not exist.
InternalException
- InvalidArgumentException
.
NotExistsException
.
AuthorizationException
.
AuthorizationException
.
ExistsException
.
ExistsException
.
public void updateModifyTime(java.lang.String[] lfns, long time) throws InternalException, AuthorizationException, NotExistsException, InvalidArgumentException
lfns
- The LFNs to change the time ontime
- the new modification time to set
AuthorizationException
- No access right to update the status information.
InvalidArgumentException
- The specified time or the format of LFN is invalid.
NotExistsException
- The LFN does not exist.
InternalException
- InvalidArgumentException
.
NotExistsException
.
AuthorizationException
.
public void updateValidityTime(java.lang.String[] lfns, long time) throws InternalException, AuthorizationException, NotExistsException, InvalidArgumentException
lfns
- The LFNs to change the time ontime
- the new validity time to set
AuthorizationException
- No access right to update the status information.
InvalidArgumentException
- The specified time or thw format of lfn is invalid.
NotExistsException
- The LFN does not exist.
InternalException
- InvalidArgumentException
.
NotExistsException
.
AuthorizationException
.
public FCEntry[] readDir(java.lang.String path, java.lang.String pattern, long limit, long offset, boolean withPermissions) throws InternalException, AuthorizationException, NotExistsException, InvalidArgumentException
f???*
.
path
- The path of the directory to query.pattern
- The pattern to be mached. May be null.limit
- Up to limit result entries to be returned. May not be 0.offset
- Start with result entry at index offset+1. Offset starts with 0.withPermissions
- fill permission field too
FCEntry
objects.
AuthorizationException
- No access right to list the entries or status information.
NotExistsException
- The path does not exist.
InvalidArgumentException
InternalException
- The offset or limit is larget than the absolute maximum allowed.
InvalidArgumentException
.
InvalidArgumentException
.
InvalidArgumentException
.
NotExistsException
.
AuthorizationException
.
AuthorizationException
.
public java.lang.String[] locate(java.lang.String startDir, java.lang.String pattern, long limit) throws InternalException, AuthorizationException, NotExistsException
startDir
- is for startDirpattern
- is the element we are looking for.limit
- Up to limit result entries to be returned. May not be 0.
AuthorizationException
- No access right to list the entries or status information.
NotExistsException
- The startDir does not exist.
InvalidArgumentException
InternalException
- InvalidArgumentException
.
InvalidArgumentException
.
InvalidArgumentException
.
NotExistsException
.
AuthorizationException
.
public StringPair[] getGuidForLfn(java.lang.String[] lfns) throws InternalException, AuthorizationException, NotExistsException, InvalidArgumentException
lfns
- - lfns we want guid for
AuthorizationException
- No access right to list the entries or status information.
NotExistsException
- The LFN does not exist.
InvalidArgumentException
InternalException
- InvalidArgumentException
.
NotExistsException
.
AuthorizationException
.
public StringPair[] getLfnForGuid(java.lang.String[] guids) throws InternalException, AuthorizationException, NotExistsException, InvalidArgumentException
guids
- list of guids we want lfns for
AuthorizationException
- No access right to list the entries or status information.
NotExistsException
- The GUID does not exist.
InvalidArgumentException
.
NotExistsException
.
AuthorizationException
.
InternalException
InvalidArgumentException
public FCEntry[] getFileCatalogEntry(java.lang.String[] lfns) throws InternalException, AuthorizationException, NotExistsException
lfns
- the array of strings to get the full status of
FCEntry
objects
AuthorizationException
- No access right to list the entries or status information.
NotExistsException
- The LFN does not exist.
InternalException
- InvalidArgumentException
.
NotExistsException
.
AuthorizationException
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |