WebService

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.genepattern.webservice
Interface WebService

public interface WebService

Defines methods that all Web Services must implement.

A Web Service is a program that runs within the OmniGene container. Clients can make RPC calls to Web Service methods by SOAP messages. A SOAP message will contain the method name to call and the parameters the method is expecting. Another SOAP message will be sent back to the client containing the result from the Web Service method.

To implement this interface you can write a generic Web Service by extending GenericWebService or one of the known subclasses.

This interface defines methods that get the version of the Web Service, the encoding scheme that you want data sent back as, and Web Service information,

Method Summary

java.lang.String getEncodingScheme()
          Returns the encoding scheme name of the web service.

float getEncodingSchemeVersion()
          Returns the encoding scheme version.

java.lang.String getWebServiceInfo()
          Returns information about the web service such as description, version, and author.

java.lang.String getWebServiceName()
          Returns the name of the web service.

java.lang.String ping()
          Pings the webservice.

void setEncodingScheme(java.lang.String scheme)
          Sets the encoding scheme of the web service.

void setEncodingSchemeVersion(float version)
          Sets the encoding scheme version.

Method Detail

getWebServiceName

public java.lang.String getWebServiceName()

Returns the name of the web service.

Returns:: a String object containing the name of the web service.

getWebServiceInfo

public java.lang.String getWebServiceInfo()

Returns information about the web service such as description, version, and author.

The string that this method returns should be plain text and not markup like XML.

Returns:: a String containing web service information

setEncodingScheme

public void setEncodingScheme(java.lang.String scheme)

Sets the encoding scheme of the web service. The encoding scheme is the XML format that the data will be returned as (i.e. AGAVE, BSML).

Parameters:: scheme - a String object containing the encoding scheme name

getEncodingScheme

public java.lang.String getEncodingScheme()

Returns the encoding scheme name of the web service.

Returns:: a String object containing the encoding scheme name

setEncodingSchemeVersion

public void setEncodingSchemeVersion(float version)

Sets the encoding scheme version.

Parameters:: version - a float containing the encoding scheme version

getEncodingSchemeVersion

public float getEncodingSchemeVersion()

Returns the encoding scheme version.

Returns:: the version of the encoding scheme

ping

public java.lang.String ping()

Pings the webservice.

Returns:: a String object containing "OK" if the service is available.