Skip to end of metadata
Go to start of metadata

OpenBus Admin Console

busadmin is a console for the Lua language that provides functions that execute administation operations on a OpenBus instance.

Summary

  1. Configuration Options
  2. Authentication Operations
  3. Login Management
  4. Service Offer Management
  5. Authentication Certificate Management
  6. Entity Category Management
  7. Registered Entity Management
  8. Service Interface Management
  9. Governance Descriptor Factory
  10. Core Services Management and Configuration
  11. Entity Category
  12. Governance Descriptor
  13. Login Information
  14. Registered Entity
  15. Service Offer
  16. Service Offer Properties
  17. Value Sequence
  18. Value Set
  19. API Index

Configuration Options

The busadmin accepts the following command-line arguments to define configuration options. Additionally, the configuration options can be provided in a Lua file.

Usage:

busadmin [options] [script] [args]

Options:

Command-Line Argument Description
-busref <path|host:port> IOR file or address of the bus to connect.
-entity <name> authentication entity of the connection to the bus.
-privatekey <path> authentication key of the connection to the bus (login by certificate).
-password <text> authentication password of the connection to the bus (login by password).
-domain <name> authentication password domain.
  
-sslmode <mode> SSL support mode: supported or required.
-sslcapath <path> directory with CA certificates for SSL connection authentication.
-sslcafile <path> file with CA certificate for SSL connection authentication.
-sslcert <path> public key certificate for SSL connection authentication.
-sslkey <path> private key of the public key certificate provided.
  
-loglevel <number> bus access infrastruture log level (default is 0).
-logfile <path> bus access infrastruture log level (default is STDOUT).
-oilloglevel <number> ORB (OiL) log level (reserved).
-oillogfile <path> ORB (OiL) log file (reserved).
  
-i, -interactive enable interactive console mode.
-e, -execute <code> Lua snipet to be executed.
-l, -load <module> name of a Lua module to be loaded.
-v, -version shows the program version.
  
-configs <path> Lua file with configuration options to be loaded.
  
-h, -help shows a message describing the command-line options.

Authentication Operations

Functions to handle authentication in bus.

login(busref, entity [, secret [, domain]])
Parameters
busref =string Reference to the Bus
entity =string Authentication Name
secret =string Authentication Secret
domain =string Authentication Password Domain

login is a function that creates a new login in a bus with the identity of the entity provided. The created login is used in all following operations. If another login is in place at the moment this function if invoked, this current login becomes invalid if a new login is successfully created. If a new login cannot be created this operation fails raising an error and the current active login is left unchanged.

Parameter busref is a string that contains the address to a bus in the form host:port, or a path to a file with the IOR of the bus.

Parameter entity is a string that contains the name of the entity to be authenticated and associated to the login created.

Parameter secret is a string that contains a password or a path to a file with the the private key to be used in a authentication using a certificate. If this parameter is a password the parameter domain must be provided. When absent a message is printed asking for a password to be typed (from the standard input).

Parameter domain is a string that contains the name of the authentication domain for the password. When absent the value provided in secret is considered a path to private key file.

quit()

quit is a function that shuts down the bus access infrastructure and terminates the current thread in execution.

login = whoami()
Values Returned
login =logininfo|nil Current Authentication Info

whoami is a function that returns an object with the information about the current login.

Returned value login is either a Login Information that contains information about the current active login; or a nil that indicates there is no active connection to a bus at the moment.

Login Management

Functions to manage the login of systems connected to the bus.

done = kick(login)
Parameters
login =string|logininfo Login to be Invalidated
Values Returned
done =boolean Indication of Action

kick is a function that makes a login invalid. If the login provided is already invalid this method has no effect.

Parameter login is either a string that contains the ID of the login to be invalidated; or a Login Information that represents the login to be invalidated.

Returned value done is a boolean that is true when the login provided was active and was invalidated, or false otherwise.

logins = logins([entity])
Parameters
entity =string|logininfo Authentication Name
Values Returned
logins =list List of Logins

logins is a function that list all currently active logins or the active logins of an entity.

Parameter entity is either a string that contains the name of an entity which logins must be listed; or a Login Information that of the entity which logins must be listed. When absent this function returns all active logins, but this is only allowed when authenticated as an entity with adiministrative rights.

Returned value logins is a Value Sequence that contains a sequence of Login Information of all the logins currently active in the bus.

Service Offer Management

Functions to manage service offers.

done = deloffer(offer)
Parameters
offer =string|offer Offer to be Removed
Values Returned
done =boolean Indication of Action

deloffer is a function. (Removes a Service Offer)

Parameter offer is either a string that contains the ID of the offer to be removed; or a Service Offer that represents the offer to be removed.

Returned value done is a boolean that is true when the offer indicated was active and was removed, or false otherwise.

offers = offers([properties])
Parameters
properties =table Search Properties
Values Returned
offers =list Offers Found

offers is a function that returns all active offers that present a given set of properties.

Parameter properties is a table that contains a list of tables in the form {name="openbus.offer.entity",value="EntityName"} where field name indicates a property name and field value indicates the property value. Additionally, this table can contain the following fields that are translated to the indicated property.

FieldEquivalent
id=string{name="openbus.offer.id",value=string}
login=string{name="openbus.offer.login",value=string}
entity=string{name="openbus.offer.entity",value=string}
timestamp=string{name="openbus.offer.timestamp",value=string}
year=string{name="openbus.offer.year",value=string}
month=string{name="openbus.offer.month",value=string}
day=string{name="openbus.offer.day",value=string}
hour=string{name="openbus.offer.hour",value=string}
minute=string{name="openbus.offer.minute",value=string}
second=string{name="openbus.offer.second",value=string}
compname=string{name="openbus.component.name",value=string}
majorversion=string{name="openbus.component.version.major",value=string}
minorversion=string{name="openbus.component.version.minor",value=string}
patchversion=string{name="openbus.component.version.patch",value=string}
platform=string{name="openbus.component.platform",value=string}
When absent this function returns all active offers in the bus.

Returned value offers is a Value Sequence that contains a list Service Offer objects that represent the currently active service offers found.

Authentication Certificate Management

Functions to manage authentication certificate.

certificates = certents()
Values Returned
certificates =list Entities with Certificate

certents is a function that returns a list of names of all entities with an authentication certificate registered in the bus.

Returned value certificates is a Value Sequence that contains the names of all entities with a authentication certificate registered in the bus.

done = delcert(entity)
Parameters
entity =string Entity Name of the Certificate
Values Returned
done =boolean Indication of Action

delcert is a function. (Removes an Entity Certificate)

Parameter entity is a string that contains the name of the entity associated to the certificate to be removed.

Returned value done is a boolean that is true when the login certificate indicated was registered and was removed, or false otherwise.

certificate = getcert(entity)
Parameters
entity =string Entity Name of the Certificate
Values Returned
certificate =string|nil Authentication Certificate Found

getcert is a function that returns the authentication certificate associated with an entity name.

Parameter entity is a string that contains the name of the entity that owns the certificate to be returned.

Returned value certificate is either a string that contains the certificate found encoded in X.509 format; or a nil that indicates no certificate is associated with the entity was found.

done = setcert(entity, certificate)
Parameters
entity =string Entity Name of the Certificate
certificate =string Certificate File Path
Values Returned
done =boolean Indication of Action

setcert is a function that registers in the bus a public key certificate to be used for authentication as an entity name.

Parameter entity is a string that contains the name of the entity to be associated with the certificate.

Parameter certificate is a string that contains the path of a file containing a public key certificate in X.509 format to be registered.

Returned value done is a boolean that is true when the authentication certificate was successfully registered, or false otherwise.

Entity Category Management

Functions to manage entity categories.

categories = categories()
Values Returned
categories =list Entity Categories Registered

categories is a function that returns a list of objects representing all entity categories registered in the bus.

Returned value categories is a Value Sequence that contains Entity Category objects that represent all entity categories currently registered in the bus.

category = delcategory(category)
Parameters
category =string|category Entity Category to be Removed
Values Returned
category =category|nil Entity Category Removed

delcategory is a function that removes an entity category specified from the bus.

Parameter category is either a string that contains the ID of the entity category to be removed; or a Entity Category that represents the entity category to be removed.

Returned value category is either a Entity Category that represents the category removed; or a nil that indicates no entity category with the provided ID was found.

category = getcategory(category)
Parameters
category =string|category Entity Category Identification
Values Returned
category =category|nil Entity Category Found

getcategory is a function that returns an object representing an entity category specified.

Parameter category is either a string that contains the ID of the entity category to be returned; or a Entity Category that represents the entity category to be returned.

Returned value category is either a Entity Category that represents the entity category found; or a nil that indicates no entity category with the provided id was found.

category = setcategory(category, name)
Parameters
category =string|category Entity Category Identification
name =string Entity Category's Description
Values Returned
category =category Entity Category Modified

setcategory is a function that changes the textual description of an existing entity category or registers a new entity category with the information provided.

Parameter category is either a string that contains the ID of the entity category to be modified or registered; or a Entity Category that represents the entity category to be modified or registered.

Parameter name is a string that contains the textual description of the category to be modified or registered.

Returned value category is a Entity Category that represents the entity category modified or registered.

Registered Entity Management

Functions to manage registered entities.

entity = delentity(entity)
Parameters
entity =string|entity Registered Entity Identification
Values Returned
entity =entity|nil Unregistered Entity

delentity is a function that removes the registration for offer authorization of an entity from the bus.

Parameter entity is either a string that contains the name of the entity to be unregistered; or a Registered Entity that represents the entity to be unregistered.

Returned value entity is either a Registered Entity that represents the entity unregistered; or a nil that indicates no entity was found.

entities = entities(...)
Parameters
... = Authorized Service Interfaces
Values Returned
entities =list Registered Entities

entities is a function that returns a list of objects representing entities registered to be authorized to offer services in the bus.

Parameter ... are strings containing the CORBA's Repository Interface ID of service interfaces that the returned entities must be authorized to offer. When this parameter is string "*" all entities authorized to offer at least one interface are returned. If no service interface is provided (no parameters are provided) then all registered entities are returned.

Returned value entities is a Value Sequence that contains a list of Registered Entity objects representing all entities currently registered to be authorized to offer services in the bus.

entity = getentity(entity)
Parameters
entity =string|entity Registered Entity Identification
Values Returned
entity =entity|nil Registered Entity Found

getentity is a function that returns an object representing the registered entity specified.

Parameter entity is either a string that containing the name of the entity to be returned; or a Registered Entity that represents the entity to be returned.

Returned value entity is either a Registered Entity that represents the entity found; or a nil that indicates no entity with the provided name were found.

entity = setentity(entity, name)
Parameters
entity =string|entity Registered Entity Identification
name =string Entity Description
Values Returned
entity =entity Registered Entity Modified

setentity is a function that changes the textual description of a registered entity. If the entity name is not registered this function raises an error.

Parameter entity is either a string that contains the name of the entity to be modified; or a Registered Entity that represents the entity.

Parameter name is a string that contains the value to be defined as the new describing name of the entity.

Returned value entity is a Registered Entity that represents the registered entity modified.

Service Interface Management

Functions to manage service interface offered in the bus.

done = addiface(interface)
Parameters
interface =string Service Interface to be Registered
Values Returned
done =boolean Indication of Action

addiface is a function that registers in the bus a service interface so it can be authorized to be offered by systems connected to the bus.

Parameter interface is a string that contains the CORBA's Interface Repository ID of the service interface to be registered.

Returned value done is a boolean that is true when the interface was not previously registered and is now registered, or false otherwise.

done = deliface(interface)
Parameters
interface =string Service Interface to be Unregistered
Values Returned
done =boolean Indication of Action

deliface is a function that unregisters a service interface from the bus, so it cannot be authorized to be offered by systems connected to the bus.

Parameter interface is a string that contains the CORBA's Interface Repository ID of the service interface to be unregistered.

Returned value done is a boolean that is true when the interface was registered and is now unregistered, or false otherwise.

interfaces = ifaces()
Values Returned
interfaces =list Registered Interfaces

ifaces is a function that returns a list of CORBA Interface Repository IDs for every service interface registered in the bus.

Returned value interfaces is a Value Sequence that contains strings containing the CORBA's Interface Repository ID of each service interfaces registered in the bus.

Governance Descriptor Factory

Function to create governance descriptor objects.

descriptor = newdesc()
Values Returned
descriptor =descriptor Governance Descriptor

newdesc is a function that creates a new governance descriptor object that can be used to store governance definitions of a bus, like entity authentication certificates and service interface offer authorizations. The governance descriptions are LUA files. Normally they're generated by the governance descriptor object but in previous versions they were written manually. The syntax is as follows:

		-- Category definition
		-- * command: Category
		-- * parameters:
		--   * id = category identifier
		--   * name = category description
		Category {
		  id = "TEST_Category",
		  name = "Category description",
		}
		-- Entity definition
		-- * command: Entity
		-- * parameters:
		--   * id = entity identifier
		--   * category = Entity's category identifier
		--   * name = entity description
		Entity {
		  id = "TEST_Entity",
		  category = "TEST_Category",
		  name = "Entity description",
		}
		-- Certificate definition
		-- * command: Certificate
		-- * parameters:
		--   * id = entity identifier
		--   * certificate = path to the entity's certificate file
		Certificate {
		  id = "TEST_Entity",
		  certificate = "test.crt",
		}
		-- Interface definition
		-- * command: Interface
		-- * parameters:
		--   * id = interface's repID
		Interface {
		  id = "IDL:script/Test:1.0"
		}
		-- Grant authorization
		-- * command: Grant
		-- * parameters:
		--   * id = identifier of the entity to be authorized
		--   * interfaces = list of interfaces to be authorized
		Grant {
		  id = "TEST_Entity",
		  interfaces = {
		    "IDL:script/Test:1.0",
		  }
		}
		-- Revoke authorization
		-- * command: Revoke
		-- * parameters:
		--   * id = entity identifier
		--   * interfaces = list of interfaces to be de-authorized
		Revoke {
		  id = "TEST_Entity",
		  interfaces = {
		    "IDL:script/Test:1.0",
		  }
		}
		

Returned value descriptor is a Governance Descriptor that is the newly created governance descriptor object.

Core Services Management and Configuration

Functions to manage the core services, i.e: life-cycle, configuration, etc.

addpasswordvalidator(specification)
Parameters
specification =string Password validator specification

addpasswordvalidator is a function that loads a password validator to current password validation mechanism of a domain. If the validator is already loaded, this operation has no effect.

Parameter specification is a string that is separated by a colon (i.e. "domain:validatormodule") which the first substring specifies the validation domain and the second substring specifies the Lua Module to be loaded.

addtokenvalidator(specification)
Parameters
specification =string Token validator specification

addtokenvalidator is a function that loads a token validator to current token validation mechanism of a domain. If the validator is already loaded, this operation has no effect.

Parameter specification is a string that is separated by a colon (i.e. "domain:validatormodule") which the first substring specifies the validation domain and the second substring specifies the Lua Module to be loaded.

entities = admins()
Values Returned
entities =list Administrative entities

admins is a function that returns a list of entity names able to perform administrative operations.

Returned value entities is a Value Sequence that contains strings with the name of each entity granted to perform administrative operations.

[timeout] = callstimeout([timeout])
Parameters
timeout =number The timeout in seconds for Bus calls
Values Returned
timeout =number

callstimeout is a function that configures the timeout in seconds to wait for responses in calls performed by the bus.

Parameter timeout is a number that represents the timeout in seconds for calls performed by the bus. The value 0 means the bus should wait indefinitely for responses on its calls. When absent returns the current timeout for calls performed by the bus.

Returned value timeout is a number that represents the current timeout in seconds for calls performed by the bus. The value 0 means the bus waits indefinitely for responses on its calls. It is absent when some value was provided as parameter.

delpasswordvalidator(specification)
Parameters
specification =string Password validator specification

delpasswordvalidator is a function that unloads a password validator from current validation mechanism of a domain. If the validator is already unloaded, this operation has no effect.

Parameter specification is a string that is separated by a colon (i.e. "domain:validatormodule") which the first substring specifies the validation domain and the second substring specifies the Lua Module to be unloaded.

deltokenvalidator(specification)
Parameters
specification =string Token validator specification

deltokenvalidator is a function that unloads a token validator from current validation mechanism of a domain. If the validator is already unloaded, this operation has no effect.

Parameter specification is a string that is separated by a colon (i.e. "domain:validatormodule") which the first substring specifies the validation domain and the second substring specifies the Lua Module to be unloaded.

grantadmin(entities)
Parameters
entities =list List of entity names to be granted

grantadmin is a function that adds entities to the list of granted entities to perform administrative operations.

Parameter entities is a Value Sequence that contains strings with the name of each entity to be granted.

[level] = loglevel([level])
Parameters
level =number The log level of bus core services
Values Returned
level =number

loglevel is a function that configures the current log level of bus core services.

Parameter level is a number that updates the value of log level in bus core services. When absent returns the current log level.

Returned value level is a number that returns the current log level used in bus core services. It is absent when some value was provided as parameter.

[max] = maxcachesize([max])
Parameters
max =number The maximum size of all LRU caches
Values Returned
max =number

maxcachesize is a function that configures the current maximum size of LRU caches. There is three independent caches for OpenBus protocol related communications (i.e. IOR profile cache, session incoming cache, session outgoing cache) and they use the same maximum size.

Parameter max is a number that updates the value of maximum size of LRU caches. When absent returns the current value of maximum size of LRU caches.

Returned value max is a number that returns the current value of maximum size of LRU caches. It is absent when some value was provided as parameter.

[max] = maxchannels([max])
Parameters
max =number The maximum TCP channels used in OiL
Values Returned
max =number

maxchannels is a function that configures the current maximum channels limit configured in OiL or sets a new limit.

Parameter max is a number that updates the value of maximum TCP channels managed by OiL. When absent returns the current value of maximum TCP channels.

Returned value max is a number that returns the current value of maximum TCP channels managed by OiL. It is absent when some value was provided as parameter.

[level] = oilloglevel([level])
Parameters
level =number The OiL log level of bus core services
Values Returned
level =number

oilloglevel is a function that configures the current OiL log level of bus core services. Increase the OiL log level will generate a huge amount of log.

Parameter level is a number that updates the value of OiL log level in bus core services. When absent returns the current OiL log level.

Returned value level is a number that returns the current OiL log level used in bus core services. It is absent when some value was provided as parameter.

specifications = passwordvalidators()
Values Returned
specifications =list A list of password validator specifications

passwordvalidators is a function that retuns a list of password validator specifications currently being used.

Returned value specifications is a Value Sequence that contains a set of colon separated strings (i.e. "domain:validatormodule") which the first substring specifies the validation domain and the second substring specifies the Lua Module loaded.

reloadconf()

reloadconf is a function that reset all configurations to default values defined in the configuration file.

revokeadmin(entities)
Parameters
entities =list List of entity names to be revoked

revokeadmin is a function that removes entities from list of granted entities to perform administrative operations.

Parameter entities is a Value Sequence that contains strings with the name of each entity to be revoked.

shutdown()

shutdown is a function that calls the bus to shut down itself. This operation must be executed by OpenBus special entity otherwise a NO_PERMISSION exception will be raised.

specifications = tokenvalidators()
Values Returned
specifications =list A list of token validator specifications

tokenvalidators is a function that retuns a list of token validator specifications currently being used.

Returned value specifications is a Value Sequence that contains a set of colon separated strings (i.e. "domain:validatormodule") which the first substring specifies the validation domain and the second substring specifies the Lua Module loaded.

Entity Category

category is a table that represents a registered category of entities registered to be authorized to offer services in the bus.

entity = category:addentity(name, description)
Parameters
name =string Entity Name
description =string Entity's Description
Values Returned
entity =entity Entity to be Registered

addentity is a method that registers an entity in the category so it can be authorized to offer services in the bus.

Parameter name is a string that contains the name of the entity to be registered.

Parameter description is a string that contains the textual description of the entity to be registered.

Returned value entity is a Registered Entity that represents the entity to be registered.

string = category:__tostring()
Values Returned
string =string Textual Representation

__tostring is a method. (Returns Textual Representation)

Returned value string is a string. (Textual Representation)

entities = category:entities()
Values Returned
entities =list Registered Entities

entities is a method that returns the entities registered in the category.

Returned value entities is a Value Sequence that contains Registered Entity objects representing all entities currently registered in the category.

Governance Descriptor

descriptor is a table that contains a description of the governance definitions of a bus.

descriptor:download()

download is a method that imports to the descriptor the definitions from the bus currently connected. If there is an error while accessing the bus this operation raises the error.

descriptor:export(path, certpath [, mode])
Parameters
path =string File Path
certpath =string Certificate Directory Path
mode =string Export Mode

export is a method that exports every definition in the descriptor to a file using the format of Bus Governance Descriptor.

Parameter path is a string that contains the path of file where the definitions of the descriptor must be written.

Parameter certpath is a string that contains the path to a directory where the entity authentication certificates must be written. These authentication certificates are written in individual files using as file name the MD5 hash of the certificate in DER format.

Parameter mode is a string that can be one of the following values:

"legacy"
The file generated uses the legacy format, which is supported both by OpenBus 2.0 and 2.1.
"compact"
The file generated follows a more compact format where service interfaces are not declared individually and are only described when the interface is effectivelly authorized. This compact format is only supported by OpenBus 2.1.
When absent the format of the file generated is the new format that is only supported in OpenBus 2.1.

descriptor:import(path, ...)
Parameters
path =string File Path
... = File Arguments

import is a method that imports to the descriptor the definitions defined in a file. The file must contain a Lua code that creates definitions using the format of Bus Governance Descriptor.

Parameter path is a string that contains the path of file containig Lua code that creates the definitions to the loaded to the descriptor.

Parameter ... are values to be passed to the Lua code contained in the file.

descriptor.quiet

quiet is either a boolean; or a nil. indicates which action to take when there are conflicts while importing definitions from a file or a bus. The following list describe the possible values:

true
All conflicts and errors are resolved automatically priorizing the lastest definitions whenever possible.
false
All conflicts and errors are ignored maintaining the earliest definitions whenever possible.
nil
All conflicts and errors gererates a question that is printed in the standard output and waits for a anwser interactively from the standard input.

descriptor:revert()

revert is a method that removes from the bus currently connected every definition in the descriptor. If there is an error while accessing the bus this operation raises the error.

descriptor:upload()

upload is a method that exports every definition in the descriptor to the bus currently connected. If there is an error while accessing the bus this operation raises the error.

Login Information

logininfo is a table that contains information about a login in the bus.

string = logininfo:__tostring()
Values Returned
string =string Textual Representation

__tostring is a method. (Returns Textual Representation)

Returned value string is a string. (Textual Representation)

logininfo.entity

entity is a string. (Login's Entity Name)

logininfo.id

id is a string. (Login Identifier)

Registered Entity

entity is a table that represents an entity registered in the bus to be authorized to offer services.

string = entity:__tostring()
Values Returned
string =string Textual Representation

__tostring is a method. (Returns Textual Representation)

Returned value string is a string. (Textual Representation)

category = entity:category()
Values Returned
category =category Entity's Category

category is a method that returns the category in which the entity is registered.

Returned value category is a Entity Category that represents the entity's category.

done = entity:grant(interface)
Parameters
interface =string Service Interface to be Authorized
Values Returned
done =boolean Indication of Action

grant is a method that grants the entity the authorization to offer a service that implement the specified interface.

Parameter interface is a string that contains the CORBA's Interface Repository ID of the service interface to be authorized.

Returned value done is a boolean that is true when the interface was not authorized and now is, or false otherwise.

interfaces = entity:ifaces()
Values Returned
interfaces =list Authorized Interfaces

ifaces is a method that returns a list of CORBA Interface Repository IDs for every service interface that the entity is authorized to offer.

Returned value interfaces is a Value Sequence that contains of all CORBA's Interface Repository ID of the authorized service interfaces.

done = entity:revoke(interface)
Parameters
interface =string Service Interface to be Unauthorized
Values Returned
done =boolean Indication of Action

revoke is a method that revokes the authorization of the entity to offer a service with the specified interface.

Parameter interface is a string that contains the CORBA's Interface Repository ID of the service interface to be revoked.

Returned value done is a boolean that is true when the interface was authorized and now is unauthorized, or false otherwise.

Service Offer

offer is a table that represents a service offer registered in the bus.

string = offer:__tostring()
Values Returned
string =string Textual Representation

__tostring is a method. (Returns Textual Representation)

Returned value string is a string. (Textual Representation)

offer.compname

compname is a string. (Value of Property openbus.component.name)

offer.day

day is a string. (Value of Property openbus.offer.day)

offer.entity

entity is a string. (Value of Property openbus.offer.entity)

offer.facets

facets is a Value Set that contains all values of properties openbus.component.facet.

offer.hour

hour is a string. (Value of Property openbus.offer.hour)

offer.id

id is a string. (Value of Property openbus.offer.id)

offer.interfaces

interfaces is a Value Set that contains all values of properties openbus.component.interface.

offer.login

login is a string. (Value of Property openbus.offer.login)

offer.majorversion

majorversion is a string. (Value of Property openbus.component.version.major)

offer.minorversion

minorversion is a string. (Value of Property openbus.component.version.minor)

offer.minute

minute is a string. (Value of Property openbus.offer.minute)

offer.month

month is a string. (Value of Property openbus.offer.month)

offer.patchversion

patchversion is a string. (Value of Property openbus.component.version.patch)

offer.platform

platform is a string. (Value of Property openbus.component.platform)

offer.properties

properties is a Service Offer Properties. (Offer Properties)

offer.second

second is a string. (Value of Property openbus.offer.second)

offer.timestamp

timestamp is a string. (Value of Property openbus.offer.timestamp)

offer.year

year is a string. (Value of Property openbus.offer.year)

Service Offer Properties

offerprops is a table that contains a sequence of tables describing offer properties in the form {name="openbus.offer.entity",value="EntityName"} where field name indicates a property name and field value indicates the property value.

string = offerprops:__tostring()
Values Returned
string =string Textual Representation

__tostring is a method. (Returns Textual Representation)

Returned value string is a string. (Textual Representation)

Value Sequence

list is a table that contains a sequence of values using integer keys starting from 1.

string = list:__tostring()
Values Returned
string =string Textual Representation

__tostring is a method. (Returns Textual Representation)

Returned value string is a string. (Textual Representation)

Value Set

set is a table that contains values stored as keys, therefore it cannot contain duplicates and elements are stored without a particular order.

string = set:__tostring()
Values Returned
string =string Textual Representation

__tostring is a method. (Returns Textual Representation)

Returned value string is a string. (Textual Representation)

API Index

addiface Registers a Service Interface
addpasswordvalidator Loads a Password Validator
addtokenvalidator Loads a Token Validator
admins Lists the Names of Entities with Admin Privilegies
callstimeout Gets and Sets the Timeout for Bus Calls
categories Lists Entity Categories
category:__tostring Returns Textual Representation
category:addentity Registers Entity in the Category
category:entities Returns Entities in the Category
certents Lists Entities with Certificate
delcategory Unregisters an Entity Category
delcert Removes an Entity Certificate
delentity Unregisters Entity
deliface Unregisters a Service Interface
deloffer Removes a Service Offer
delpasswordvalidator Unloads a Password Validator
deltokenvalidator Unloads a Token Validator
descriptor.quiet Quiet Flag
descriptor:download Download from Bus
descriptor:export Export to File
descriptor:import Import from File
descriptor:revert Remove from Bus
descriptor:upload Upload to Bus
entities Lists Registered Entities
entity:__tostring Returns Textual Representation
entity:category Returns Entity's Category
entity:grant Authorizes Entity to Offer Interface
entity:ifaces Lists Authorized Interfaces
entity:revoke Unauthorizes Entity to Offer Interface
getcategory Gets an Entity Category
getcert Gets an Entity Certificate
getentity Gets a Registered Entity
grantadmin Grants Admin privilegies to Entities
ifaces Lists Registered Interfaces
kick Invalidates a Login
list:__tostring Returns Textual Representation
login Authenticates to the Bus
logininfo.entity Login's Entity Name
logininfo.id Login Identifier
logininfo:__tostring Returns Textual Representation
logins Lists Active Logins
loglevel Gets and Sets the Log Level of Bus Core Services
maxcachesize Gets and Sets the Limit of All LRU Caches
maxchannels Gets and Sets the Limit of TCP Channels Managed by OiL
newdesc Creates a Governance Descriptor
offer.compname Value of Property openbus.component.name
offer.day Value of Property openbus.offer.day
offer.entity Value of Property openbus.offer.entity
offer.facets Value of Properties openbus.component.facet
offer.hour Value of Property openbus.offer.hour
offer.id Value of Property openbus.offer.id
offer.interfaces Value of Properties openbus.component.interface
offer.login Value of Property openbus.offer.login
offer.majorversion Value of Property openbus.component.version.major
offer.minorversion Value of Property openbus.component.version.minor
offer.minute Value of Property openbus.offer.minute
offer.month Value of Property openbus.offer.month
offer.patchversion Value of Property openbus.component.version.patch
offer.platform Value of Property openbus.component.platform
offer.properties Offer Properties
offer.second Value of Property openbus.offer.second
offer.timestamp Value of Property openbus.offer.timestamp
offer.year Value of Property openbus.offer.year
offer:__tostring Returns Textual Representation
offerprops:__tostring Returns Textual Representation
offers Searches Service Offers
oilloglevel Gets and Sets the OiL Log Level OiL of Bus Core Services
passwordvalidators Lists the Current Password Validators Loaded
quit Terminates Execution
reloadconf Reloads the Configuration File
revokeadmin Revokes Admin Privilegies from Entities
set:__tostring Returns Textual Representation
setcategory Sets Entity Category's Description
setcert Registers an Entity Certificate
setentity Sets Registered Entity Description
shutdown Shuts Down the Core Services
tokenvalidators Lists the Current Token Validators Loaded
whoami Gets Authentication Info

Copyright (C) 2004-2014 Tecgraf, PUC-Rio

This project is currently being maintained by Tecgraf at PUC-Rio.
  • No labels