PING Client

From HiWiki

Jump to: navigation, search

PING Discovery: Pilot implementasjon og utforskning av PING -> Implementation -> PING Client

In this section we will explain the PING Client. Originally the client for PING was a Java based client. However, using a Java client will demand more out of the user with installation of software. This is the reason for the start of an implementation of a PHP based web client. The PHP client is due summer 2006, so the Java client will be used now.

Java client

The PING Java client is located in the package org.chip.ping.client and consists of the two classes PingTalkClient and PingActionClient. PingTalkClient provide functionality to communicate with a single PING server using the PING Talk protocol. PingActionClient extends PingTalkClient and provides methods for each of the default PING Talk actions. Any client implementation should therefore extend PingActionClient.

The following methods are provided:

  • authenticate()
  • readRecord()
  • createRecord()
  • readDocument()
  • readDocumentFilter()
  • readDocumentHeaders()
  • addDocument()
  • updateDocument()
  • sendMessage()
  • query()

All these methods utilize corresponding classes in the PING Talk protocol as explained in How the client handles requests and responses.

PHP client

The PHP client is not yet operational.