GoldMineIntegration

Class GoldMineIntegrationWebService

java.lang.Object

GoldMineIntegration.GoldMineIntegrationWebService

public class GoldMineIntegrationWebService
extends Object

Class that provides a REST-based web service that integrates with GoldMine by passing XML strings. Addon now integrates with GoldMine and it uses this web service as one of its communications methods. The GoldMine servlet is a back-end class that handles low-level communications, and Addon takes care of all of the gory details so it's a seamless experience for the end user.

Field Summary

Fields

Modifier and Type	Field and Description
BBjString	AdminPassword$ The default admin password which is needed to publish the service.
BBjString	ServiceName$ The published name of the web service, which defaults to GMWS.

Constructor Summary

Constructors

Constructor and Description
GoldMineIntegrationWebService() Constructor.

Method Summary

Modifier and Type	Method and Description
void	registerService() Register the web service with the default name (GMWS) and publish it.
void	registerService(BBjString p_serviceName$) Register the web service with a specified name and publish it.
void	XML(BBjServletEvent p_event!) Handle web connections and execute a command via a provided XML string

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ServiceName$

public BBjString ServiceName$

The published name of the web service, which defaults to GMWS.

AdminPassword$

public BBjString AdminPassword$

The default admin password which is needed to publish the service.

Constructor Detail

GoldMineIntegrationWebService

public GoldMineIntegrationWebService()

Constructor. Basic construction is provided by the GoldMineIntegrationWebServiceFactory factory class

Method Detail

registerService

public void registerService()

Register the web service with the default name (GMWS) and publish it.

registerService

public void registerService(BBjString p_serviceName$)

Register the web service with a specified name and publish it. The suggested and default service name is GMWS, but it can be any valid string.

Parameters:

p_serviceName$ - The name of the published service. This will affect the URL used to access the service.

XML

public void XML(BBjServletEvent p_event!)

Handle web connections and execute a command via a provided XML string

Parameters:

p_event! - The servlet connection event