AuthRegistrarAccess Class Reference

AuthRegister Access Web Service. It registers an Access on the structWSF instance. More...

Collaboration diagram for AuthRegistrarAccess:

List of all members.

Public Member Functions

__construct ($crud, $ws_uris, $dataset, $action, $target_access_uri, $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 ()

Register the Access to the WSF.

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 Member Functions

uriEncode ($uri)

Normalize the remaining of a URI.

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.

$crud

CRUD access being registered.

$ws_uris = array()

WS URIs being registered.

$dataset = ""

Dataset being registered.

$requester_ip = ""

Requester's IP used for request validation.

$target_access_uri = ""

URI of the access to update if action=update.

$action = ""

Type of action to perform: (1) create (2) delete_target (3) delete_all (4) update.

$errorMessenger

Error messages of this web service.

Detailed Description

AuthRegister Access Web Service. It registers an Access on the structWSF instance.

Register an Access (user access to a dataset, for a given set of web services, with some CRUD permissions) on the structWSF instance

Author:: Frederick Giasson, Structured Dynamics LLC.

Definition at line 27 of file AuthRegistrarAccess.php.

Constructor & Destructor Documentation

AuthRegistrarAccess::__construct	(	$	crud,
		$	ws_uris,
		$	dataset,
		$	action,
		$	target_access_uri,
		$	registered_ip,
		$	requester_ip
	)

Constructor.

Initialize the Auth Web Service

Parameters:

`[in]`	$crud	A quadruple with a value "True" or "False" defined as <Create;Read;Update;Delete>. Each value is separated by the ";" character. an example of such a quadruple is: "crud=True;True;False;False", meaning: Create = True, Read = True, Update = False and Delete = False
`[in]`	$ws_uris	A list of ";" separated Web services URI accessible by this access definition
`[in]`	$dataset	URI of the target dataset of this access description
`[in]`	$action	One of: (1)"create (default)": Create a new access description (2) "delete_target": Delete a target access description for a specific IP address and a specific dataset (3) "delete_all": Delete all access descriptions for a target dataset (4) "update": Update an existing access description
`[in]`	$target_access_uri	Target URI of the access resource to update. Only used when param4 = update
`[in]`	$registered_ip	Target IP address registered in the WSF
`[in]`	$requester_ip	IP address of the requester

Returns:: returns NULL

Author:: Frederick Giasson, Structured Dynamics LLC.

Definition at line 155 of file AuthRegistrarAccess.php.

References $action, $crud, $dataset, $registered_ip, $requester_ip, $target_access_uri, $ws_uris, and WebService::__construct().

Here is the call graph for this function:

AuthRegistrarAccess::__destruct ( )

Reimplemented from WebService.

Definition at line 201 of file AuthRegistrarAccess.php.

Referenced by ws_respond().

Member Function Documentation

AuthRegistrarAccess::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 298 of file AuthRegistrarAccess.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().

AuthRegistrarAccess::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 428 of file AuthRegistrarAccess.php.

References ws_conneg().

Here is the call graph for this function:

AuthRegistrarAccess::pipeline_getError ( )

Returns the error structure.

Returns:: returns the error structure

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 272 of file AuthRegistrarAccess.php.

AuthRegistrarAccess::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 441 of file AuthRegistrarAccess.php.

AuthRegistrarAccess::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 453 of file AuthRegistrarAccess.php.

AuthRegistrarAccess::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 467 of file AuthRegistrarAccess.php.

AuthRegistrarAccess::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 284 of file AuthRegistrarAccess.php.

AuthRegistrarAccess::pipeline_serialize ( )

Serialize the web service answer.

Returns:: returns the serialized content

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 479 of file AuthRegistrarAccess.php.

AuthRegistrarAccess::pipeline_serialize_reification ( )

Non implemented method (only defined).

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 489 of file AuthRegistrarAccess.php.

AuthRegistrarAccess::process ( )

Register the Access to the WSF.

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 540 of file AuthRegistrarAccess.php.

References $query, WebService::$uri, and validateQuery().

Here is the call graph for this function:

AuthRegistrarAccess::uriEncode ( $ uri ) [private]

Normalize the remaining of a URI.

Parameters:

[in] $uri The remaining of a URI to normalize

Returns:: a Normalized remaining URI

Author:: Frederick Giasson, Structured Dynamics LLC.

Definition at line 253 of file AuthRegistrarAccess.php.

References WebService::$uri.

AuthRegistrarAccess::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 221 of file AuthRegistrarAccess.php.

References $ws_av.

Referenced by process().

AuthRegistrarAccess::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 326 of file AuthRegistrarAccess.php.

References $supportedSerializations.

Referenced by pipeline_conneg().

AuthRegistrarAccess::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 515 of file AuthRegistrarAccess.php.

References __destruct().

Here is the call graph for this function:

AuthRegistrarAccess::ws_serialize ( )

Serialize the web service answer.

Returns:: returns the serialized content

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 501 of file AuthRegistrarAccess.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

AuthRegistrarAccess::$action = "" [private]

Type of action to perform: (1) create (2) delete_target (3) delete_all (4) update.

Definition at line 62 of file AuthRegistrarAccess.php.

Referenced by __construct().

AuthRegistrarAccess::$conneg [private]

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

Definition at line 33 of file AuthRegistrarAccess.php.

AuthRegistrarAccess::$crud [private]

CRUD access being registered.

Definition at line 47 of file AuthRegistrarAccess.php.

Referenced by __construct().

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

AuthRegistrarAccess::$dataset = "" [private]

Dataset being registered.

Definition at line 53 of file AuthRegistrarAccess.php.

Referenced by __construct().

AuthRegistrarAccess::$db [private]

Database connection.

Definition at line 30 of file AuthRegistrarAccess.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.

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

DTD URL of the web service.

Definition at line 52 of file WebService.php.

AuthRegistrarAccess::$dtdURL [private]

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

Definition at line 36 of file AuthRegistrarAccess.php.

WebService::$endpoint [protected, inherited]

The endpoint of the Authentication Registrar web service.

Definition at line 98 of file WebService.php.

AuthRegistrarAccess::$errorMessenger [private]

Error messages of this web service.

Definition at line 65 of file AuthRegistrarAccess.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.

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.

AuthRegistrarAccess::$registered_ip = "" [private]

IP being registered.

Definition at line 44 of file AuthRegistrarAccess.php.

Referenced by __construct().

AuthRegistrarAccess::$requester_ip = "" [private]

Requester's IP used for request validation.

Definition at line 56 of file AuthRegistrarAccess.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.

AuthRegistrarAccess::$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 39 of file AuthRegistrarAccess.php.

Referenced by ws_conneg().

AuthRegistrarAccess::$target_access_uri = "" [private]

URI of the access to update if action=update.

Definition at line 59 of file AuthRegistrarAccess.php.

Referenced by __construct().

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

AuthRegistrarAccess::$ws_uris = array() [private]

WS URIs being registered.

Definition at line 50 of file AuthRegistrarAccess.php.

Referenced by __construct().

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:

AuthRegistrarAccess.php


Public Member Functions
	__construct ($crud, $ws_uris, $dataset, $action, $target_access_uri, $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 ()
	Register the Access to the WSF.
	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 Member Functions
	uriEncode ($uri)
	Normalize the remaining of a URI.
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.
	$crud
	CRUD access being registered.
	$ws_uris = array()
	WS URIs being registered.
	$dataset = ""
	Dataset being registered.
	$requester_ip = ""
	Requester's IP used for request validation.
	$target_access_uri = ""
	URI of the access to update if action=update.
	$action = ""
	Type of action to perform: (1) create (2) delete_target (3) delete_all (4) update.
	$errorMessenger
	Error messages of this web service.

OpenStructs

AuthRegistrarAccess Class Reference

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation