Overview

Namespaces

  • Authorization_Service
  • Logging_Service
  • Member_Authority
  • Overview
  • Project_Authority
  • Service_Registry
  • Slice_Authority

Classes

  • Service_Registry
  • Overview
  • Namespace
  • Class
  • Tree

Class Service_Registry

GENI Clearinghouse Service Registry (SR) controller interface

The Service Registry maintains a list of services registered with the clearinghouse, and their type, URL and certificate (signed by the SR itself).

Supports these modification interfaces:
  • success <= register_service(service_type, service_url, attributes)
  • success <= remove_service(service_id)


Supports these query interfaces (where 'service' represents the tuple [id service_type service_url service_cert service_cert_contents service_name service_description]):
  • [service]* <= get_services()
  • [service]* <= get_services_of_type(service_type)
  • [service]* <= get_service_by_id(service_id)
  • [service]* <= get_services_by_attributes(attribute_sets)
  • [attribute_name attribute_value]* <= get_attributes_for_service(service_id)
Namespace: Service_Registry
Located at sr_controller.php
Methods summary
public array
# get_services( dict $args_dict )

Get all services currently registered with SR

Get all services currently registered with SR

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" : name of this method ("get_services")

Returns

array
List of service info tuples (id, service_type, service_url, service_cert, service_cert_contents, service_name, service_description)
public array
# get_services_of_type( dict $args_dict )

Get all services of given type currently registered with SR

Get all services of given type currently registered with SR

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" : name of this method ("get_services_of_type")
  • "service_type" : Type of service requested

Returns

array
List of service info tuples (id, service_type, service_url, service_cert, service_cert_contents, service_name, service_description) of given type
public array
# get_service_by_id( dict $args_dict )

Get the service with the given id.

Get the service with the given id.

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" : name of this method ("get_service_by_id")
  • "service_id" : ID of given service

Returns

array
List of service info tuples (id, service_type, service_url, service_cert, service_cert_contents, service_name, service_description) of given ID
public array
# get_service_by_attributes( dict $args_dict )

Get the service that match one of a list of name/value attribute sets

Get the service that match one of a list of name/value attribute sets

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" : name of this method ("get_service_by_id")
  • "attribute_sets" : List of dictionaries of name/value pairs, the entries of one of which must all match a given service to be returned. ("OR" OF "ANDS")

Returns

array
List of service info tuples (id, service_type, service_url, service_cert, service_cert_contents, service_name, service_description) matching all of the requested attributes in one of the given sets of attributes
public integer
# register_service( dict $args_dict )

Register a new service with the Service Registry

Register a new service with the Service Registry

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" : name of this method ("register_service")
  • "service_type" : type of service (e.g. AM, PA, SA, etc.)
  • "service_name" : name of service
  • "service_url" : URL associated with service
  • "service_cert" : name of file containing service certificate
  • "service_description" : description of service
  • "attributes" : Dictionary of name/value pairs associated with service (for querying)

Returns

integer
ID of service registered or error code
public boolean
# remove_service( dict $args_dict )

Remove a given service from the Service Registry

Remove a given service from the Service Registry

Parameters

$args_dict
dict
$args_dict Dictionary containing name/value pairs:
  • "operation" : name of this method ("remove_service")
  • "service_id" : ID of service to be removed

Returns

boolean
Success/Failure
public number
# get_version( dict $args_dict )

Get the version of the API of this particular service provider

Get the version of the API of this particular service provider

Parameters

$args_dict
dict
$args_dict Dictionary containing 'operation' argument

Returns

number
Version of API of this particular service provider
API documentation generated by ApiGen 2.8.0