Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Proxy vocabulary

Revision as of 16:29, 16 August 2011 by Ptrevithick.gmail.com (Talk | contribs) (UML Overview)

{{#eclipseproject:technology.higgins|eclipse_custom_style.css}}
Higgins logo 76Wx100H.jpg

A vocabulary to describe the Proxies. A Proxy is an (abstract) proxy for an object that is stored external to the local data store. Concrete subclasses of Proxy specify how this external object it accessed (e.g. by specifying location of the object, the used protocol to access it, and any authentication materials required). Each Proxy instance has a resource attribute that is a reference to a representation of the external object in a context in the local data store. Some Proxies may be represented as visual icons/metaphors in a UI. To support this it has optional background color, image and imageType attributes. Imported by Persona vocabulary.

Files

UML Overview

Proxy 2.0.104.png

Classes

App

A metaphor representing a nugget of application functionality in the PDS that can read from any of the user's contexts (including contexts pointed to by Card Proxies) and can read/write the h:Agent (likely a p:Person, to be more precise) entity to which its proxy:resource link points, as well as any other entities/attributes within the context containing this h:Agent. In some cases this h:Agent isn't really needed and doesn't hold any attributes; in these cases it is merely being used as a way to identify the surrounding read/write context.

  • subClassOf Proxy

Card

Abstract class. A metaphor representing an attribute data channel to/from an external site or API. The proxy:resource URI attribute of a card points to either (i) an h:Agent (typically a p:Person) or in the case of some Card subclasses, a web page that can be scraped to find the data for a p:Person (ii). In any event the authoritative description of this h:Agent lives outside of the local storage of the PDS

  • subClassOf Proxy
  • 1..1 externalResource

Known subclasses of Card: I-Card (See I-Card vocabulary), RoboCard, LinkedData, XRI2.0

LinkedData

A reference to an external representation (e.g. a person) stored as Linked Data in the Semantic Web (probably using FOAF). See (http://linkeddatabook.com/editions/1.0/). The value of its inherited externalResource attribute is a LinkedData URI (303 or Hash)

  • subClassOf Card

Proxy

A (abstract) proxy for an object that is stored external to the local data store. Concrete subclasses of Proxy specify how this external object it accessed (e.g. by specifying location of the object, the used protocol to access it, and any authentication materials required). Each Proxy instance has a resource attribute that is a reference to a representation of the external object in a context in the local data store. Some Proxies may be represented as visual icons/metaphors in a UI. To support this it has optional background color, image and imageType attributes

  • 1..1 skos:prefLabel - display name
  • 1..1 resource
  • 0..1 backgroundColor
  • 0..1 image
  • 0..1 imageType

RoboCard

A card that uses HTML screen scraping and form filling to read/write from/to an external website. The 'externalResource' is the URI of the homepage of this site. If login is required then userid and password are the values required to login.

  • 0..1 userid
  • 0..1 password
  • 0..1 neverRememberPassword

XRI2.0

A reference to an external representation (e.g. a person). The value of the inherited externalReference attribute is an XRI 2.0 URI. Dereferences to an XRDS discovery document.

  • subClassOf Card
  • 0..1 app-data:appData - provides a "template" for the AppData object within a dynamically created AppDataContext (see App-data vocabulary)
  • 1..1 authNMaterialsType
  • 1..1 contextType
  • 0..1 udiMetadata

UDIMetadata

A set of attribute/values that, taken together, are considered the "metadata" for the XRDS service endpoint.

Card Attributes

externalResource

URI of a higgins:Agent (likely a persona:Person) stored external to the PDS

  • domain: Link
  • value: h:Agent

RoboCard Attributes

userid

Username or email etc. used by external site to identify the user.

  • domain: RoboCard
  • value: xsd:string

password

Password used in conjunction with userid to login user.

  • domain: RoboCard
  • value: xsd:string

neverRememberPassword

If true then don't ever capture/remember the password that the user just typed in.

  • domain: RoboCard
  • value: xsd:boolean

Proxy Attributes

backgroundColor

Background image of a Card.

  • domain: Proxy
  • value: xsd:string

image

  • domain: Proxy
  • value: xsd:base64

imageType

  • domain: Proxy
  • one of ("JPG", "GIF", "PNG")

resource

Entity stored in local data store that is a local representation of the external object represented by this Proxy.

  • domain: Proxy
  • value: h:Agent

XRI 2.0 Attributes

authNMaterialsType

udiMetadata

UDIMetadata instance

  • domain: XRI2.0
  • value: UDIMetadata

Links

Back to the top