org.optimizationservices.oscommon.communicationagent
Class OSRegistryAgent

java.lang.Object
  extended by org.optimizationservices.oscommon.communicationagent.OSRegistryAgent
All Implemented Interfaces:
OSdL

public class OSRegistryAgent
extends java.lang.Object
implements OSdL

The OSRegistryAgent class implements all the OSdL interface. Thus it is OS-type registry. It implements all the methods as specified in the Optimization Services (OS) Framework, specifically the Optimization Services discover Language (OSdL).

The OSRegistryAgent class is a library class that contains methods to help registry agents communicate with Optimization Services (OS) registries as specified by the Optimization Services framework. It hides all the SOAP protocol related technical details from an optimization user.

Since:
OS 1.0
Version:
1.0, 03/14/2004
Author:
Robert Fourer, Jun Ma, Kipp Martin
See Also:
OSdL

Field Summary
 java.lang.String registryAddress
          registryAddress holds the address (uri/url) of the Optimization Services (OS) registry.
 
Constructor Summary
OSRegistryAgent()
          Constructor.
OSRegistryAgent(java.lang.String registryAddress)
          Constructor.
 
Method Summary
 java.lang.String find(java.lang.String osql, java.lang.String osol)
          Discover an Optimization Service whose instance is given by a string following the Optimization Services query Language (OSqL) schema and returns the location information in a string that follows the Optimization Services URI, or Universal Resource Indentifier Language, (OSuL) schema.
 java.lang.String knock(java.lang.String osplInput, java.lang.String osol)
          This method is called by one optimization service on another optimization service to provide runtime dynamic process information (push mechanism).
static void main(java.lang.String[] args)
          main for test purposes.
 java.lang.String register(java.lang.String osel, java.lang.String osol)
          register an Optimization Service whose instance is given by a string following the Optimization Services entity Language (OSeL) schema and returns a string that contains an XSLT style sheet transformation so that it can be used for standard web pubblication of the Optimization Service that just joined.
 java.lang.String validate(java.lang.String osxl, java.lang.String osol)
          Validate an osxl string according to the corresponding OSxL schema.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

registryAddress

public java.lang.String registryAddress
registryAddress holds the address (uri/url) of the Optimization Services (OS) registry.

Constructor Detail

OSRegistryAgent

public OSRegistryAgent()
Constructor.


OSRegistryAgent

public OSRegistryAgent(java.lang.String registryAddress)
Constructor.

Parameters:
registryAddress - holds the address (uri/url) of the Optimization Services (OS) registry.
Method Detail

find

public java.lang.String find(java.lang.String osql,
                             java.lang.String osol)
Discover an Optimization Service whose instance is given by a string following the Optimization Services query Language (OSqL) schema and returns the location information in a string that follows the Optimization Services URI, or Universal Resource Indentifier Language, (OSuL) schema.

Specified by:
find in interface OSdL
Parameters:
OSqL - holds the Optimization Service query in a string which format follows the Optimization Services query Language (OSqL) schema.
osol - holds the optimization option in a string which format follows the Optimization Services option Language (OSoL) schema.
Returns:
the location information in a string that follows the Optimization Services URI, or Universal Resource Indentifier Language, (OSuL) schema.

register

public java.lang.String register(java.lang.String osel,
                                 java.lang.String osol)
register an Optimization Service whose instance is given by a string following the Optimization Services entity Language (OSeL) schema and returns a string that contains an XSLT style sheet transformation so that it can be used for standard web pubblication of the Optimization Service that just joined. The XSLT is espcially used to publish the OSeL.

Specified by:
register in interface OSdL
Parameters:
osel - holds the Optimization Service entity description in a string which format follows the Optimization Services entity Language (OSeL) schema.
osol - holds the optimization option in a string which format follows the Optimization Services option Language (OSoL) schema.
Returns:
the register process output information in a string which format follows the OSpL schema.

validate

public java.lang.String validate(java.lang.String osxl,
                                 java.lang.String osol)
Validate an osxl string according to the corresponding OSxL schema.

Specified by:
validate in interface OSdL
Parameters:
osxl - holds the xml string to be validated.
osol - holds the optimization option in a string which format follows the Optimization Services option Language (OSoL) schema.
Returns:
the validate process output information in a string which format follows the OSpL schema.

knock

public java.lang.String knock(java.lang.String osplInput,
                              java.lang.String osol)
This method is called by one optimization service on another optimization service to provide runtime dynamic process information (push mechanism).

Specified by:
knock in interface OSdL
Parameters:
osplInput - holds the input process information a string which format follows the Optimization Services process Language (OSpL) schema.
osol - holds the optimization option in a string which format follows the Optimization Services option Language (OSoL) schema.
Returns:
osplOutput, the ouput process information in a string which format follows the OSpL schema.

main

public static void main(java.lang.String[] args)
main for test purposes.

Parameters:
argv - command line arguments.