ARC SDK
Public Member Functions | Static Public Member Functions
Arc::WSCommonPlugin< T > Class Template Reference

A general wrapping class that adds common functions for all ARC WS-interface plugins. More...

#include <arc/compute/WSCommonPlugin.h>

Inheritance diagram for Arc::WSCommonPlugin< T >:

Public Member Functions

 WSCommonPlugin (PluginArgument *parg)
 
virtual bool isEndpointNotSupported (const Endpoint &endpoint) const
 Check that endpoint is WS endpoint. More...
 

Static Public Member Functions

static URL CreateURL (std::string service)
 Create WS endpoint URL from the provided service endpoint string. More...
 

Detailed Description

template<class T>
class Arc::WSCommonPlugin< T >

A general wrapping class that adds common functions for all ARC WS-interface plugins.

A class implementing EntityRetrieverPlugin for WS-based ARC interface (that inherits TargetInformationRetrieverPlugin and JobListRetrieverPlugin in particular) and making use of the common WS methods implementation needs to inherit WSCommonPlugin instead with the particular EntityRetrieverPlugin specified as a template argument

Member Function Documentation

◆ CreateURL()

template<class T >
static URL Arc::WSCommonPlugin< T >::CreateURL ( std::string  service)
inlinestatic

Create WS endpoint URL from the provided service endpoint string.

This method return endpoint URL using the following logic:

  • if provided name is a string with protocol prefix - check that protocol matches http(s) and return it or empty endpoint otherwise
  • if provided name is a string without protocol prefix treat it as a hostname and construct WS URL assuming default port and /arex endpoint path

◆ isEndpointNotSupported()

template<class T >
virtual bool Arc::WSCommonPlugin< T >::isEndpointNotSupported ( const Endpoint endpoint) const
inlinevirtual

Check that endpoint is WS endpoint.

This method implements endpoint filtering to be accepted by WS plugin. To be accepted the Endpoint URL:

  • with protocol prefix must match http(s) protocol
  • without any protocol prefix URLs are allowed for hostname-based submission to WS services

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