The Open Anzo Project

Semantic Application Middleware

The XML transport format is used for many of the interactions between the client and server.

Payload Element

This is the parent element for the message.

<Payload>CONTENTS OF MESSAGE</PayLoad

Node Element

Each unique node value in the message is given an ID, which is used throughout the message. The node elements contain the mapping of the IDs to their values.

  <Node id="" type="" dataType="" language="">Base64 value of Node</Node>
   id = ID of this node within this message
   type = Type of node (0=URI,1=BNODE,2=LIT,3=WILDCARD)
   dataType = If this is a typed literal, the URI of the datatype
   language = If this is a literal with a language tag, the language tag

Transaction Element

The transaction elements contain the contents of a transaction

 <Transaction id="" timestamp="">
  <Command*> (zero or more commands)
 </Transaction>
 id = ID of the transaction on the server
 timestamp = timestamp of when transaction was committed on the server

Command Element

The command element contains the contents of a command

 <Command id="" commandType="" commandPrecondition="">
  <Statement>*
  <User>*
  <UserInRole>*
  <Role>*
  <SubRole>*
  <NamedGraph>*
  <Acl>*
  <Aci>*
 </Command>
 id = ID of command within the transaction
 commandType = Type string given to this command
 commandPrecondition = Base64 encoded gzipped RDFXML representation of statements making up the precondition

Statement Element

The statement element contains an RDF statement

 <Statement method="" namedGraphUri="" subject="" predicate="" object=""/>
 method = Addition or Deletion
 namedGraphUri=ID of the NamedGraphUri for the statement
 subject = ID of the subject for the statement
 predicate = ID of the predicate for the statement
 object = ID of the object for the statement

User Element

 <User method="" id="" defaultRole="" defaultAclTemplate="" password="" userId="" />
 method = Addition or Deletion
 id = ID of the user's URI
 defaultRole = ID of the defaultRole for the user
 defaultAclTemplate = ID of the defaultAclTemplate for the user
 password = password for the user
 userid = login id for the user

UserInRole Element

 <UserInRole method="" id="" roleId=""/>
 method = Addition or Deletion
 id = ID of the user's URI
 roleID = ID of the role's URI

Role Element

 <Role method="" roleId=""/>
 method = Addition or Deletion
 roleID = ID of the role's URI

SubRole Element

 <SubRole method="" parentRole="" roleId=""/>
 method = Addition or Deletion
 roleID = ID of the role's URI
 parentRole = ID of the parent role's URI

NamedGraph Element

 <NamedGraph method="" namedGraphUri=""  metadataUri="" acl="" modified="" createdBy="" modifiedBy="" revision=""/>
 method = Addition or Deletion
 namedGraphUri = ID of the NamedGraph's URI
 metadataUri = ID of the NamedGraph's metadata graph's URI
 acl = ID of the ACL's URI
 modified = timestamp when the graph was last modified
 createdBy = ID of the user's URI that created the graph
 modifiedBy = ID of the user's URI that last modified the graph
 revision = The current revision number for the graph

Acl Element

 <Acl method="" acl="" isTemplate="" />
 method = Addition or Deletion
 acl=ID of the ACL's URI
 isTemplate = boolean value if this ACL is a template

Aci Element

 <Aci method="" namedGraphUri="" id="" roleId="" canRead="" canUpdate="" canDelete="" canInsert="" canRemove="" canChangeAcl=""/>
 method = Addition or Deletion
 namedGraphUri = ID of the NamedGraph's URI that this ACI affects
 id = ID of the ACL's URI
 roleId= ID of the Role's URI
 canRead = can read the namedGraph:1 for true, 0 for false
 canUpdate = can add data to the namedGraph:1 for true, 0 for false
 canDelete = can delete data from the namedGraph:1 for true, 0 for false
 canInsert = can insert a new namedGraph:1 for true, 0 for false
 canRemove = can remove a namedGraph:1 for true, 0 for false
 canChangeAcl=can change the ACLs for the namedGraph:1 for true, 0 for false

Error Element

 <AnzoException errorTags="" errorCode="">
  <ErrorMessageArg>Message</ErrorMessageArg>(zero or more)
 </AnzoException>
 errorTags=exception's error tags
 errorCode=exception's error code
Copyright © 2007 - 2008 OpenAnzo.org