WebService Class Reference
[Framework for the Web Services]
A Web Service abstract class.
More...
Inherited by AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, CompoundWebService, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
Public Member Functions | |
| __construct () | |
| __destruct () | |
| ws_conneg ($accept, $accept_charset, $accept_encoding, $accept_language) | |
| does the content negotiation for the queries that come from the Web (when this class acts as a Web Service) | |
| ws_serialize () | |
| Output the content generated by the class in some serialization format. | |
| ws_respond ($content) | |
| Sends the respond to the user. The $content should come from ws_serialize() to be valid according to the conneg with the user. | |
| process () | |
| Process the functionality of the web service. | |
| pipeline_conneg ($accept, $accept_charset, $accept_encoding, $accept_language) | |
| Propagate the conneg to the nodes that belong to the current pipeline of web services. | |
| pipeline_getResponseHeaderStatus () | |
| Returns the response HTTP header status. | |
| pipeline_getError () | |
| Returns the error structure. | |
| pipeline_getResponseHeaderStatusMsg () | |
| Returns the response HTTP header status message. | |
| pipeline_getResponseHeaderStatusMsgExt () | |
| Returns the response HTTP header status message extension. | |
| pipeline_getResultset () | |
| Create a resultset in a pipelined mode based on the processed information by the Web service. | |
| pipeline_serialize () | |
| Serialize content into different serialization formats. | |
| pipeline_serialize_reification () | |
| Returns the description of the reification of some triples defined by pipeline_serialize(). | |
| injectDoctype ($xmlDoc) | |
| Inject the DOCType in a XML document. | |
| xmlEncode ($string) | |
| Encode content to be included in XML files. | |
| jsonEncode ($string) | |
| Encode a string to put in a JSON value. | |
Static Public Attributes | |
| static | $data_ini = "/data/" |
| data.ini file folder | |
| static | $network_ini = "/usr/share/structwsf/" |
| network.ini file folder | |
Protected Member Functions | |
| validateQuery () | |
| Validate a query to this web service. | |
Protected Attributes | |
| $db_username = "" | |
| Database user name. | |
| $db_password = "" | |
| Database password. | |
| $db_dsn = "" | |
| Database DSN connection. | |
| $db_host = "localhost" | |
| Database host. | |
| $dtdBaseURL = "" | |
| DTD URL of the web service. | |
| $wsf_graph = "" | |
| The graph where the Web Services Framework description has been indexed. | |
| $wsf_base_url = "" | |
| Base URL of the WSF. | |
| $wsf_base_path = "" | |
| Local server path of the WSF files. | |
| $wsf_local_ip = "" | |
| Local server path of the WSF files. | |
| $wsf_solr_core = "" | |
| The core to use for Solr; "" for no core. | |
| $ontologies_files_folder = "" | |
| Path to the ontologies description files (in RDFS and OWL). | |
| $solr_host = "localhost" | |
| Hostname where to send queries to the Solr instance. | |
| $ontological_structure_folder = "" | |
| Path to the structWSF ontological structure. | |
| $log_table = "SD.WSF.ws_queries_log" | |
| Name of the logging table on the Virtuoso instance. | |
| $solr_auto_commit = FALSE | |
| Auto commit handled by the Solr data management systems. If this parameter is true, then this means Solr will handle the commit operation by itself. If it is false, then the web services will trigger the commit operations. Usually, Auto-commit should be handled by Solr when the size of the dataset is too big, otherwise operation such as delete could take much time. | |
| $uri | |
| The URI of the Authentication Registrar web service. | |
| $title | |
| The Title of the Authentication Registrar web service. | |
| $crud_usage | |
| The CRUD usage of the Authentication Registrar web service. | |
| $endpoint | |
| The endpoint of the Authentication Registrar web service. | |
Detailed Description
A Web Service abstract class.This abstract class is used to define a web service that can interact with external webservices, or web services in a pipeline (compound), in a RESTful way.
- Todo:
- Creating a DTD for creating structured error reports
- Todo:
- Extension of the web service framework to enable the integration of a caching system (like memcached)
Definition at line 31 of file WebService.php.
Constructor & Destructor Documentation
| WebService::__construct | ( | ) |
Reimplemented in CompoundWebService.
Definition at line 100 of file WebService.php.
References $data_ini, and $network_ini.
Referenced by Sparql::__construct(), Search::__construct(), OntologyCreate::__construct(), DatasetUpdate::__construct(), DatasetRead::__construct(), DatasetDelete::__construct(), DatasetCreate::__construct(), CrudUpdate::__construct(), CrudRead::__construct(), CrudDelete::__construct(), CrudCreate::__construct(), ConverterTsv::__construct(), ConverterIrJSON::__construct(), ConverterBibtex::__construct(), Browse::__construct(), AuthValidator::__construct(), AuthRegistrarWs::__construct(), AuthRegistrarAccess::__construct(), and AuthLister::__construct().
| WebService::__destruct | ( | ) |
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, CompoundWebService, OntologyCreate, Search, and Sparql.
Definition at line 179 of file WebService.php.
Member Function Documentation
| WebService::injectDoctype | ( | $ | xmlDoc | ) | [abstract] |
Inject the DOCType in a XML document.
- Parameters:
-
[in] $xmlDoc The XML document where to inject the doctype
- Returns:
- a XML document with a doctype
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::jsonEncode | ( | $ | string | ) |
Encode a string to put in a JSON value.
- Parameters:
-
[in] $string The string to escape
- Returns:
- returns the escaped string
Definition at line 398 of file WebService.php.
Referenced by Sparql::pipeline_serialize(), Search::pipeline_serialize(), DatasetRead::pipeline_serialize(), CrudRead::pipeline_serialize(), Browse::pipeline_serialize(), and AuthLister::pipeline_serialize().
| WebService::pipeline_conneg | ( | $ | accept, | |
| $ | accept_charset, | |||
| $ | accept_encoding, | |||
| $ | accept_language | |||
| ) | [abstract] |
Propagate the conneg to the nodes that belong to the current pipeline of web services.
- Parameters:
-
[in] $accept Accepted mime types (HTTP header) [in] $accept_charset Accepted charsets (HTTP header) [in] $accept_encoding Accepted encodings (HTTP header) [in] $accept_language Accepted languages (HTTP header)
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::pipeline_getError | ( | ) | [abstract] |
Returns the error structure.
- Returns:
- returns the error structure
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::pipeline_getResponseHeaderStatus | ( | ) | [abstract] |
Returns the response HTTP header status.
- Returns:
- returns the response HTTP header status
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::pipeline_getResponseHeaderStatusMsg | ( | ) | [abstract] |
Returns the response HTTP header status message.
- Returns:
- returns the response HTTP header status message
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::pipeline_getResponseHeaderStatusMsgExt | ( | ) | [abstract] |
Returns the response HTTP header status message extension.
- Returns:
- returns the response HTTP header status message extension
- Note:
- The extension of a HTTP status message is
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::pipeline_getResultset | ( | ) | [abstract] |
Create a resultset in a pipelined mode based on the processed information by the Web service.
- Returns:
- a resultset XML document
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::pipeline_serialize | ( | ) | [abstract] |
Serialize content into different serialization formats.
- Returns:
- returns the serialized content
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::pipeline_serialize_reification | ( | ) | [abstract] |
Returns the description of the reification of some triples defined by pipeline_serialize().
- Note:
- most of the web services won't implement this procedure.
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::process | ( | ) | [abstract] |
Process the functionality of the web service.
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::validateQuery | ( | ) | [abstract, protected] |
Validate a query to this web service.
- Returns:
- TRUE if valid; FALSE otherwise
- Note:
- Usually, this function sends a query to the Authentication web service in order to be validated.
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::ws_conneg | ( | $ | accept, | |
| $ | accept_charset, | |||
| $ | accept_encoding, | |||
| $ | accept_language | |||
| ) | [abstract] |
does the content negotiation for the queries that come from the Web (when this class acts as a Web Service)
- Parameters:
-
[in] $accept Accepted mime types (HTTP header) [in] $accept_charset Accepted charsets (HTTP header) [in] $accept_encoding Accepted encodings (HTTP header) [in] $accept_language Accepted languages (HTTP header)
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::ws_respond | ( | $ | content | ) | [abstract] |
Sends the respond to the user. The $content should come from ws_serialize() to be valid according to the conneg with the user.
- Parameters:
-
[in] $content The content (body) of the response.
- Returns:
- NULL
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::ws_serialize | ( | ) | [abstract] |
Output the content generated by the class in some serialization format.
- Returns:
- returns the serialized content
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, OntologyCreate, Search, and Sparql.
| WebService::xmlEncode | ( | $ | string | ) |
Encode content to be included in XML files.
- Parameters:
-
[in] $string The content string to be encoded
- Returns:
- returns the encoded string
Definition at line 383 of file WebService.php.
Referenced by Sparql::pipeline_getResultset(), Search::pipeline_getResultset(), DatasetRead::pipeline_getResultset(), CrudRead::pipeline_getResultset(), ConverterTsv::pipeline_getResultset(), ConverterIrJSON::pipeline_getResultset(), Browse::pipeline_getResultset(), AuthLister::pipeline_getResultset(), Sparql::pipeline_serialize(), Search::pipeline_serialize(), CrudRead::pipeline_serialize(), ConverterTsv::pipeline_serialize(), ConverterIrJSON::pipeline_serialize(), ConverterBibtex::pipeline_serialize(), Browse::pipeline_serialize(), Search::pipeline_serialize_reification(), CrudRead::pipeline_serialize_reification(), Browse::pipeline_serialize_reification(), CrudUpdate::process(), and CrudCreate::process().
Member Data Documentation
WebService::$crud_usage [protected] |
The CRUD usage of the Authentication Registrar web service.
Definition at line 95 of file WebService.php.
Referenced by AuthRegistrarWs::ws_conneg().
WebService::$data_ini = "/data/" [static] |
data.ini file folder
Definition at line 34 of file WebService.php.
Referenced by __construct(), and Logger::__construct().
WebService::$db_dsn = "" [protected] |
WebService::$db_host = "localhost" [protected] |
WebService::$db_password = "" [protected] |
WebService::$db_username = "" [protected] |
WebService::$dtdBaseURL = "" [protected] |
WebService::$endpoint [protected] |
The endpoint of the Authentication Registrar web service.
Definition at line 98 of file WebService.php.
WebService::$log_table = "SD.WSF.ws_queries_log" [protected] |
WebService::$network_ini = "/usr/share/structwsf/" [static] |
WebService::$ontological_structure_folder = "" [protected] |
WebService::$ontologies_files_folder = "" [protected] |
Path to the ontologies description files (in RDFS and OWL).
Definition at line 70 of file WebService.php.
WebService::$solr_auto_commit = FALSE [protected] |
Auto commit handled by the Solr data management systems. If this parameter is true, then this means Solr will handle the commit operation by itself. If it is false, then the web services will trigger the commit operations. Usually, Auto-commit should be handled by Solr when the size of the dataset is too big, otherwise operation such as delete could take much time.
Definition at line 86 of file WebService.php.
WebService::$solr_host = "localhost" [protected] |
WebService::$title [protected] |
The Title of the Authentication Registrar web service.
Definition at line 92 of file WebService.php.
Referenced by DatasetUpdate::__construct(), and DatasetRead::process().
WebService::$uri [protected] |
The URI of the Authentication Registrar web service.
Definition at line 89 of file WebService.php.
Referenced by DatasetUpdate::__construct(), DatasetRead::__construct(), DatasetDelete::__construct(), DatasetCreate::__construct(), CrudRead::__construct(), CrudDelete::__construct(), ConverterBibtex::get_uri_label(), Sparql::getNamespace(), Search::getNamespace(), DatasetRead::getNamespace(), CrudRead::getNamespace(), ConverterTsv::getNamespace(), ConverterIrJSON::getNamespace(), Browse::getNamespace(), Sparql::pipeline_getResultset(), Search::pipeline_getResultset(), ConverterTsv::pipeline_getResultset(), ConverterIrJSON::pipeline_getResultset(), Browse::pipeline_getResultset(), ConverterIrJSON::pipeline_serialize(), Search::process(), CrudUpdate::process(), CrudCreate::process(), Browse::process(), AuthRegistrarAccess::process(), DatasetRead::uriEncode(), ConverterTsv::uriEncode(), ConverterIrJSON::uriEncode(), ConverterBibtex::uriEncode(), and AuthRegistrarAccess::uriEncode().
WebService::$wsf_base_path = "" [protected] |
WebService::$wsf_base_url = "" [protected] |
WebService::$wsf_graph = "" [protected] |
The graph where the Web Services Framework description has been indexed.
Definition at line 55 of file WebService.php.
WebService::$wsf_local_ip = "" [protected] |
WebService::$wsf_solr_core = "" [protected] |
The documentation for this class was generated from the following file:
Structured Dynamics LLC. All rights reserved.