org.apache.juddi.v3.client.config

Class UDDIClient

java.lang.Object

org.apache.juddi.v3.client.config.UDDIClient

public class UDDIClient
extends Object

The UDDIClient is the main entry point for using the jUDDI client. The UDDICLient provides a simple way to get interact with a UDDI registry using the UDDI v3 API.

Note:

It is also possible to use the Java API for XML Registries (JAXR). Apache Scout is an implementation of this API that can be configured to -behind the scenes- use the jUDDI Client code to access either UDDIv2 or UDDIv3 registry. The advantage of using JAXR is that your code can be configured to interact with any XML Registry (such as UDDI or ebXML). The downside is that JAXR has not evolved beyond the 1.0 release and is tightly coupled to the ebXML data structures, which being mapped to the UDDI data structures. For more information on JAXR see the Apache Scout project, which is a sub project of Apache jUDDI. If programmatic acess to a UDDIv3 registry is what you want, we recommend using the UDDIv3 API with the UDDIClient.

The UDDIClient uses a XML formatted configuration file, which by default is loaded from the classpath from location META-INF/uddi.xml.

Author:

kstam

Constructor Summary

Constructors

Constructor and Description
UDDIClient() Default constructor, loads from the default config, META-INF/uddi.xml
UDDIClient(String configurationFile) Manages the clerks.
UDDIClient(String configurationFile, Properties properties) Manages the clerks.

Method Summary

Modifier and Type	Method and Description
static BindingTemplate	addRESTtModels(BindingTemplate bt) adds the typical REST tmodel references, but only if they aren't already present
static BindingTemplate	addSOAPtModels(BindingTemplate bt) adds the typical SOAP tmodel references, but only if they aren't already present
static void	clearServiceLocatorCaches()
UDDIClerk	getClerk(String clerkName) Gets the UDDI Clerk, the entry point into many functions of the juddi client
String	getClientCallbackUrl() Deprecated. use SubscriptionCallbackListener
ClientConfig	getClientConfig() Returns a live instance of the raw configuration file
String	getName() returns getClientConfig().getClientName()
ServiceLocator	getServiceLocator() Uses the client config, and looks for a clerk called "default"
ServiceLocator	getServiceLocator(String clerkName)
Transport	getTransport() Deprecated. use the getTransport(String nodeName) instead. Returns the "default" jUDDI nodes Transport. Note: this will always return a new instance of Transport
Transport	getTransport(String nodeName) Returns the transport defined for the node with the given nodeName.
void	registerAnnotatedServices() Registers services to UDDI using a clerk, and the uddi.xml configuration.
void	registerWSDLs() Registers services to UDDI using a clerk, and the uddi.xml configuration.
void	restart() calls stop and start again
void	saveClerkAndNodeInfo() Saves the clerk and node info from the uddi.xml to the home jUDDI registry.
void	start() Initializes the UDDI Clerk.
protected void	startEmbeddedServer()
void	stop() Stops the clerks.
protected void	stopEmbeddedServer()
void	unRegisterAnnotatedServices() Removes the service and all of its bindingTemplates of the annotated classes.
void	unRegisterBindingsOfAnnotatedServices(boolean removeServiceWithNoBindingTemplates) Removes the bindings of the services in the annotated classes.
void	unRegisterWSDLs() unregisters all config defined wsdls
void	xRegister() X-Register services listed in the uddi.xml

Methods inherited from class java.lang.Object

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

Constructor Detail

UDDIClient

public UDDIClient()
           throws org.apache.commons.configuration.ConfigurationException

Default constructor, loads from the default config, META-INF/uddi.xml

Throws:

org.apache.commons.configuration.ConfigurationException

UDDIClient

public UDDIClient(String configurationFile)
           throws org.apache.commons.configuration.ConfigurationException

Manages the clerks. Initiates reading the client configuration from the uddi.xml.

Throws:

org.apache.commons.configuration.ConfigurationException

UDDIClient

public UDDIClient(String configurationFile,
                  Properties properties)
           throws org.apache.commons.configuration.ConfigurationException

Manages the clerks. Initiates reading the client configuration from the uddi.xml.

Parameters:

configurationFile -

properties -

Throws:

org.apache.commons.configuration.ConfigurationException

Method Detail

clearServiceLocatorCaches

public static void clearServiceLocatorCaches()

getServiceLocator

public ServiceLocator getServiceLocator()
                                 throws org.apache.commons.configuration.ConfigurationException

Uses the client config, and looks for a clerk called "default"

Returns:

returns getServiceLocator(null);

Throws:

org.apache.commons.configuration.ConfigurationException

getServiceLocator

public ServiceLocator getServiceLocator(String clerkName)
                                 throws org.apache.commons.configuration.ConfigurationException

Parameters:

clerkName - - if null defaults to "default"

Returns:

a serviceLocator object

Throws:

org.apache.commons.configuration.ConfigurationException

stop

public void stop()
          throws org.apache.commons.configuration.ConfigurationException

Stops the clerks. If transport is InVM, all database resources are released. If anything was auto registered, it will be removed prior to shutdown

Throws:

org.apache.commons.configuration.ConfigurationException

start

public void start()
           throws org.apache.commons.configuration.ConfigurationException

Initializes the UDDI Clerk. If transport is set to InVM, this will initialize all database connections, other it will trigger all background registration threads

Throws:

org.apache.commons.configuration.ConfigurationException

startEmbeddedServer

protected void startEmbeddedServer()
                            throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

stopEmbeddedServer

protected void stopEmbeddedServer()
                           throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

restart

public void restart()
             throws org.apache.commons.configuration.ConfigurationException

calls stop and start again

Throws:

org.apache.commons.configuration.ConfigurationException

saveClerkAndNodeInfo

public void saveClerkAndNodeInfo()

Saves the clerk and node info from the uddi.xml to the home jUDDI registry. This info is needed if you want to JUDDI Server to do XRegistration/"replication".

xRegister

public void xRegister()

X-Register services listed in the uddi.xml

registerAnnotatedServices

public void registerAnnotatedServices()

Registers services to UDDI using a clerk, and the uddi.xml configuration.

unRegisterAnnotatedServices

public void unRegisterAnnotatedServices()

Removes the service and all of its bindingTemplates of the annotated classes.

unRegisterBindingsOfAnnotatedServices

public void unRegisterBindingsOfAnnotatedServices(boolean removeServiceWithNoBindingTemplates)

Removes the bindings of the services in the annotated classes. Multiple nodes may register the same service using different BindingTempates. If the last BindingTemplate is removed the service can be removed as well.

Parameters:

removeServiceWithNoBindingTemplates - - if set to true it will remove the service if there are no other BindingTemplates.

getClientConfig

public ClientConfig getClientConfig()

Returns a live instance of the raw configuration file

Returns:

the client config loaded from file

getName

public String getName()

returns getClientConfig().getClientName()

Returns:

getClientConfig().getClientName()

getClientCallbackUrl

@Deprecated
public String getClientCallbackUrl()

Deprecated. use SubscriptionCallbackListener

maps to config file client[@callbackUrl] Not currently used

Returns:

client[@callbackUrl]

See Also:

SubscriptionCallbackListener

getTransport

public Transport getTransport()
                       throws org.apache.commons.configuration.ConfigurationException

Deprecated. use the getTransport(String nodeName) instead. Returns the "default" jUDDI nodes Transport. Note: this will always return a new instance of Transport

Returns the transport defined for the node with the given name "default". deprecated, use the getTransport(String nodeName) instead. Returns the "default" jUDDI nodes Transport.

Returns:

a transport object

Throws:

org.apache.commons.configuration.ConfigurationException

getTransport

public Transport getTransport(String nodeName)
                       throws org.apache.commons.configuration.ConfigurationException

Returns the transport defined for the node with the given nodeName. Note: this will always return a new instance of Transport

Parameters:

nodeName -

Returns:

a transport object

Throws:

org.apache.commons.configuration.ConfigurationException

getClerk

public UDDIClerk getClerk(String clerkName)

Gets the UDDI Clerk, the entry point into many functions of the juddi client

Parameters:

clerkName - - This references the uddi/client/clerk@name of the juddi client config file. it stores credentials if necessary and associates it with a particular UDDI node (server/cluster) If not specified, the value of "default" will be used.

Returns:

A clerk instance if the clerk is defined in the config file or NULL if not found

registerWSDLs

public void registerWSDLs()

Registers services to UDDI using a clerk, and the uddi.xml configuration.

unRegisterWSDLs

public void unRegisterWSDLs()

unregisters all config defined wsdls

addSOAPtModels

public static BindingTemplate addSOAPtModels(BindingTemplate bt)

adds the typical SOAP tmodel references, but only if they aren't already present

Parameters:

bt -

Returns:

a modified instance of the source binding template

addRESTtModels

public static BindingTemplate addRESTtModels(BindingTemplate bt)

adds the typical REST tmodel references, but only if they aren't already present

Parameters:

bt -

Returns:

a modified instance of the source binding template