CrudUpdate Class Reference
[Authentication / Registration Web Service]

CRUD Update web service. It updates instance records descriptions from dataset indexes on different systems (Virtuoso, Solr, etc). More...

Inherits WebService.

Collaboration diagram for CrudUpdate:

[legend]

List of all members.

Public Member Functions

__construct ($document, $mime, $dataset, $registered_ip, $requester_ip)

Constructor.

__destruct ()

pipeline_getError ()

Returns the error structure.

pipeline_getResultset ()

Create a resultset in a pipelined mode based on the processed information by the Web service.

injectDoctype ($xmlDoc)

Inject the DOCType in a XML document.

ws_conneg ($accept, $accept_charset, $accept_encoding, $accept_language)

Do content negotiation as an external Web Service.

pipeline_conneg ($accept, $accept_charset, $accept_encoding, $accept_language)

Do content negotiation as an internal, pipelined, Web Service that is part of a Compound Web Service.

pipeline_getResponseHeaderStatus ()

Returns the response HTTP header status.

pipeline_getResponseHeaderStatusMsg ()

Returns the response HTTP header status message.

pipeline_getResponseHeaderStatusMsgExt ()

Returns the response HTTP header status message extension.

pipeline_serialize ()

Serialize the web service answer.

pipeline_serialize_reification ()

Non implemented method (only defined).

ws_serialize ()

Serialize the web service answer.

ws_respond ($content)

Sends the HTTP response to the requester.

process ()

Update the information of a given instance record.

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 $supportedSerializations

Supported serialization mime types by this Web service.

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.

Private Attributes

$db

Database connection.

$conneg

Conneg object that manage the content negotiation capabilities of the web service.

$dtdURL

URL where the DTD of the XML document can be located on the Web.

$registered_ip = ""

IP being registered.

$dataset

Dataset where to index the resource.

$document = array()

RDF document where resource(s) to be added are described. Maximum size (by default) is 8M (default php.ini setting).

$mime = ""

Mime of the RDF document serialization.

$requester_ip = ""

Requester's IP used for request validation.

$errorMessenger

Error messages of this web service.

Detailed Description

CRUD Update web service. It updates instance records descriptions from dataset indexes on different systems (Virtuoso, Solr, etc).

Author:: Frederick Giasson, Structured Dynamics LLC.

Definition at line 26 of file CrudUpdate.php.

Constructor & Destructor Documentation

CrudUpdate::__construct	(	$	document,
		$	mime,
		$	dataset,
		$	registered_ip,
		$	requester_ip
	)

Constructor.

Initialize the Crud Update

Returns:: returns NULL

Author:: Frederick Giasson, Structured Dynamics LLC.

Definition at line 141 of file CrudUpdate.php.

References $dataset, $document, $mime, $registered_ip, $requester_ip, and WebService::__construct().

Here is the call graph for this function:

CrudUpdate::__destruct ( )

Reimplemented from WebService.

Definition at line 184 of file CrudUpdate.php.

Referenced by ws_respond().

Member Function Documentation

CrudUpdate::injectDoctype ( $ xmlDoc )

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

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 285 of file CrudUpdate.php.

WebService::jsonEncode ( $ string ) [inherited]

Encode a string to put in a JSON value.

Parameters:

[in] $string The string to escape

Returns:: returns the escaped string

Author:: Frederick Giasson, Structured Dynamics LLC.

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().

CrudUpdate::pipeline_conneg	(	$	accept,
		$	accept_charset,
		$	accept_encoding,
		$	accept_language
	)

Do content negotiation as an internal, pipelined, Web Service that is part of a Compound 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)

Returns:: returns NULL

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 396 of file CrudUpdate.php.

References ws_conneg().

Here is the call graph for this function:

CrudUpdate::pipeline_getError ( )

Returns the error structure.

Returns:: returns the error structure

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 258 of file CrudUpdate.php.

CrudUpdate::pipeline_getResponseHeaderStatus ( )

Returns the response HTTP header status.

Returns:: returns the response HTTP header status

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 409 of file CrudUpdate.php.

CrudUpdate::pipeline_getResponseHeaderStatusMsg ( )

Returns the response HTTP header status message.

Returns:: returns the response HTTP header status message

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 421 of file CrudUpdate.php.

CrudUpdate::pipeline_getResponseHeaderStatusMsgExt ( )

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

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 435 of file CrudUpdate.php.

CrudUpdate::pipeline_getResultset ( )

Create a resultset in a pipelined mode based on the processed information by the Web service.

Returns:: a resultset XML document

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 271 of file CrudUpdate.php.

CrudUpdate::pipeline_serialize ( )

Serialize the web service answer.

Returns:: returns the serialized content

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 447 of file CrudUpdate.php.

CrudUpdate::pipeline_serialize_reification ( )

Non implemented method (only defined).

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 457 of file CrudUpdate.php.

CrudUpdate::process ( )

Update the information of a given instance record.

Author:: Frederick Giasson, Structured Dynamics LLC.

Todo:: Fixing this to use the DB.

This method is currently not working. The problem is that we ahve an issue in CrudCreate and Virtuoso's LONG VARCHAR column. It appears that there is a bug somewhere in the "php -> odbc -> virtuoso" path. If we are not requesting to return the LONG VARCHAR column, everything works fine.

Reimplemented from WebService.

Definition at line 508 of file CrudUpdate.php.

References Namespaces::$dcterms, $description, Namespaces::$foaf, Namespaces::$iron, $query, Namespaces::$rdfs, Namespaces::$skos_2004, Namespaces::$skos_2008, $type, $types, WebService::$uri, validateQuery(), and WebService::xmlEncode().

Here is the call graph for this function:

CrudUpdate::validateQuery ( ) [protected]

Validate a query to this web service.

Returns:: TRUE if valid; FALSE otherwise

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 204 of file CrudUpdate.php.

References $ws_av.

Referenced by process().

CrudUpdate::ws_conneg	(	$	accept,
		$	accept_charset,
		$	accept_encoding,
		$	accept_language
	)

Do content negotiation as an external 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)

Returns:: returns NULL

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 313 of file CrudUpdate.php.

References $supportedSerializations, and $ws_dr.

Referenced by pipeline_conneg().

CrudUpdate::ws_respond ( $ content )

Sends the HTTP response to the requester.

Parameters:

[in] $content The content (body) of the response.

Returns:: NULL

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 483 of file CrudUpdate.php.

References __destruct().

Here is the call graph for this function:

CrudUpdate::ws_serialize ( )

Serialize the web service answer.

Returns:: returns the serialized content

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 469 of file CrudUpdate.php.

WebService::xmlEncode ( $ string ) [inherited]

Encode content to be included in XML files.

Parameters:

[in] $string The content string to be encoded

Returns:: returns the encoded string

Author:: Frederick Giasson, Structured Dynamics LLC.

Definition at line 383 of file WebService.php.

Member Data Documentation

CrudUpdate::$conneg [private]

Conneg object that manage the content negotiation capabilities of the web service.

Definition at line 32 of file CrudUpdate.php.

WebService::$crud_usage [protected, inherited]

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, inherited]

data.ini file folder

Definition at line 34 of file WebService.php.

Referenced by WebService::__construct(), and Logger::__construct().

CrudUpdate::$dataset [private]

Dataset where to index the resource.

Definition at line 46 of file CrudUpdate.php.

Referenced by __construct().

CrudUpdate::$db [private]

Database connection.

Definition at line 29 of file CrudUpdate.php.

WebService::$db_dsn = "" [protected, inherited]

Database DSN connection.

Definition at line 46 of file WebService.php.

WebService::$db_host = "localhost" [protected, inherited]

Database host.

Definition at line 49 of file WebService.php.

WebService::$db_password = "" [protected, inherited]

Database password.

Definition at line 43 of file WebService.php.

WebService::$db_username = "" [protected, inherited]

Database user name.

Definition at line 40 of file WebService.php.

CrudUpdate::$document = array() [private]

RDF document where resource(s) to be added are described. Maximum size (by default) is 8M (default php.ini setting).

Definition at line 49 of file CrudUpdate.php.

Referenced by __construct().

WebService::$dtdBaseURL = "" [protected, inherited]

DTD URL of the web service.

Definition at line 52 of file WebService.php.

CrudUpdate::$dtdURL [private]

URL where the DTD of the XML document can be located on the Web.

Definition at line 35 of file CrudUpdate.php.

WebService::$endpoint [protected, inherited]

The endpoint of the Authentication Registrar web service.

Definition at line 98 of file WebService.php.

CrudUpdate::$errorMessenger [private]

Error messages of this web service.

Definition at line 58 of file CrudUpdate.php.

WebService::$log_table = "SD.WSF.ws_queries_log" [protected, inherited]

Name of the logging table on the Virtuoso instance.

Definition at line 79 of file WebService.php.

CrudUpdate::$mime = "" [private]

Mime of the RDF document serialization.

Definition at line 52 of file CrudUpdate.php.

Referenced by __construct().

WebService::$network_ini = "/usr/share/structwsf/" [static, inherited]

network.ini file folder

Definition at line 37 of file WebService.php.

Referenced by WebService::__construct().

WebService::$ontological_structure_folder = "" [protected, inherited]

Path to the structWSF ontological structure.

Definition at line 76 of file WebService.php.

WebService::$ontologies_files_folder = "" [protected, inherited]

Path to the ontologies description files (in RDFS and OWL).

Definition at line 70 of file WebService.php.

CrudUpdate::$registered_ip = "" [private]

IP being registered.

Definition at line 43 of file CrudUpdate.php.

Referenced by __construct().

CrudUpdate::$requester_ip = "" [private]

Requester's IP used for request validation.

Definition at line 55 of file CrudUpdate.php.

Referenced by __construct().

WebService::$solr_auto_commit = FALSE [protected, inherited]

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, inherited]

Hostname where to send queries to the Solr instance.

Definition at line 73 of file WebService.php.

CrudUpdate::$supportedSerializations [static]

Initial value:

    array ("application/json", "application/rdf+xml", "application/rdf+n3", "application/*", "text/xml", "text/*",
      "*/*")

Supported serialization mime types by this Web service.

Definition at line 38 of file CrudUpdate.php.

Referenced by ws_conneg().

WebService::$title [protected, inherited]

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, inherited]

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(), process(), CrudCreate::process(), Browse::process(), AuthRegistrarAccess::process(), DatasetRead::uriEncode(), ConverterTsv::uriEncode(), ConverterIrJSON::uriEncode(), ConverterBibtex::uriEncode(), and AuthRegistrarAccess::uriEncode().

WebService::$wsf_base_path = "" [protected, inherited]

Local server path of the WSF files.

Definition at line 61 of file WebService.php.

WebService::$wsf_base_url = "" [protected, inherited]

Base URL of the WSF.

Definition at line 58 of file WebService.php.

WebService::$wsf_graph = "" [protected, inherited]

The graph where the Web Services Framework description has been indexed.

Definition at line 55 of file WebService.php.

WebService::$wsf_local_ip = "" [protected, inherited]

Local server path of the WSF files.

Definition at line 64 of file WebService.php.

WebService::$wsf_solr_core = "" [protected, inherited]

The core to use for Solr; "" for no core.

Definition at line 67 of file WebService.php.

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

CrudUpdate.php


Public Member Functions
	__construct ($document, $mime, $dataset, $registered_ip, $requester_ip)
	Constructor.
	__destruct ()
	pipeline_getError ()
	Returns the error structure.
	pipeline_getResultset ()
	Create a resultset in a pipelined mode based on the processed information by the Web service.
	injectDoctype ($xmlDoc)
	Inject the DOCType in a XML document.
	ws_conneg ($accept, $accept_charset, $accept_encoding, $accept_language)
	Do content negotiation as an external Web Service.
	pipeline_conneg ($accept, $accept_charset, $accept_encoding, $accept_language)
	Do content negotiation as an internal, pipelined, Web Service that is part of a Compound Web Service.
	pipeline_getResponseHeaderStatus ()
	Returns the response HTTP header status.
	pipeline_getResponseHeaderStatusMsg ()
	Returns the response HTTP header status message.
	pipeline_getResponseHeaderStatusMsgExt ()
	Returns the response HTTP header status message extension.
	pipeline_serialize ()
	Serialize the web service answer.
	pipeline_serialize_reification ()
	Non implemented method (only defined).
	ws_serialize ()
	Serialize the web service answer.
	ws_respond ($content)
	Sends the HTTP response to the requester.
	process ()
	Update the information of a given instance record.
	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	$supportedSerializations
	Supported serialization mime types by this Web service.
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.
Private Attributes
	$db
	Database connection.
	$conneg
	Conneg object that manage the content negotiation capabilities of the web service.
	$dtdURL
	URL where the DTD of the XML document can be located on the Web.
	$registered_ip = ""
	IP being registered.
	$dataset
	Dataset where to index the resource.
	$document = array()
	RDF document where resource(s) to be added are described. Maximum size (by default) is 8M (default php.ini setting).
	$mime = ""
	Mime of the RDF document serialization.
	$requester_ip = ""
	Requester's IP used for request validation.
	$errorMessenger
	Error messages of this web service.

OpenStructs

CrudUpdate Class Reference [Authentication / Registration Web Service]

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

CrudUpdate Class Reference
[Authentication / Registration Web Service]