Module gfal2 :: Class Gfal2Context
[hide private]
[frames] | no frames]

Class Gfal2Context

 object --+    
          |    
??.instance --+
              |
             Gfal2Context

Gfal2 Context

Nested Classes [hide private]
  Credential
Credential object holding type and value
  DirectoryType
Directory descriptor
  Dirent
Please, note that not all fields make sense for all protocols
  FileType
File descriptor
  GfaltEvent
  NullHandler
  Stat
Please, note that not all fields make sense for all protocols
  TransferParameters
filecopy parameters
  cred_new
Credential object holding type and value
  event_side
  gfalt_event
  transfer_parameters
filecopy parameters
Instance Methods [hide private]
 
__init__(...)
__init__( (object)arg1) -> None
 
__reduce__(...)
helper for pickle
 
abort_bring_online(...)
abort_bring_online( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int : Aborts a bring online request
 
access(...)
access( (Gfal2Context)arg1, (str)arg2, (int)arg3) -> int :...
 
add_client_info(...)
add_client_info( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :...
 
archive_poll(...)
archive_poll( (Gfal2Context)arg1, (str)arg2) -> int : Polls the status for asynchronous archive operations
 
bring_online(...)
bring_online( (Gfal2Context)arg1, (str)arg2, (int)arg3, (int)arg4, (bool)arg5) -> tuple : Performs a bring online operation (only for protocols that support this operation)
 
bring_online_poll(...)
bring_online_poll( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int : Polls the status for asynchronous bring_online operations
 
cancel(...)
cancel( (Gfal2Context)arg1) -> int :...
 
change_object_qos(...)
change_object_qos( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :...
 
check_available_qos_transitions(...)
check_available_qos_transitions( (Gfal2Context)arg1, (str)arg2) -> list :...
 
check_file_qos(...)
check_file_qos( (Gfal2Context)arg1, (str)arg2) -> str :...
 
check_target_qos(...)
check_target_qos( (Gfal2Context)arg1, (str)arg2) -> str :...
 
checksum(...)
checksum( (Gfal2Context)arg1, (str)arg2, (str)arg3, (int)arg4, (int)arg5) -> str : Returns the checksum for the given part of a file.
 
chmod(...)
chmod( (Gfal2Context)arg1, (str)arg2, (int)arg3) -> int :...
 
clear_client_info(...)
clear_client_info( (Gfal2Context)arg1) -> int :...
 
cred_clean(...)
cred_clean( (Gfal2Context)arg1) -> int :...
 
cred_del(...)
cred_del( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :...
 
cred_get(...)
cred_get( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> tuple :...
 
cred_set(...)
cred_set( (Gfal2Context)arg1, (str)arg2, (Credential)arg3) -> int :...
 
directory(...)
directory( (Gfal2Context)arg1, (str)arg2) -> DirectoryType :...
 
file(...)
file( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> FileType :...
 
filecopy(...)
filecopy( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int : Shortcut for filecopy(gfal2.transfer_params(), src, dst)
 
free(...)
free( (Gfal2Context)arg1) -> None : Release internal resources used by the context.
 
get_client_info(...)
get_client_info( (Gfal2Context)arg1) -> dict :...
 
get_opt_boolean(...)
get_opt_boolean( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> bool :...
 
get_opt_integer(...)
get_opt_integer( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :...
 
get_opt_string(...)
get_opt_string( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> str :...
 
get_opt_string_list(...)
get_opt_string_list( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> list :...
 
get_plugin_names(...)
get_plugin_names( (Gfal2Context)arg1) -> list :...
 
get_user_agent(...)
get_user_agent( (Gfal2Context)arg1) -> tuple :...
 
getxattr(...)
getxattr( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> str :...
 
listdir(...)
listdir( (Gfal2Context)arg1, (str)arg2) -> list :...
 
listxattr(...)
listxattr( (Gfal2Context)arg1, (str)arg2) -> list :...
 
load_opts_from_file(...)
load_opts_from_file( (Gfal2Context)arg1, (str)arg2) -> int :...
 
lstat(...)
lstat( (Gfal2Context)arg1, (str)arg2) -> Stat :...
 
mkdir(...)
mkdir( (Gfal2Context)arg1, (str)arg2, (int)arg3) -> int :...
 
mkdir_rec(...)
mkdir_rec( (Gfal2Context)arg1, (str)arg2, (int)arg3) -> int :...
 
open(...)
open( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> FileType :...
 
opendir(...)
opendir( (Gfal2Context)arg1, (str)arg2) -> DirectoryType :...
 
qos_check_classes(...)
qos_check_classes( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> list :...
 
readlink(...)
readlink( (Gfal2Context)arg1, (str)arg2) -> str : Returns a string representing the path to which the symbolic link points.
 
release(...)
release( (Gfal2Context)arg1, (str)arg2) -> int : Shortcut for release(path, token = '')
 
remove_client_info(...)
remove_client_info( (Gfal2Context)arg1, (str)arg2) -> int :...
 
remove_opt(...)
remove_opt( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> bool :...
 
rename(...)
rename( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :...
 
rmdir(...)
rmdir( (Gfal2Context)arg1, (str)arg2) -> int :...
 
set_opt_boolean(...)
set_opt_boolean( (Gfal2Context)arg1, (str)arg2, (str)arg3, (bool)arg4) -> int :...
 
set_opt_integer(...)
set_opt_integer( (Gfal2Context)arg1, (str)arg2, (str)arg3, (int)arg4) -> int :...
 
set_opt_string(...)
set_opt_string( (Gfal2Context)arg1, (str)arg2, (str)arg3, (str)arg4) -> int :...
 
set_opt_string_list(...)
set_opt_string_list( (Gfal2Context)arg1, (str)arg2, (str)arg3, (list)arg4) -> int :...
 
set_user_agent(...)
set_user_agent( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :...
 
setxattr(...)
setxattr( (Gfal2Context)arg1, (str)arg2, (str)arg3, (str)arg4, (int)arg5) -> int :...
 
stat(...)
stat( (Gfal2Context)arg1, (str)arg2) -> Stat :...
 
symlink(...)
symlink( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :...
 
token_retrieve(...)
token_retrieve( (Gfal2Context)arg1, (str)arg2, (str)arg3, (int)arg4, (bool)arg5) -> str : Retrieve SE-issued token for given resource (uses predefined activities based on read/write access flag)
 
unlink(...)
unlink( (Gfal2Context)arg1, (str)arg2) -> int : Removes a file

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  __instance_size__ = 40
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

__init__( (object)arg1) -> None

Overrides: object.__init__

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

abort_bring_online(...)

 

abort_bring_online( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Aborts a bring online request

abort_bring_online( (Gfal2Context)arg1, (list)arg2, (str)arg3) -> list :
    Aborts a bring online request

access(...)

 

access( (Gfal2Context)arg1, (str)arg2, (int)arg3) -> int :
    Checks if the calling process/user can access the file with the given mode (see os.access)

add_client_info(...)

 

add_client_info( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Sets a custom key/value pair to be sent to the server, if the protocol allows it

archive_poll(...)

 

archive_poll( (Gfal2Context)arg1, (str)arg2) -> int :
    Polls the status for asynchronous archive operations

archive_poll( (Gfal2Context)arg1, (list)arg2) -> list :
    Performs a bulk archive poll operation

bring_online(...)

 

bring_online( (Gfal2Context)arg1, (str)arg2, (int)arg3, (int)arg4, (bool)arg5) -> tuple :
    Performs a bring online operation (only for protocols that support this operation)

bring_online( (Gfal2Context)arg1, (str)arg2, (str)arg3, (int)arg4, (int)arg5, (bool)arg6) -> tuple :
    Performs a bring online operation (only for protocols that support this operation)

bring_online( (Gfal2Context)arg1, (list)arg2, (int)arg3, (int)arg4, (bool)arg5) -> tuple :
    Performs a bring online operation (only for protocols that support this operation)

bring_online( (Gfal2Context)arg1, (list)arg2, (list)arg3, (int)arg4, (int)arg5, (bool)arg6) -> tuple :
    Performs a bring online operation (only for protocols that support this operation)

bring_online_poll(...)

 

bring_online_poll( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Polls the status for asynchronous bring_online operations

bring_online_poll( (Gfal2Context)arg1, (list)arg2, (str)arg3) -> list :
    Performs a bulk bring online poll operation

cancel(...)

 

cancel( (Gfal2Context)arg1) -> int :
    Cancel running operations

change_object_qos(...)

 

change_object_qos( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Change the QoS of an object, either dir or file

check_available_qos_transitions(...)

 

check_available_qos_transitions( (Gfal2Context)arg1, (str)arg2) -> list :
    Check the available transitions for a specific QoS

check_file_qos(...)

 

check_file_qos( (Gfal2Context)arg1, (str)arg2) -> str :
    Check the QoS of a file in a CDMI enabled interface

check_target_qos(...)

 

check_target_qos( (Gfal2Context)arg1, (str)arg2) -> str :
    Check the target QoS of a specific file

checksum(...)

 

checksum( (Gfal2Context)arg1, (str)arg2, (str)arg3, (int)arg4, (int)arg5) -> str :
    Returns the checksum for the given part of a file. If both offset and length are 0, the whole file will be processed

checksum( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> str :
    Shortcut for checksum(uri, chk_type, 0, 0)

chmod(...)

 

chmod( (Gfal2Context)arg1, (str)arg2, (int)arg3) -> int :
    Changes the permissions of the file

clear_client_info(...)

 

clear_client_info( (Gfal2Context)arg1) -> int :
    Clears all key/value pairs set by add_client_info

cred_clean(...)

 

cred_clean( (Gfal2Context)arg1) -> int :
    Clean credential mapping

cred_del(...)

 

cred_del( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Delete credential of specified type for given URL

cred_get(...)

 

cred_get( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> tuple :
    Get credential of specified type for given URL

cred_set(...)

 

cred_set( (Gfal2Context)arg1, (str)arg2, (Credential)arg3) -> int :
    Set credentials of specified type for given URL

directory(...)

 

directory( (Gfal2Context)arg1, (str)arg2) -> DirectoryType :
    Synonym for opendir

file(...)

 

file( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> FileType :
    Synonym for open

filecopy(...)

 

filecopy( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Shortcut for filecopy(gfal2.transfer_params(), src, dst)

filecopy( (Gfal2Context)arg1, (TransferParameters)arg2, (str)arg3, (str)arg4) -> int :
    Copies src into dst using the configured transfer parameters

filecopy( (Gfal2Context)arg1, (list)arg2, (list)arg3) -> object :
    Shortcut for filecopy(gfal2.transfer_params(), sources, destinations)

filecopy( (Gfal2Context)arg1, (TransferParameters)arg2, (list)arg3, (list)arg4) -> object :
    Shortcut for filecopy(params, sources, destinations, [])

filecopy( (Gfal2Context)arg1, (TransferParameters)arg2, (list)arg3, (list)arg4, (list)arg5) -> object :
    Performs a bulk copy from sources[i] to destinations[i] with checksum checksum[i]. All sources must use same protocol/storage, and same goes for destinations.

free(...)

 

free( (Gfal2Context)arg1) -> None :
    Release internal resources used by the context. The instance can *not* be used after this

get_client_info(...)

 

get_client_info( (Gfal2Context)arg1) -> dict :
    Returns the key/value pairs as a dictionary

get_opt_boolean(...)

 

get_opt_boolean( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> bool :
    Returns the boolean value assigned to a configuration parameter

get_opt_integer(...)

 

get_opt_integer( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Returns the integer value assigned to a configuration parameter

get_opt_string(...)

 

get_opt_string( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> str :
    Returns the string value assigned to a configuration parameter

get_opt_string_list(...)

 

get_opt_string_list( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> list :
    Returns the list of strings assigned to a configuration parameter

get_plugin_names(...)

 

get_plugin_names( (Gfal2Context)arg1) -> list :
    Returns the name list of loaded plugins

get_user_agent(...)

 

get_user_agent( (Gfal2Context)arg1) -> tuple :
    Gets the user agent identification, name and version

getxattr(...)

 

getxattr( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> str :
    Gets an extended attribute

listdir(...)

 

listdir( (Gfal2Context)arg1, (str)arg2) -> list :
    Returns the content of a directory as a list of file names

listxattr(...)

 

listxattr( (Gfal2Context)arg1, (str)arg2) -> list :
    List known/supported extended attributes

load_opts_from_file(...)

 

load_opts_from_file( (Gfal2Context)arg1, (str)arg2) -> int :
    Loads a set of configuration parameters from a .ini formatted file

lstat(...)

 

lstat( (Gfal2Context)arg1, (str)arg2) -> Stat :
    Identical to stat, but following symlinks

mkdir(...)

 

mkdir( (Gfal2Context)arg1, (str)arg2, (int)arg3) -> int :
    Creates a directory

mkdir_rec(...)

 

mkdir_rec( (Gfal2Context)arg1, (str)arg2, (int)arg3) -> int :
    Creates a directory and its parents if needed

open(...)

 

open( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> FileType :
    Opens a file and returns a file descriptor

opendir(...)

 

opendir( (Gfal2Context)arg1, (str)arg2) -> DirectoryType :
    Opens a directory and returns a directory descriptor

qos_check_classes(...)

 

qos_check_classes( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> list :
    Check the QoS classes present in an interface

release(...)

 

release( (Gfal2Context)arg1, (str)arg2) -> int :
    Shortcut for release(path, token = '')

release( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Releases a file pinned by a bring_online call

release( (Gfal2Context)arg1, (list)arg2) -> list :
    Shortcut for release (paths[], token = '')

release( (Gfal2Context)arg1, (list)arg2, (str)arg3) -> list :
    Releases a set of files pinned by a bring_online call

remove_client_info(...)

 

remove_client_info( (Gfal2Context)arg1, (str)arg2) -> int :
    Removes a key/value pair set previously by add_client_info

remove_opt(...)

 

remove_opt( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> bool :
    remove an option

rename(...)

 

rename( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Renames a file

rmdir(...)

 

rmdir( (Gfal2Context)arg1, (str)arg2) -> int :
    Removes a directory

set_opt_boolean(...)

 

set_opt_boolean( (Gfal2Context)arg1, (str)arg2, (str)arg3, (bool)arg4) -> int :
    Sets a configuration parameter as a boolean

set_opt_integer(...)

 

set_opt_integer( (Gfal2Context)arg1, (str)arg2, (str)arg3, (int)arg4) -> int :
    Sets a configuration parameter as an integer

set_opt_string(...)

 

set_opt_string( (Gfal2Context)arg1, (str)arg2, (str)arg3, (str)arg4) -> int :
    Sets a configuration parameter as a string

set_opt_string_list(...)

 

set_opt_string_list( (Gfal2Context)arg1, (str)arg2, (str)arg3, (list)arg4) -> int :
    Sets a configuration parameter as a list of strings

set_user_agent(...)

 

set_user_agent( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Sets the user agent identification, name and version

setxattr(...)

 

setxattr( (Gfal2Context)arg1, (str)arg2, (str)arg3, (str)arg4, (int)arg5) -> int :
    Sets an extended attribute

stat(...)

 

stat( (Gfal2Context)arg1, (str)arg2) -> Stat :
    Performs a stat call on a file

symlink(...)

 

symlink( (Gfal2Context)arg1, (str)arg2, (str)arg3) -> int :
    Creates a symbolic link

token_retrieve(...)

 

token_retrieve( (Gfal2Context)arg1, (str)arg2, (str)arg3, (int)arg4, (bool)arg5) -> str :
    Retrieve SE-issued token for given resource (uses predefined activities based on read/write access flag)

token_retrieve( (Gfal2Context)arg1, (str)arg2, (str)arg3, (int)arg4, (list)arg5) -> str :
    Retrieve SE-issued token for given resource (uses user-defined activities)

unlink(...)

 

unlink( (Gfal2Context)arg1, (str)arg2) -> int :
    Removes a file

unlink( (Gfal2Context)arg1, (list)arg2) -> list :
    Removes a set of files