Source code for rucio.client.scopeclient
# Copyright European Organization for Nuclear Research (CERN)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# You may not use this file except in compliance with the License.
# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
#
# Authors:
# - Thomas Beermann, <thomas.beermann@cern.ch>, 2012
# - Vincent Garonne, <vincent.garonne@cern.ch>, 2012
# - Cedric Serfon, <cedric.serfon@cern.ch>, 2014
from json import loads
from random import choice
from requests.status_codes import codes
from rucio.client.baseclient import BaseClient
from rucio.common.utils import build_url
[docs]class ScopeClient(BaseClient):
"""Scope client class for working with rucio scopes"""
SCOPE_BASEURL = 'accounts'
def __init__(self, rucio_host=None, auth_host=None, account=None, ca_cert=None, auth_type=None, creds=None, timeout=None):
super(ScopeClient, self).__init__(rucio_host, auth_host, account, ca_cert, auth_type, creds, timeout)
[docs] def add_scope(self, account, scope):
"""
Sends the request to add a new scope.
:param account: the name of the account to add the scope to.
:param scope: the name of the new scope.
:return: True if scope was created successfully.
:raises Duplicate: if scope already exists.
:raises AccountNotFound: if account doesn't exist.
"""
path = '/'.join([self.SCOPE_BASEURL, account, 'scopes', scope])
url = build_url(choice(self.list_hosts), path=path)
r = self._send_request(url, type='POST')
if r.status_code == codes.created:
return True
else:
exc_cls, exc_msg = self._get_exception(r.headers)
raise exc_cls(exc_msg)
[docs] def list_scopes(self):
"""
Sends the request to list all scopes.
:return: a list containing the names of all scopes.
"""
path = '/'.join(['scopes/'])
url = build_url(choice(self.list_hosts), path=path)
r = self._send_request(url)
if r.status_code == codes.ok:
scopes = loads(r.text)
return scopes
else:
exc_cls, exc_msg = self._get_exception(r.headers)
raise exc_cls(exc_msg)
[docs] def list_scopes_for_account(self, account):
"""
Sends the request to list all scopes for a rucio account.
:param account: the rucio account to list scopes for.
:return: a list containing the names of all scopes for a rucio account.
:raises AccountNotFound: if account doesn't exist.
:raises ScopeNotFound: if no scopes exist for account.
"""
path = '/'.join([self.SCOPE_BASEURL, account, 'scopes/'])
url = build_url(choice(self.list_hosts), path=path)
r = self._send_request(url)
if r.status_code == codes.ok:
scopes = loads(r.text)
return scopes
else:
exc_cls, exc_msg = self._get_exception(r.headers)
raise exc_cls(exc_msg)