WIPE
Web services Interoperability Profile Environment
Jacek Radajewski
Revision: 410
2007-07-18 21:35:30 +1000 (Wed, 18 Jul 2007)

Table of Contents

1 DISCLAIMER
2 Introduction
  2.1 What is this?
  2.2 What is included?
  2.3 What is the project status?
3 Getting Started
  3.1 What do I need?
  3.2 Running it
    3.2.1 Checkout and compile software
    3.2.2 Checkout and render sample profiles
4 Components
  4.1 XML Schema
  4.2 Resolver
  4.3 Human Readable Form - HTML
  4.4 Human Readable Form - PDF
  4.5 Persistence Layer
  4.6 Conformance Testing

1 DISCLAIMER

This software is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; version 2.1 of the License.

This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

This document and associated software form a spike solution for the concept of cascading profiles for web services interoperability. Software is experimental and API unstable. Use at your own risk.

2 Introduction

2.1 What is this?

WIPE is an implementation of hierarchical web service profiles as described in this white paper .

2.2 What is included?

WIPE includes:

  1. The framework (or environment) software (see Section 4 for list of components)
  2. A set of sample profiles being developed for the Queensland Government Enterprise Architecture.

2.3 What is the project status?

Status of various components or modules is as follows:

See Section 4 for more details on the above listed components.

3 Getting Started

3.1 What do I need?

The following software packages and basic knowledge on how to use them is required to get the framework working.

  1. Java Development Kit 1.5 or higher
  2. Apache Ant 1.6.5 or higher
  3. Subversion client.

3.2 Running it

NOTE
Codebase is not stable and latest version in the repository may not work correctly. Stable snapshots will be released with version numbers.

3.2.1 Checkout and compile software

  1. Checkout the source code from subversion repository https://ws-profile-mgr.svn.sourceforge.net/svnroot/ws-profile-mgr/ws-profile-mgr/trunk/ using a subversion client.
  2. In the directory where you checkout the source, compile it by running ant jar

3.2.2 Checkout and render sample profiles

  1. Checkout the sample profiles from subversion repository https://ws-profile-mgr.svn.sourceforge.net/svnroot/ws-profile-mgr/gea-profiles/trunk/ using a subversion client.
  2. Edit wipe.properties and change the wipe.home properties so it points to where WIPE source code was checked out in Section 3.2.1
  3. In the directory where you checkout the source, compile it by running ant jar

4 Components

WIPE framework consists of the following components, some of which may not have been fully implemented. See Section 2.3 for implementation status of each of the components.

4.1 XML Schema

W3C XML Schema that defines the structure of a profile.

4.2 Resolver

Resolver is the part of the framework that 'flattens' the inheritance hierarchy and dereferences conformance targets and requirements defined in ancestor profiles.

4.3 Human Readable Form - HTML

Human readable representation of the profiles as a set of linked HTML documents.

4.4 Human Readable Form - PDF

Human readable representation of the profiles as a set of PDF documents.

4.5 Persistence Layer

Abstraction layer (together with sample implementation) of loading and saving profiles from XML registries or relational databases.

4.6 Conformance Testing

Conformance testing component allows for automated testing of service artefacts such as WSDL, SOAP messages or WMS capabilities against profiles to which the artefacts (or their service endpoint) subscribe.