interface/glite/wms/wmproxyapi/wmproxy_api.h File Reference

wsdl wmproxy service wrapper A wrapper around wmproxy Web Service. More...

#include <fstream>
#include <iostream>
#include <string>
#include <vector>

Go to the source code of this file.

Data Structures

struct  glite::wms::wmproxyapi::BaseException
 Base exception wrap. More...
struct  glite::wms::wmproxyapi::AuthenticationException
 Generic Authentication problem. More...
struct  glite::wms::wmproxyapi::AuthorizationException
 Client is not authorized to perform the required operation. More...
struct  glite::wms::wmproxyapi::InvalidArgumentException
 One or more of the given input parameters is not valid. More...
struct  glite::wms::wmproxyapi::GetQuotaManagementException
 Quota management is not active on the WM. More...
struct  glite::wms::wmproxyapi::NoSuitableResourcesException
 No resources matching job requirements have been found. More...
struct  glite::wms::wmproxyapi::JobUnknownException
 The provided job has not been registered to the system. More...
struct  glite::wms::wmproxyapi::OperationNotAllowedException
 Current job status does not allow requested operation. More...
struct  glite::wms::wmproxyapi::ServerOverloadedException
 Server is too busy. More...
struct  glite::wms::wmproxyapi::ProxyFileException
 Proxy file errors. More...
struct  glite::wms::wmproxyapi::GrstDelegationException
 Error during delegation operations with Gridsite methods (grstXXXX) - since 1.2.0. More...
struct  glite::wms::wmproxyapi::GenericException
 Generic problem. More...
struct  glite::wms::wmproxyapi::NodeStruct
 Used to define the the structure of a dag the name of the node might be NULL for the first instance (if it's representing the dag itself) while all the children have to be properly initialised. More...
struct  glite::wms::wmproxyapi::JobIdApi
 Used to define the jobid hierarchy of a job or a dag. More...
struct  glite::wms::wmproxyapi::VOProxyInfoStructType
 Used as a member of ProxyInfoStructType. More...
struct  glite::wms::wmproxyapi::ProxyInfoStructType
 Used for describing all proxy parameters. More...
struct  glite::wms::wmproxyapi::ProxyReqStruct
struct  glite::wms::wmproxyapi::JobStatusStructType
struct  glite::wms::wmproxyapi::ConfigContext
 Used to configure non-default properties such as:. More...

Namespaces

namespace  glite
namespace  glite::wms
namespace  glite::wms::wmproxyapi

Functions

Exceptions



BaseException * glite::wms::wmproxyapi::createWmpException (BaseException *b_ex, const std::string &method, const std::string &description)
 Creates a BaseException object.
WMProxy Submission services



JobIdApi glite::wms::wmproxyapi::jobRegister (const std::string &jdl, const std::string &delegationId, ConfigContext *cfs=NULL)
 Registers a job for submission.The unique identifier assigned to the job is returned to the client.
JobIdApi glite::wms::wmproxyapi::jobRegisterJSDL (std::ifstream &jsdlFile, const std::string &delegationId, ConfigContext *cfs=NULL)
 Registers a job for submission.The unique identifier assigned to the job is returned to the client.
JobIdApi glite::wms::wmproxyapi::jobSubmit (const std::string &jdl, const std::string &delegationId, ConfigContext *cfs=NULL)
 Submits a job: performs registration and triggers the submission The JDL description of the job provided by the client is validated by the service, registered to the LB and finally passed to the Workload Manager.
JobIdApi glite::wms::wmproxyapi::jobSubmitJSDL (std::ifstream &jsdlFile, const std::string &delegationId, ConfigContext *cfs=NULL)
 Submits a job: performs registration and triggers the submission The JDL description of the job provided by the client is validated by the service, registered to the LB and finally passed to the Workload Manager.
void glite::wms::wmproxyapi::jobStart (const std::string &jobid, ConfigContext *cfs=NULL)
 Triggers the submission of a previously registered job.
WMProxy Job operation services



void glite::wms::wmproxyapi::jobCancel (const std::string &jobid, ConfigContext *cfs=NULL)
 Sends cancellation request for a previously submitted job identified by its JobId.
void glite::wms::wmproxyapi::jobPurge (const std::string &jobid, ConfigContext *cfs=NULL)
 Removes from the WM managed space all files related to the job identified by the jobId provided as input.
std::vector< std::pair
< std::string, long > > 
glite::wms::wmproxyapi::jobListMatch (const std::string &jdl, const std::string &delegationId, ConfigContext *cfs=NULL)
 Returns the list of CE Ids satisfying the job Requirements specified in the JDL, ordered according to the decreasing Rank.
std::vector< std::pair
< std::string, long > > 
glite::wms::wmproxyapi::jobListMatchJSDL (std::ifstream &jsdlFile, const std::string &delegationId, ConfigContext *cfs=NULL)
 Returns the list of CE Ids satisfying the job Requirements specified in the JDL, ordered according to the decreasing Rank.
WMProxy Info retrieval services



std::string glite::wms::wmproxyapi::getVersion (ConfigContext *cfs=NULL)
 Retrieve the service version information.
long glite::wms::wmproxyapi::getMaxInputSandboxSize (ConfigContext *cfs=NULL)
 Returns the maximum Input sandbox size (in bytes) that a user can count on for a job submission if using the space managed by the WM.
std::vector< std::string > glite::wms::wmproxyapi::getTransferProtocols (ConfigContext *cfs)
 Returns a list with the available transfer protocols on the WMProxy server.
std::vector< std::string > glite::wms::wmproxyapi::getSandboxDestURI (const std::string &jobid, ConfigContext *cfs=NULL, const std::string &protocol="")
 Returns a list of destination URI's associated to the job (identified by the jobId provided as input) where the job input sandbox files can be uploaded by the client.
std::vector< std::pair
< std::string,std::vector
< std::string > > > 
glite::wms::wmproxyapi::getSandboxBulkDestURI (std::string jobid, ConfigContext *cfs=NULL, const std::string &protocol="")
 Returns a list of destination URI's associated to the job and its children in case of DAG's and collections, where the job input sandbox files can be uploaded by the client on the WMS node.
std::pair< long, long > glite::wms::wmproxyapi::getFreeQuota (ConfigContext *cfs=NULL)
std::pair< long, long > glite::wms::wmproxyapi::getTotalQuota (ConfigContext *cfs=NULL)
 Returns the remaining free part of available user disk quota (in bytes).
std::vector< std::pair
< std::string, long > > 
glite::wms::wmproxyapi::getOutputFileList (const std::string &jobid, ConfigContext *cfs=NULL, const std::string &protocol="")
 Retrieves the list of URIs where the output files created during job execution have been stored in the WM managed space and the corresponding sizes in bytes.
std::string glite::wms::wmproxyapi::getJDL (const std::string &jobid, const JdlType &jdlType, ConfigContext *cfs=NULL)
 Returns the JDL string which identifier is the input JobId.
WMProxy Perusal services



void glite::wms::wmproxyapi::enableFilePerusal (const std::string &jobid, const std::vector< std::string > &files, ConfigContext *cfs=NULL)
 Enables file perusal functionalities if not disabled with the specific jdl attribute during job register operation.
std::vector< std::string > glite::wms::wmproxyapi::getPerusalFiles (const std::string &jobid, const std::string &file, const bool &allchunks, ConfigContext *cfs=NULL, const std::string &protocol="")
 Gets the URIs of perusal files generated during job execution for the specified file file.
WMProxy Templates creation services



std::string glite::wms::wmproxyapi::getJobTemplate (int type, const std::string &executable, const std::string &arguments, const std::string &requirements, const std::string &rank, ConfigContext *cfs=NULL)
 Creates a valid template ready for submission for a job.
std::string glite::wms::wmproxyapi::getDAGTemplate (NodeStruct dependencies, const std::string &requirements, const std::string &rank, ConfigContext *cfs=NULL)
 Creates a valid template ready for submission for a DAG.
std::string glite::wms::wmproxyapi::getCollectionTemplate (int jobNumber, const std::string &requirements, const std::string &rank, ConfigContext *cfs=NULL)
 Creates a valid template JDL for a collection of jobs.
std::string glite::wms::wmproxyapi::getIntParametricJobTemplate (std::vector< std::string > attributes, int parameters, int start, int step, const std::string &requirements, const std::string &rank, ConfigContext *cfs=NULL)
 Creates a valid template JDL for a parametric job.
std::string glite::wms::wmproxyapi::getStringParametricJobTemplate (std::vector< std::string >attributes, std::vector< std::string > parameters, const std::string &requirements, const std::string &rank, ConfigContext *cfs=NULL)
 Creates a valid template JDL for a parametric job.
WMProxy Certificates manipulation/info retrieval services



std::string glite::wms::wmproxyapi::getProxyReq (const std::string &delegationId, ConfigContext *cfs=NULL)
 Generates a proxy certificate in PEM format with Base64 encoding.
std::string glite::wms::wmproxyapi::grst1GetProxyReq (const std::string &delegationId, ConfigContext *cfs=NULL)
 Generates a proxy certificate in PEM format with Base64 encoding.
std::string glite::wms::wmproxyapi::grstGetProxyReq (const std::string &delegationId, ConfigContext *cfs=NULL)
ProxyReqStruct glite::wms::wmproxyapi::getNewProxyReq (ConfigContext *cfs)
 Generates a proxy certificate in PEM format with Base64 encoding that is associated to a server side generated sting identifier (delegation ID) This method must be followed by a putProxy call.
std::string glite::wms::wmproxyapi::getDelegationVersion (ConfigContext *cfs)
 Returns the version number of the delegation services.
std::string glite::wms::wmproxyapi::getDelegationInterfaceVersion (ConfigContext *cfs)
 Returns the version number of the delegation interface.
int glite::wms::wmproxyapi::getProxyTerminationTime (const std::string &delegationId, ConfigContext *cfs)
 Returns the time left of the delegated proxy that is identified by the "delegatioId" string.
void glite::wms::wmproxyapi::proxyDestroy (const std::string &delegationId, ConfigContext *cfs)
 Sends a request for removing of delegated proxy that is identified by the "delegatioId" string.
std::string glite::wms::wmproxyapi::renewProxyReq (const std::string &delegationId, ConfigContext *cfs)
 Sends a request for renewal of delegated proxy that is identified by the "delegatioId" string.
void glite::wms::wmproxyapi::putProxy (const std::string &delegationId, const std::string &request, ConfigContext *cfs=NULL)
 Associates the current proxy certificate file with a previously created delegation id.This method must be called after a getProxyReq call This method remains to keep compatibility with the version 1.0.0 of WMProxy servers, but it will be soon deprecated.
void glite::wms::wmproxyapi::grst1PutProxy (const std::string &delegationId, const std::string &request, ConfigContext *cfs=NULL)
 Associates the current proxy certificate file with a previously created delegation id.This method must be called after a getProxyReq call This method can be only used invoking WMProxy servers with version greater than or equal to 2.0.0; the version of the server can be retrieved by calling the getVersion service.
void glite::wms::wmproxyapi::grstPutProxy (const std::string &delegationId, const std::string &request, ConfigContext *cfs=NULL)
ProxyInfoStructType * glite::wms::wmproxyapi::getDelegatedProxyInfo (const std::string &delegationId, ConfigContext *cfs=NULL)
 Returns the Delegated Proxy information identified by the delegationId string.
ProxyInfoStructType * glite::wms::wmproxyapi::getJobProxyInfo (const std::string &jobId, ConfigContext *cfs=NULL)
 Returns the information related to the proxy used to submit a job that identified by its JobId.

Enumeration



enum  glite::wms::wmproxyapi::JdlType { glite::wms::wmproxyapi::ORIGINAL, glite::wms::wmproxyapi::REGISTERED }
 

Used to specify the JdlType, whether is original or registered.

More...
enum  glite::wms::wmproxyapi::jobtype {
  glite::wms::wmproxyapi::JOBTYPE_NORMAL = 1, glite::wms::wmproxyapi::JOBTYPE_PARAMETRIC = 2, glite::wms::wmproxyapi::JOBTYPE_INTERACTIVE = 4, glite::wms::wmproxyapi::JOBTYPE_MPICH = 8,
  glite::wms::wmproxyapi::JOBTYPE_PARTITIONABLE = 16, glite::wms::wmproxyapi::JOBTYPE_CHECKPOINTABLE = 32
}
 

Used to specify the jobtype.

More...
void glite::wms::wmproxyapi::setServerAuthentication (ConfigContext *cfs, bool auth)
 Checks if CA verification has been disabled by user.

Detailed Description

wsdl wmproxy service wrapper A wrapper around wmproxy Web Service.

It provides primitive or simple structure to access more complicated service methods


Generated on 16 May 2012 for glite-wms-wmproxy-api-cpp-3.3.3 by  doxygen 1.6.1