AuthLister Class Reference
[Authentication / Registration Web Service]

AuthLister Web Service. It lists registered web services and available dataset. More...

Collaboration diagram for AuthLister:

List of all members.

Public Member Functions

__construct ($mode, $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 ()

Aggregates information about the Accesses available to the requester.

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.

$requester_ip = ""

IP of the requester.

$registered_ip = ""

Requested IP (ex: a node wants to see all web services or datasets accessible for one of its user).

$dataset = ""

Target dataset URI if action = "access_dataset".

$mode = ""

Type of the thing to list.

$datasets = array()

List of datasets being listed.

$webservices = array()

List of webservices being listed.

$accesses = array()

List of accesses being listed.

$errorMessenger

Error messages of this web service.

Detailed Description

AuthLister Web Service. It lists registered web services and available dataset.

Author:: Frederick Giasson, Structured Dynamics LLC.

Definition at line 26 of file AuthLister.php.

Constructor & Destructor Documentation

AuthLister::__construct	(	$	mode,
		$	dataset,
		$	registered_ip,
		$	requester_ip
	)

Constructor.

Initialize the Auth Web Service

Parameters:

`[in]`	$mode	One of: (1) "dataset (default)": List all datasets URI accessible by a user, (2) "ws": List all Web services registered in a WSF (3) "access_dataset": List all the registered IP addresses and their CRUD permissions for a given dataset URI (4) "access_user": List all datasets URI and CRUD permissions accessible by a user
`[in]`	$dataset	URI referring to a target dataset. Needed when param1 = "dataset" or param1 = "access_datase". Otherwise this parameter as to be ommited.
`[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 130 of file AuthLister.php.

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

Here is the call graph for this function:

AuthLister::__destruct ( )

Reimplemented from WebService.

Definition at line 172 of file AuthLister.php.

Referenced by ws_respond().

Member Function Documentation

AuthLister::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 389 of file AuthLister.php.

Referenced by pipeline_getResultset().

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

AuthLister::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 466 of file AuthLister.php.

References ws_conneg().

Here is the call graph for this function:

AuthLister::pipeline_getError ( )

Returns the error structure.

Returns:: returns the error structure

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 228 of file AuthLister.php.

AuthLister::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 479 of file AuthLister.php.

AuthLister::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 491 of file AuthLister.php.

AuthLister::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 505 of file AuthLister.php.

AuthLister::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 240 of file AuthLister.php.

References $dataset, injectDoctype(), and WebService::xmlEncode().

Referenced by pipeline_serialize(), and ws_serialize().

Here is the call graph for this function:

AuthLister::pipeline_serialize ( )

Serialize the web service answer.

Returns:: returns the serialized content

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 517 of file AuthLister.php.

References $accesses, $webservices, WebService::jsonEncode(), and pipeline_getResultset().

Referenced by ws_serialize().

Here is the call graph for this function:

AuthLister::pipeline_serialize_reification ( )

Non implemented method (only defined).

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 788 of file AuthLister.php.

AuthLister::process ( )

Aggregates information about the Accesses available to the requester.

Returns:: NULL

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 915 of file AuthLister.php.

References $dataset, $query, and validateQuery().

Here is the call graph for this function:

AuthLister::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 192 of file AuthLister.php.

References $ws_av.

Referenced by process().

AuthLister::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 417 of file AuthLister.php.

References $dataset, and $supportedSerializations.

Referenced by pipeline_conneg().

AuthLister::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 888 of file AuthLister.php.

References __destruct().

Here is the call graph for this function:

AuthLister::ws_serialize ( )

Serialize the web service answer.

Returns:: returns the serialized content

Author:: Frederick Giasson, Structured Dynamics LLC.

Reimplemented from WebService.

Definition at line 800 of file AuthLister.php.

References pipeline_getResultset(), and pipeline_serialize().

Here is the call graph for this function:

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

AuthLister::$accesses = array() [private]

List of accesses being listed.

Definition at line 56 of file AuthLister.php.

Referenced by pipeline_serialize().

AuthLister::$conneg [private]

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

Definition at line 32 of file AuthLister.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().

AuthLister::$dataset = "" [private]

Target dataset URI if action = "access_dataset".

Definition at line 44 of file AuthLister.php.

Referenced by __construct(), pipeline_getResultset(), process(), and ws_conneg().

AuthLister::$datasets = array() [private]

List of datasets being listed.

Definition at line 50 of file AuthLister.php.

AuthLister::$db [private]

Database connection.

Definition at line 29 of file AuthLister.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.

AuthLister::$dtdURL [private]

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

Definition at line 35 of file AuthLister.php.

WebService::$endpoint [protected, inherited]

The endpoint of the Authentication Registrar web service.

Definition at line 98 of file WebService.php.

AuthLister::$errorMessenger [private]

Error messages of this web service.

Definition at line 59 of file AuthLister.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.

AuthLister::$mode = "" [private]

Type of the thing to list.

Definition at line 47 of file AuthLister.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.

AuthLister::$registered_ip = "" [private]

Requested IP (ex: a node wants to see all web services or datasets accessible for one of its user).

Definition at line 41 of file AuthLister.php.

Referenced by __construct().

AuthLister::$requester_ip = "" [private]

IP of the requester.

Definition at line 38 of file AuthLister.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.

AuthLister::$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 107 of file AuthLister.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(), CrudUpdate::process(), CrudCreate::process(), Browse::process(), AuthRegistrarAccess::process(), DatasetRead::uriEncode(), ConverterTsv::uriEncode(), ConverterIrJSON::uriEncode(), ConverterBibtex::uriEncode(), and AuthRegistrarAccess::uriEncode().

AuthLister::$webservices = array() [private]

List of webservices being listed.

Definition at line 53 of file AuthLister.php.

Referenced by pipeline_serialize().

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:

AuthLister.php


Public Member Functions
	__construct ($mode, $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 ()
	Aggregates information about the Accesses available to the requester.
	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.
	$requester_ip = ""
	IP of the requester.
	$registered_ip = ""
	Requested IP (ex: a node wants to see all web services or datasets accessible for one of its user).
	$dataset = ""
	Target dataset URI if action = "access_dataset".
	$mode = ""
	Type of the thing to list.
	$datasets = array()
	List of datasets being listed.
	$webservices = array()
	List of webservices being listed.
	$accesses = array()
	List of accesses being listed.
	$errorMessenger
	Error messages of this web service.

OpenStructs

AuthLister 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

AuthLister Class Reference
[Authentication / Registration Web Service]