glite::wms::wmproxyapiutils Namespace Reference

Functions

const time_t getTime ()
const char * checkPathExistence (const char *path)
 Checks if an absolute path exists on the local machine.
const char * getTrustedCert (glite::wms::wmproxyapi::ConfigContext *cfs=NULL)
 Returns the local pathname of the directory containing the trusted certificates.
const char * getProxyFile (glite::wms::wmproxyapi::ConfigContext *cfs=NULL)
 Returns the pathname of the user proxy file.
const char * getEndPoint (glite::wms::wmproxyapi::ConfigContext *cfs=NULL)
 Returns the endpoint URL registerred in the input configuration context.
const long getProxyTimeLeft (std::string pxfile)
 Returns time left of the input proxy certificate (in minutes).
const long getCertTimeLeft (std::string pxfile)
 Returns time left of the input proxy certificate (in seconds).
const std::vector< std::string > getFQANs (std::string pxfile)
 Returns the list of the FQAN's of a voms-proxy file.

Function Documentation

const char* glite::wms::wmproxyapiutils::checkPathExistence ( const char *  path  ) 

Checks if an absolute path exists on the local machine.

Parameters:
path the pathname to be checked
Returns:
the pathname string if it exists, NULL if there is no such path
const long glite::wms::wmproxyapiutils::getCertTimeLeft ( std::string  pxfile  ) 

Returns time left of the input proxy certificate (in seconds).

Parameters:
pxfile The proxy file pathname
Returns:
The number of seconds remaining until the expiration time
const char* glite::wms::wmproxyapiutils::getEndPoint ( glite::wms::wmproxyapi::ConfigContext cfs = NULL  ) 

Returns the endpoint URL registerred in the input configuration context.

Parameters:
cfs The input configuration context (defines the location of the CA certificates, user proxy and the endpoint URL)
Returns:
The URL string, NULL if no valid URL has been found
const std::vector<std::string> glite::wms::wmproxyapiutils::getFQANs ( std::string  pxfile  ) 

Returns the list of the FQAN's of a voms-proxy file.

Parameters:
pxfile the proxy file pathname
Returns:
A vector contained the string list of the FQAN's
Exceptions:
BaseException If any error occurred during the reading of the proxy information
See also:
glite::wms::wmproxyapi::BaseException
const char* glite::wms::wmproxyapiutils::getProxyFile ( glite::wms::wmproxyapi::ConfigContext cfs = NULL  ) 

Returns the pathname of the user proxy file.

This information is retrieved by the input configuration context if the input context object is not NULL, otherwise the environment variable X509_PROXY_FILE is checked. If no valid information is found in both previous objects, the default location is checked (/tmp/x509up_u(uid))

Parameters:
cfs The input configuration context (defines the location of the CA certificates, user proxy and the endpoint URL); NULL otherwise
Returns:
The pathname string, NULL if no valid pathname has been found
const long glite::wms::wmproxyapiutils::getProxyTimeLeft ( std::string  pxfile  ) 

Returns time left of the input proxy certificate (in minutes).

Parameters:
pxfile The proxy file pathname
Returns:
The number of minutes remaining until the expiration time
const time_t glite::wms::wmproxyapiutils::getTime (  ) 
const char* glite::wms::wmproxyapiutils::getTrustedCert ( glite::wms::wmproxyapi::ConfigContext cfs = NULL  ) 

Returns the local pathname of the directory containing the trusted certificates.

This information retrieved by the input configuration context if the input context object is not NULL, otherwise the environment variable X509_CERT_DIR is checked . If no valid information is found in both previous objects, the default path is checked (/etc/grid-security/certificates)

Parameters:
cfs the configuration context (NULL otherwise)
Returns:
the pathname string, NULL if no valid path has been found

Generated on 8 Mar 2013 for glite-wms-wmproxy-api-cpp-3.5.0 by  doxygen 1.6.1