NAME

GLite::Data::FiremanCatalog


DESCRIPTION

GLite::Data::FileCatalog module provides a Perl client library for the FiremanCatalog interface.


METHODS

The methods die if there was a SOAP fault. The fault string and details are added to the die message.

new($URL)
Creates an FiremanCatalog object, which is initialized with the approriate SOAP endpoint. If the URL uses https protocol, then it will do the HTTPS initialization (locating proxy certificate) as well.

Note: you have to include the VO name in the URL!

    my $srv = GLite::Data::FiremanCatalog->new('https://service.glite.org:8443/example');

remove(string[] lfns)
create(FRCEntry[] entries)
FRCEntry[] listReplicas(string[] lfns, boolean withPermissions)
StringPair[] listLfn(string[] surls)
Stat[] getStat(string[] lfns)
addReplica(string lfn, SURLEntry[] newSurls)
removeReplica(StringPair[] lfnSurls, boolean removeLfnOnLastReplica)
associateDirWithSchema(string directoryLfn, string schemaName)
mkdir(string[] directories, boolean createParents, boolean copyPermFromParent)
symlink(StringPair[] symlinks, boolean copyPermFromParent)
rmdir(string[] directories)
createFile(FCEntry[] entries)
unlink(string[] lfns)
mv(StringPair[] entries)
updateModifyTime(string[] lfns, long time)
updateValidityTime(string[] lfns, long time)
FCEntry[] readDir(string path, string pattern, long limit, long offset, boolean withPermissions)
string[] locate(string startDir, string pattern, long limit)
StringPair[] getGuidForLfn(string[] lfns)
StringPair[] getLfnForGuid(string[] guids)
FCEntry[] getFileCatalogEntry(string[] lfns)
checkPermission(string[] items, Perm perm)
PermissionEntry[] getPermission(string[] items)
setPermission(PermissionEntry[] permissions)
string getVersion()
string getSchemaVersion()
string getInterfaceVersion()
string getServiceMetadata(string key)
Attribute[] getAttributes(string item, string[] attributeNames)
string[] query(string query, string type, int limit, int offset)
setAttributes(string item, Attribute[] attributes)
clearAttributes(string item, string[] attributeNames)
Attribute[] listAttributes(string item)
createGuid(RCEntry[] entries)
addGuidReplica(string guid, SURLEntry[] newSurls)
updateGuidStat(string[] guids, GUIDStat[] stats)
updateSurlStat(string guid, SURLEntry[] surlStats)
setMasterReplica(StringPair[] guidSurls)
updateStatus(string[] guids, int status, int mask)
removeGuidReplica(StringPair[] guidSurls, boolean removeGuidOnLastReplica)
removeGuid(string[] guids)
setDefaultPrincipalPermission(string principal, Permission defaultPermission)
setDefaultGlobalPermission(Permission defaultPermission)
StringPair[] getGuidForSurl(string[] surls)
StringPair[] getMasterReplica(string[] guids)
StringPair[] listSurlsByGuid(string[] guids)
RCEntry[] listReplicasByGuid(string[] guids, boolean withPermissions)
StringBoolean[] hasGuid(string[] guids)
GUIDStat[] getGuidStat(string[] guids)
SURLEntry[] getSurlStat(string[] surls)
Permission getDefaultPrincipalPermission(string principal)
Permission getDefaultGlobalPermission()


TYPES

ArrayOf_soapenc_string
    my $myArrayOf_soapenc_string = [ 'string1', 'string2', ...];
ArrayOf_tns1_FRCEntry
    my $myArrayOf_tns1_FRCEntry = [ $myFRCEntry1, $myFRCEntry2, ... ];
ArrayOf_tns1_StringPair
    my $myArrayOf_tns1_StringPair = [ $myStringPair1, $myStringPair2, ... ];
ArrayOf_tns1_Stat
    my $myArrayOf_tns1_Stat = [ $myStat1, $myStat2, ... ];
ArrayOf_tns1_SURLEntry
    my $myArrayOf_tns1_SURLEntry = [ $mySURLEntry1, $mySURLEntry2, ... ];
ArrayOf_tns1_FCEntry
    my $myArrayOf_tns1_FCEntry = [ $myFCEntry1, $myFCEntry2, ... ];
ArrayOf_tns1_PermissionEntry
    my $myArrayOf_tns1_PermissionEntry = [ $myPermissionEntry1, $myPermissionEntry2, ... ];
ArrayOf_tns1_Attribute
    my $myArrayOf_tns1_Attribute = [ $myAttribute1, $myAttribute2, ... ];
ArrayOf_tns1_RCEntry
    my $myArrayOf_tns1_RCEntry = [ $myRCEntry1, $myRCEntry2, ... ];
ArrayOf_tns1_GUIDStat
    my $myArrayOf_tns1_GUIDStat = [ $myGUIDStat1, $myGUIDStat2, ... ];
ArrayOf_tns1_StringBoolean
    my $myArrayOf_tns1_StringBoolean = [ $myStringBoolean1, $myStringBoolean2, ... ];
CatalogException
    my $myCatalogException = {
        message => 'string'
    };
InternalException
    my $myInternalException = new CatalogException (
        
    );
AuthorizationException
    my $myAuthorizationException = new CatalogException (
        
    );
NotExistsException
    my $myNotExistsException = new CatalogException (
        
    );
InvalidArgumentException
    my $myInvalidArgumentException = new CatalogException (
        
    );
Stat
    my $myStat = {
        modifyTime => $mylong, 
        creationTime => $mylong, 
        size => $mylong
    };
GUIDStat
    my $myGUIDStat = new Stat (
        
    );
Perm
    my $myPerm = {
        permission => $myboolean, 
        remove => $myboolean, 
        read => $myboolean, 
        write => $myboolean, 
        list => $myboolean, 
        execute => $myboolean, 
        getMetadata => $myboolean, 
        setMetadata => $myboolean
    };
BasicPermission
    my $myBasicPermission = {
        userName => 'string', 
        groupName => 'string', 
        userPerm => $myPerm, 
        groupPerm => $myPerm, 
        otherPerm => $myPerm
    };
ACLEntry
    my $myACLEntry = {
        principalPerm => $myPerm, 
        principal => 'string'
    };
Permission
    my $myPermission = new BasicPermission (
        
    );
SURLEntry
    my $mySURLEntry = {
        masterReplica => $myboolean, 
        creationTime => $mylong, 
        modifyTime => $mylong, 
        surl => 'string'
    };
RCEntry
    my $myRCEntry = {
        guid => 'string', 
        GUIDStat => $myGUIDStat, 
        permission => $myPermission, 
        surlStats => [ $mySURLEntry1, $mySURLEntry2, ... ]
    };
LFNStat
    my $myLFNStat = new Stat (
        
    );
FRCEntry
    my $myFRCEntry = new RCEntry (
        
    );
ExistsException
    my $myExistsException = new CatalogException (
        
    );
StringPair
    my $myStringPair = {
        string1 => 'string', 
        string2 => 'string'
    };
FCEntry
    my $myFCEntry = {
        lfn => 'string', 
        guid => 'string', 
        permission => $myPermission, 
        lfnStat => $myLFNStat
    };
PermissionEntry
    my $myPermissionEntry = {
        item => 'string', 
        permission => $myPermission
    };
Attribute
    my $myAttribute = {
        name => 'string', 
        value => 'string', 
        type => 'string'
    };
StringBoolean
    my $myStringBoolean = {
        string => 'string', 
        bool => $myboolean
    };


SEE ALSO

the GLite::HTTPS manpage


AUTHORS

Copyright (c) 2004 CERN, on behalf of the EU EGEE project. For license conditions see LICENSE file or http://www.edg.org/license.html.