WebService Class Reference
[Framework for the Web Services]
A Web Service abstract class. More...
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. | |
| $track_create = FALSE | |
| Enable the tracking of records changes from the Crud Create web service endpoint. | |
| $track_update = FALSE | |
| Enable the tracking of records changes from the Crud Update web service endpoint. | |
| $track_delete = FALSE | |
| Enable the tracking of records changes from the Crud Delete web service endpoint. | |
| $tracking_endpoint = "" | |
| Specifies a specific WSF tracking web service endpoint URL to access the tracking endpoint. This is useful to put all the record changes tracking on a different, dedicated purposes, WSF server. If this parameter is commented, we will use the wsf_base_url to access the tracking endpoints. If it is uncommented, then we will use the endpoint specified by this parameter. | |
| $triplestore_port = "8890" | |
| Port number where the triple store server is reachable. | |
| $solr_port = "8983" | |
| Port number where the Solr store server is reachable. | |
| $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. | |
| $fields_index_folder = "/tmp/" | |
| This is the folder there the file of the index where all the fields defined in Solr are indexed. You have to make sure that the web server has write access to this folder. This folder path has to end with a slash "/". | |
| $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. | |
| $owlapiNbSessions | |
| Number of sessions (threads) to use in parallel. | |
| $owlapiBridgeURI | |
| URL where the Java Bridge can be accessed from this server. | |
| $geoEnabled = FALSE | |
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
Extension of the web service framework to enable the integration of a caching system (like memcached)
Definition at line 29 of file WebService.php.
Constructor & Destructor Documentation
| __construct | ( | ) |
Reimplemented in CompoundWebService.
Definition at line 135 of file WebService.php.
References $data_ini, $mime, and $network_ini.
Referenced by TrackerCreate::__construct(), Search::__construct(), Sparql::__construct(), DatasetUpdate::__construct(), DatasetRead::__construct(), DatasetDelete::__construct(), DatasetCreate::__construct(), CrudUpdate::__construct(), CrudRead::__construct(), CrudDelete::__construct(), CrudCreate::__construct(), ConverterTsv::__construct(), ConverterIrJSON::__construct(), ConverterCommON::__construct(), ConverterBibtex::__construct(), Browse::__construct(), AuthValidator::__construct(), AuthRegistrarWs::__construct(), AuthRegistrarAccess::__construct(), and AuthLister::__construct().
| __destruct | ( | ) |
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, CompoundWebService, Sparql, Search, Sparql, and TrackerCreate.
Definition at line 365 of file WebService.php.
Member Function Documentation
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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 591 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().
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| pipeline_getError | ( | ) | [abstract] |
Returns the error structure.
- Returns:
- returns the error structure
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| pipeline_getResponseHeaderStatus | ( | ) | [abstract] |
Returns the response HTTP header status.
- Returns:
- returns the response HTTP header status
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| pipeline_serialize | ( | ) | [abstract] |
Serialize content into different serialization formats.
- Returns:
- returns the serialized content
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| process | ( | ) | [abstract] |
Process the functionality of the web service.
Reimplemented in AuthLister, AuthRegistrarAccess, AuthRegistrarWs, AuthValidator, Browse, ConverterBibtex, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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, ConverterCommON, ConverterIrJSON, ConverterTsv, CrudCreate, CrudDelete, CrudRead, CrudUpdate, DatasetCreate, DatasetDelete, DatasetRead, DatasetUpdate, Sparql, Search, Sparql, and TrackerCreate.
| 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 569 of file WebService.php.
Referenced by ConverterCommON::pipeline_getResultset(), Sparql::pipeline_serialize(), Search::pipeline_serialize(), DatasetRead::pipeline_serialize(), CrudRead::pipeline_serialize(), ConverterTsv::pipeline_serialize(), ConverterIrJSON::pipeline_serialize(), ConverterBibtex::pipeline_serialize(), Browse::pipeline_serialize(), AuthLister::pipeline_serialize(), Search::pipeline_serialize_reification(), CrudRead::pipeline_serialize_reification(), ConverterIrJSON::pipeline_serialize_reification(), Browse::pipeline_serialize_reification(), CrudUpdate::process(), and CrudCreate::process().
Field Documentation
$crud_usage [protected] |
The CRUD usage of the Authentication Registrar web service.
Definition at line 122 of file WebService.php.
Referenced by AuthRegistrarWs::ws_conneg().
$data_ini = "/data/" [static] |
data.ini file folder
Definition at line 32 of file WebService.php.
Referenced by __construct(), and Logger::__construct().
$db_dsn = "" [protected] |
Database DSN connection.
Definition at line 44 of file WebService.php.
$db_host = "localhost" [protected] |
Database host.
Definition at line 47 of file WebService.php.
$db_password = "" [protected] |
Database password.
Definition at line 41 of file WebService.php.
$db_username = "" [protected] |
Database user name.
Definition at line 38 of file WebService.php.
$dtdBaseURL = "" [protected] |
DTD URL of the web service.
Definition at line 50 of file WebService.php.
$endpoint [protected] |
The endpoint of the Authentication Registrar web service.
Definition at line 125 of file WebService.php.
Referenced by CrudUpdate::process(), CrudDelete::process(), and CrudCreate::process().
$fields_index_folder = "/tmp/" [protected] |
This is the folder there the file of the index where all the fields defined in Solr are indexed. You have to make sure that the web server has write access to this folder. This folder path has to end with a slash "/".
Definition at line 113 of file WebService.php.
$geoEnabled = FALSE [protected] |
Definition at line 133 of file WebService.php.
$log_table = "SD.WSF.ws_queries_log" [protected] |
Name of the logging table on the Virtuoso instance.
Definition at line 100 of file WebService.php.
$network_ini = "/usr/share/structwsf/" [static] |
$ontological_structure_folder = "" [protected] |
Path to the structWSF ontological structure.
Definition at line 74 of file WebService.php.
$ontologies_files_folder = "" [protected] |
Path to the ontologies description files (in RDFS and OWL).
Definition at line 68 of file WebService.php.
$owlapiBridgeURI [protected] |
URL where the Java Bridge can be accessed from this server.
Definition at line 131 of file WebService.php.
$owlapiNbSessions [protected] |
Number of sessions (threads) to use in parallel.
Definition at line 128 of file WebService.php.
$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 107 of file WebService.php.
$solr_host = "localhost" [protected] |
Hostname where to send queries to the Solr instance.
Definition at line 71 of file WebService.php.
$solr_port = "8983" [protected] |
Port number where the Solr store server is reachable.
Definition at line 96 of file WebService.php.
$title [protected] |
The Title of the Authentication Registrar web service.
Definition at line 119 of file WebService.php.
Referenced by DatasetUpdate::__construct(), and DatasetRead::process().
$track_create = FALSE [protected] |
Enable the tracking of records changes from the Crud Create web service endpoint.
Definition at line 77 of file WebService.php.
$track_delete = FALSE [protected] |
Enable the tracking of records changes from the Crud Delete web service endpoint.
Definition at line 83 of file WebService.php.
$track_update = FALSE [protected] |
Enable the tracking of records changes from the Crud Update web service endpoint.
Definition at line 80 of file WebService.php.
$tracking_endpoint = "" [protected] |
Specifies a specific WSF tracking web service endpoint URL to access the tracking endpoint. This is useful to put all the record changes tracking on a different, dedicated purposes, WSF server. If this parameter is commented, we will use the wsf_base_url to access the tracking endpoints. If it is uncommented, then we will use the endpoint specified by this parameter.
Definition at line 90 of file WebService.php.
$triplestore_port = "8890" [protected] |
Port number where the triple store server is reachable.
Definition at line 93 of file WebService.php.
$uri [protected] |
The URI of the Authentication Registrar web service.
Definition at line 116 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(), ConverterCommON::getNamespace(), Browse::getNamespace(), Sparql::pipeline_getResultset(), Search::pipeline_getResultset(), ConverterTsv::pipeline_getResultset(), ConverterIrJSON::pipeline_getResultset(), Browse::pipeline_getResultset(), ConverterIrJSON::pipeline_serialize(), Sparql::prefixToUri(), Search::process(), CrudUpdate::process(), CrudCreate::process(), Browse::process(), AuthRegistrarAccess::process(), DatasetRead::uriEncode(), ConverterTsv::uriEncode(), ConverterIrJSON::uriEncode(), ConverterCommON::uriEncode(), ConverterBibtex::uriEncode(), and AuthRegistrarAccess::uriEncode().
$wsf_base_path = "" [protected] |
Local server path of the WSF files.
Definition at line 59 of file WebService.php.
$wsf_base_url = "" [protected] |
Base URL of the WSF.
Definition at line 56 of file WebService.php.
$wsf_graph = "" [protected] |
The graph where the Web Services Framework description has been indexed.
Definition at line 53 of file WebService.php.
$wsf_local_ip = "" [protected] |
Local server path of the WSF files.
Definition at line 62 of file WebService.php.
$wsf_solr_core = "" [protected] |
The core to use for Solr; "" for no core.
Definition at line 65 of file WebService.php.
The documentation for this class was generated from the following file:
Structured Dynamics LLC. All rights reserved.