Inheritance diagram for samweb_client.client.SAMWebClient:

Public Member Functions
def	__init__ (self, experiment=None, secure=False, cert=None, key=None, devel=None, timezone=None)

def	get_role (self)

def	set_role (self, newval)

def	get_experiment (self)

def	set_experiment (self, experiment)

def	set_client_certificate (self, cert, key=None)

def	set_host (host)

def	set_ports (port, sslport)

def	get_baseurl (self, secure=None)

def	get_group (self)

def	set_group (self, group)

def	get_station (self)

def	set_station (self, station)

def	get_user (self)

def	get_timezone (self)

def	set_timezone (self, new_tz)

def	getURL (self, url, params=None, args, kwargs)

def	postURL (self, url, data=None, args, kwargs)

def	putURL (self, url, data=None, args, kwargs)

def	deleteURL (self, url, params=None, args, kwargs)

def	get_verbose (self)

def	set_verbose (self, verbose)

def	get_socket_timeout (self)

def	set_socket_timeout (self, timeout)

Public Attributes
	devel

	secure

	http_client

short int	type

short int	number

char	name [SIZE_OF_OBJ_NAME]

cat_entry	star

Properties
	role = property(get_role, set_role)

	experiment = property(get_experiment, set_experiment)

	baseurl = property(get_baseurl)

	group = property(get_group, set_group)

	station = property(get_station, set_station)

	user = property(get_user)

	timezone = property(get_timezone, set_timezone)

	verbose = property(get_verbose, set_verbose)

	socket_timeout = property(get_socket_timeout, set_socket_timeout)

Private Member Functions
def	_prepareURL (self, url, secure=None)

def	_doURL (self, method, url, params=None, data=None, secure=None, role=None, args, kwargs)

Private Attributes
	_role

	_host

	_port

	_sslport

Static Private Attributes
	_experiment = os.environ.get('SAM_EXPERIMENT')

string	_host = os.environ.get('SAM_WEB_HOST')or'samweb.fnal.gov'

string	_port = os.environ.get('SAM_WEB_PORT')or'8480'

string	_sslport = os.environ.get('SAM_WEB_SSL_PORT')or'8483'

	_baseurl = os.environ.get('SAM_WEB_BASE_URL')

	_basesslurl = os.environ.get('SAM_WEB_BASE_SSL_URL')

	_group = os.environ.get('SAM_GROUP')

	_station = os.environ.get('SAM_STATION')

	_timezone = os.environ.get('SAM_TZ')

string	_default_role = 'default'

Detailed Description

Definition at line 33 of file client.py.

Constructor & Destructor Documentation

def samweb_client.client.SAMWebClient.__init__	(	self,
		experiment = `None`,
		secure = `False`,
		cert = `None`,
		key = `None`,
		devel = `None`,
		timezone = `None`
	)

Definition at line 48 of file client.py.

Referenced by PandAna.core.core.spectrum.fill().

     def __init__(self, experiment=None, secure=False, cert=None, key=None, devel=None, timezone=None):
         self.devel = False
         if experiment is not None: self.experiment = experiment
         self.secure = secure
         if devel is not None: self.devel = devel
         self.http_client = http_client.get_client()
         self.set_client_certificate(cert, key)
         self.role = None
         timezone = timezone or self._timezone
         if timezone: self.timezone = timezone
 

Member Function Documentation

def samweb_client.client.SAMWebClient._doURL	(	self,
		method,
		url,
		params = `None`,
		data = `None`,
		secure = `None`,
		role = `None`,
		args,
		kwargs
	)

private

Definition at line 165 of file client.py.

References samweb_client.client.SAMWebClient._prepareURL(), samweb_client.client.SAMWebClient.role, and samweb_client.client.SAMWebClient.secure.

Referenced by samweb_client.http_client.SAMWebHTTPClient.deleteURL(), samweb_client.client.SAMWebClient.deleteURL(), samweb_client.http_client.SAMWebHTTPClient.getURL(), samweb_client.client.SAMWebClient.getURL(), samweb_client.http_client.SAMWebHTTPClient.postURL(), samweb_client.client.SAMWebClient.postURL(), samweb_client.http_client.SAMWebHTTPClient.putURL(), and samweb_client.client.SAMWebClient.putURL().

     def _doURL(self, method, url, params=None, data=None, secure=None, role=None, *args, **kwargs):
         secure = secure or self.secure 
         url = self._prepareURL(url, secure)
         if secure: kwargs['role'] = role or self.role
         return method(url, params=params, data=data, *args, **kwargs)
 

def samweb_client.client.SAMWebClient._prepareURL	(	self,
		url,
		secure = `None`
	)

private

Definition at line 147 of file client.py.

References samweb_client.client.SAMWebClient.get_baseurl().

Referenced by samweb_client.client.SAMWebClient._doURL().

     def _prepareURL(self, url, secure=None):
         # if provided with a relative url, add the baseurl
         if '://' not in url:
             url = self.get_baseurl(secure) + url
         return url
 

def samweb_client.client.SAMWebClient.deleteURL	(	self,
		url,
		params = `None`,
		args,
		kwargs
	)

Definition at line 162 of file client.py.

References samweb_client.client.SAMWebClient._doURL().

     def deleteURL(self, url, params=None, *args, **kwargs):
         return self._doURL(self.http_client.deleteURL, url, params=params, *args, **kwargs)
 

def samweb_client.client.SAMWebClient.get_baseurl	(	self,
		secure = `None`
	)

Return the base url. If secure is set this will be an
https url, if not it may not be

Definition at line 92 of file client.py.

References samweb_client.client.SAMWebClient._basesslurl, samweb_client.client.SAMWebClient._baseurl, samweb_client.client.SAMWebClient._host, samweb_client.client.SAMWebClient._port, samweb_client.client.SAMWebClient._sslport, samweb_client.client.SAMWebClient.devel, and samweb_client.client.SAMWebClient.experiment.

Referenced by samweb_client.client.SAMWebClient._prepareURL().

     def get_baseurl(self, secure=None):
         """ Return the base url. If secure is set this will be an
         https url, if not it may not be """
         if not secure and self._baseurl is not None:
             return self._baseurl
         if secure and self._basesslurl is not None:
             return self._basesslurl
 
         if self.devel:
             path = "/sam/%s/dev/api" % self.experiment
         else:
             path = "/sam/%s/api" % self.experiment
         if secure:
             if self._baseurl:
                 import sys
                 sys.stderr.write('Warning: BASEURL is set, but using default SSL URL')
             return "https://%s:%s%s" % (self._host, self._sslport, path)
         else:
             return "http://%s:%s%s" % (self._host, self._port, path)
 

def samweb_client.client.SAMWebClient.get_experiment ( self )

Definition at line 69 of file client.py.

References samweb_client.client.SAMWebClient._experiment.

Referenced by samweb_client.client.SAMWebClient.get_group(), and samweb_client.client.SAMWebClient.get_station().

     def get_experiment(self):
         if self._experiment is None:
             raise ExperimentNotDefined("Experiment is not defined")
         return self._experiment
 

def samweb_client.client.SAMWebClient.get_group ( self )

Definition at line 114 of file client.py.

References samweb_client.client.SAMWebClient._group, samweb_client.client.SAMWebClient.get_experiment(), and split().

     def get_group(self):
         if not self._group:
             # if the group isn't set then get it from the experiment name
             # knocking off anything after a trailing slash (ie hypot/dev -> hypot)
             self._group = self.get_experiment().split('/', 1)[0]
         return self._group
 

def samweb_client.client.SAMWebClient.get_role ( self )

Definition at line 59 of file client.py.

References samweb_client.client.SAMWebClient._role.

59 def get_role(self):

60 return self._role

samweb_client.client.SAMWebClient.get_role

def get_role(self)

Definition: client.py:59

samweb_client.client.SAMWebClient._role

_role

Definition: client.py:63

def samweb_client.client.SAMWebClient.get_socket_timeout ( self )

Definition at line 178 of file client.py.

178 def get_socket_timeout(self): return self.http_client.socket_timeout

samweb_client.client.SAMWebClient.get_socket_timeout

def get_socket_timeout(self)

Definition: client.py:178

def samweb_client.client.SAMWebClient.get_station ( self )

Definition at line 126 of file client.py.

References samweb_client.client.SAMWebClient._station, and samweb_client.client.SAMWebClient.get_experiment().

     def get_station(self):
         return self._station or self.get_experiment()
 

def samweb_client.client.SAMWebClient.get_timezone ( self )

Definition at line 139 of file client.py.

     def get_timezone(self):
         return self.http_client.timezone
 

def samweb_client.client.SAMWebClient.get_user ( self )

Definition at line 134 of file client.py.

     def get_user(self):
         return pwd.getpwuid(os.getuid()).pw_name
 

def samweb_client.client.SAMWebClient.get_verbose ( self )

Definition at line 171 of file client.py.

171 def get_verbose(self):

172 return self.http_client.verbose

samweb_client.client.SAMWebClient.get_verbose

def get_verbose(self)

Definition: client.py:171

def samweb_client.client.SAMWebClient.getURL	(	self,
		url,
		params = `None`,
		args,
		kwargs
	)

Definition at line 153 of file client.py.

References samweb_client.client.SAMWebClient._doURL().

     def getURL(self, url, params=None, *args, **kwargs):
         return self._doURL(self.http_client.getURL, url, params=params, *args, **kwargs)
 

def samweb_client.client.SAMWebClient.postURL	(	self,
		url,
		data = `None`,
		args,
		kwargs
	)

Definition at line 156 of file client.py.

References samweb_client.client.SAMWebClient._doURL().

     def postURL(self, url, data=None, *args, **kwargs):
         return self._doURL(self.http_client.postURL, url, data=data, *args, **kwargs)
 

def samweb_client.client.SAMWebClient.putURL	(	self,
		url,
		data = `None`,
		args,
		kwargs
	)

Definition at line 159 of file client.py.

References samweb_client.client.SAMWebClient._doURL().

     def putURL(self, url, data=None, *args, **kwargs):
         return self._doURL(self.http_client.putURL, url, data=data, *args, **kwargs)
 

def samweb_client.client.SAMWebClient.set_client_certificate	(	self,
		cert,
		key = `None`
	)

Definition at line 82 of file client.py.

     def set_client_certificate(self, cert, key=None):
         self.http_client.use_client_certificate(cert, key)
 

def samweb_client.client.SAMWebClient.set_experiment	(	self,
		experiment
	)

Definition at line 74 of file client.py.

References samweb_client.client.SAMWebClient._experiment, and samweb_client.client.SAMWebClient.devel.

     def set_experiment(self, experiment):
         self._experiment = experiment
         if self._experiment.endswith('/dev'):
             self.devel = True
             self._experiment = self._experiment[:-4]
 

def samweb_client.client.SAMWebClient.set_group	(	self,
		group
	)

Definition at line 121 of file client.py.

References samweb_client.client.SAMWebClient._group.

     def set_group(self,group):
         self._group = group
 

def samweb_client.client.SAMWebClient.set_host ( host )

Definition at line 85 of file client.py.

     def set_host(host):
         self._host = host
 

def samweb_client.client.SAMWebClient.set_ports	(	port,
		sslport
	)

Definition at line 88 of file client.py.

     def set_ports(port, sslport):
         if port: self._port = port
         if sslport: self._sslport = sslport
 

def samweb_client.client.SAMWebClient.set_role	(	self,
		newval
	)

Definition at line 61 of file client.py.

     def set_role(self, newval):
         if newval is None:
             self._role = self._default_role
         else:
             self._role = newval
 

def samweb_client.client.SAMWebClient.set_socket_timeout	(	self,
		timeout
	)

Definition at line 179 of file client.py.

179 def set_socket_timeout(self, timeout): self.http_client.socket_timeout = timeout

samweb_client.client.SAMWebClient.set_socket_timeout

def set_socket_timeout(self, timeout)

Definition: client.py:179

def samweb_client.client.SAMWebClient.set_station	(	self,
		station
	)

Definition at line 129 of file client.py.

References samweb_client.client.SAMWebClient._station.

     def set_station(self,station):
         self._station = station
 

def samweb_client.client.SAMWebClient.set_timezone	(	self,
		new_tz
	)

Definition at line 142 of file client.py.

     def set_timezone(self, new_tz):
         self.http_client.timezone = new_tz
 

def samweb_client.client.SAMWebClient.set_verbose	(	self,
		verbose
	)

Definition at line 173 of file client.py.

     def set_verbose(self, verbose):
         self.http_client.verbose = verbose
 

Member Data Documentation

samweb_client.client.SAMWebClient._basesslurl = os.environ.get('SAM_WEB_BASE_SSL_URL')

staticprivate

Definition at line 39 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_baseurl().

samweb_client.client.SAMWebClient._baseurl = os.environ.get('SAM_WEB_BASE_URL')

staticprivate

Definition at line 38 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_baseurl().

string samweb_client.client.SAMWebClient._default_role = 'default'

staticprivate

Definition at line 46 of file client.py.

samweb_client.client.SAMWebClient._experiment = os.environ.get('SAM_EXPERIMENT')

staticprivate

Definition at line 34 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_experiment(), and samweb_client.client.SAMWebClient.set_experiment().

samweb_client.client.SAMWebClient._group = os.environ.get('SAM_GROUP')

staticprivate

Definition at line 41 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_group(), and samweb_client.client.SAMWebClient.set_group().

string samweb_client.client.SAMWebClient._host = os.environ.get('SAM_WEB_HOST')or'samweb.fnal.gov'

staticprivate

Definition at line 35 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_baseurl().

samweb_client.client.SAMWebClient._host

private

Definition at line 86 of file client.py.

string samweb_client.client.SAMWebClient._port = os.environ.get('SAM_WEB_PORT')or'8480'

staticprivate

Definition at line 36 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_baseurl().

samweb_client.client.SAMWebClient._port

private

Definition at line 89 of file client.py.

samweb_client.client.SAMWebClient._role

private

Definition at line 63 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_role().

string samweb_client.client.SAMWebClient._sslport = os.environ.get('SAM_WEB_SSL_PORT')or'8483'

staticprivate

Definition at line 37 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_baseurl().

samweb_client.client.SAMWebClient._sslport

private

Definition at line 90 of file client.py.

samweb_client.client.SAMWebClient._station = os.environ.get('SAM_STATION')

staticprivate

Definition at line 42 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_station(), and samweb_client.client.SAMWebClient.set_station().

samweb_client.client.SAMWebClient._timezone = os.environ.get('SAM_TZ')

staticprivate

Definition at line 43 of file client.py.

samweb_client.client.SAMWebClient.devel

Definition at line 49 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_baseurl(), and samweb_client.client.SAMWebClient.set_experiment().

samweb_client.client.SAMWebClient.http_client

Definition at line 53 of file client.py.

char object::name

inherited

Definition at line 116 of file novas.h.

Referenced by generic.models.Organizational.PlotID::__contains__(), mcscore.MCParticle::__init__(), Definition.Definition::__repr__(), Chain.Chain::__repr__(), Chain.Chain::AddTier(), python.g4viscp.G4Scene::create_scene(), python3.g4viscp.G4Scene::create_scene(), DefinitionData.DefinitionData::fetchData(), TB_WatchdogFx.Tier::getHist(), WatchdogFx.Tier::getHist(), TB_WatchdogFx.Path::getPlotCanvas(), WatchdogFx.Path::getPlotCanvas(), std_candles.StdCandlesPlotter::IsMC(), mcscore.MCParticle::printout(), run_unfold_ppfx_multiprocess.Consumer::run(), run_unfold_systs_multiprocess.Consumer::run(), run_unfold_genie_multiprocess.Consumer::run(), PageMaker.PageMaker::setNavBarActive(), python3.g4viscp.G4Scene::update_scene(), python.g4viscp.G4Scene::update_scene(), and PageMaker.PageMaker::write().

short int object::number

inherited

Definition at line 115 of file novas.h.

samweb_client.client.SAMWebClient.secure

Definition at line 51 of file client.py.

Referenced by samweb_client.client.SAMWebClient._doURL().

cat_entry object::star

inherited

Definition at line 117 of file novas.h.

short int object::type

inherited

Definition at line 114 of file novas.h.

Property Documentation

samweb_client.client.SAMWebClient.baseurl = property(get_baseurl)

static

Definition at line 112 of file client.py.

samweb_client.client.SAMWebClient.experiment = property(get_experiment, set_experiment)

static

Definition at line 80 of file client.py.

Referenced by samweb_client.client.SAMWebClient.get_baseurl().

samweb_client.client.SAMWebClient.group = property(get_group, set_group)

static

Definition at line 124 of file client.py.

Referenced by nova_fhicl_metadata.NovaFhclExtractor._createMetadata(), and nova_caf_metadata.NovaCAFExtractor._createMetadata().

samweb_client.client.SAMWebClient.role = property(get_role, set_role)

static

Definition at line 67 of file client.py.

Referenced by samweb_client.client.SAMWebClient._doURL().

samweb_client.client.SAMWebClient.socket_timeout = property(get_socket_timeout, set_socket_timeout)

static

Definition at line 180 of file client.py.

Referenced by samweb_client.http_client_requests.RequestsHTTPClient._doURL(), and samweb_client.http_client_urllib2.URLLib2HTTPClient._doURL().

samweb_client.client.SAMWebClient.station = property(get_station, set_station)

static

Definition at line 132 of file client.py.

samweb_client.client.SAMWebClient.timezone = property(get_timezone, set_timezone)

static

Definition at line 145 of file client.py.

samweb_client.client.SAMWebClient.user = property(get_user)

static

Definition at line 137 of file client.py.

Referenced by ProjMan.Consumer.establish(), and PandAna.core.filesource.samquerysource.setupProject().

samweb_client.client.SAMWebClient.verbose = property(get_verbose, set_verbose)

static

Definition at line 176 of file client.py.

Referenced by PageMaker.PageMaker.__init__(), samweb_client.http_client.SAMWebHTTPClient._logger(), samweb_client.http_client.SAMWebHTTPClient._logMethod(), ControllerView.ControllerView.check_sam_status(), ControllerView.ControllerView.component_status(), View.ControllerView.component_view(), ControllerView.ControllerView.component_view(), Canvas.Canvas.draw(), generic.tools.ImageMaker.ImageMaker.draw(), ControllerView.ControllerView.draw_component_plots(), Controller.Controller.make_output_directory(), Component.Component.setup_sam_view(), PageMaker.PageMaker.write(), and ViewTimingDB.ViewTimingDB.write_csv().

The documentation for this class was generated from the following file:

/cvmfs/nova-development.opensciencegrid.org/novasoft/releases/N21-02-24/Eval/tools/samweb_client/client.py

Public Member Functions

Public Attributes

Properties

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation