org.apache.juddi.v3.client.mapping

Class ServiceLocator

java.lang.Object

org.apache.juddi.v3.client.mapping.ServiceLocator

public class ServiceLocator
extends Object

The ServiceLocator contacts the UDDI registry to lookup an Endpoint given a UDDI ServiceKey.
This class does NOT chase down WSDL, hosting redirectors or other binding references from access point useType values. See UDDIClerk.getEndpoints

Author:

Kurt T Stam

See Also:

SubscriptionCallbackListener

Constructor Summary

Constructors

Constructor and Description
ServiceLocator(UDDIClerk clerk) Requirement in the config is a clerk with access credentials to the UDDI server you want the locator to do lookups to.
ServiceLocator(UDDIClerk clerk, URLLocalizer urlLocalizer, Properties properties)

Method Summary

Modifier and Type	Method and Description
void	clearCaches()
SelectionPolicy	getPolicy() Returns the selection policy in use by this instance of the ServiceLocator.
UDDIServiceCache	getUDDIServiceCache()
String	lookupEndpoint(QName serviceQName, String portName) Looks up the Endpoints for a Service.
String	lookupEndpoint(String serviceKey) Looks up the Endpoints for a Service.
ServiceLocator	setPolicy(String policy) The policy selection can be set as property "juddi.client.selection.policy" or it can be set programmatically using this method.
void	shutdown()
ServiceLocator	withCache(URL baseCallbackURL) Creates a new UDDIServiceCache, which brings up a new WebService Endpoint.
ServiceLocator	withLiveCache(URL baseCallbackURL) A live cache will receive callbacks from the UDDI server in case there is an update to a service's bindings.
ServiceLocator	withSimpleCache()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceLocator

public ServiceLocator(UDDIClerk clerk)

Requirement in the config is a clerk with access credentials to the UDDI server you want the locator to do lookups to. When a live cache is used the clerk will register a callback into this UDDI server and the clerk will therefore need inquiry and publish access. The credentials can be set in the uddi-client.xml configuration file.

Parameters:

clerk - a UDDI Clerk with publish access to the UDDI Server.

Throws:

org.apache.commons.configuration.ConfigurationException

ServiceLocator

public ServiceLocator(UDDIClerk clerk,
                      URLLocalizer urlLocalizer,
                      Properties properties)
               throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

Method Detail

withCache

public ServiceLocator withCache(URL baseCallbackURL)
                         throws org.apache.commons.configuration.ConfigurationException

Creates a new UDDIServiceCache, which brings up a new WebService Endpoint. This EndPoint will be called by the UDDI server if any service changes. A callback will result in cleaning the cache.

Parameters:

baseCallbackURL -

Throws:

org.apache.commons.configuration.ConfigurationException

withLiveCache

public ServiceLocator withLiveCache(URL baseCallbackURL)
                             throws org.apache.commons.configuration.ConfigurationException,
                                    BindException

A live cache will receive callbacks from the UDDI server in case there is an update to a service's bindings. All callbacks will clear the UDDIClientCache ensuring that subsequent lookups will contact the UDDI server for the latest binding information. The baseCallbackURL can be set to solve binding issue. If

Parameters:

baseCallbackURL -

Returns:

a service locator object

Throws:

org.apache.commons.configuration.ConfigurationException

BindException

withSimpleCache

public ServiceLocator withSimpleCache()

getUDDIServiceCache

public UDDIServiceCache getUDDIServiceCache()

setPolicy

public ServiceLocator setPolicy(String policy)

The policy selection can be set as property "juddi.client.selection.policy" or it can be set programmatically using this method. A Policy is a class which implements the SelectionPolicy interface. Known implementations are org.apache.juddi.v3.client.mapping.PolicyLocalFirst and org.apache.juddi.v3.client.mapping.PolicyRoundRobin. If the policy is not set the default org.apache.juddi.v3.client.mapping.PolicyLocalFirst is used.

Parameters:

policy - - the desired policy.

Returns:

ServiceLocator

See Also:

PolicyLocalFirst, PolicyRoundRobin

getPolicy

public SelectionPolicy getPolicy()
                          throws org.apache.commons.configuration.ConfigurationException

Returns the selection policy in use by this instance of the ServiceLocator.

Returns:

SelectionPolicy - the selection policy.

Throws:

org.apache.commons.configuration.ConfigurationException

clearCaches

public void clearCaches()

shutdown

public void shutdown()
              throws RemoteException,
                     org.apache.commons.configuration.ConfigurationException,
                     TransportException

Throws:

RemoteException

org.apache.commons.configuration.ConfigurationException

TransportException

lookupEndpoint

public String lookupEndpoint(String serviceKey)
                      throws RemoteException,
                             org.apache.commons.configuration.ConfigurationException,
                             TransportException

Looks up the Endpoints for a Service. If the cache is in use it will try to obtain them from the cache. If no Endpoints are found, or if the cache is not in use, the clerk will do a lookup for this service. After Endpoints are found it will use a policy to pick one Endpoint to return. Returns null if no endpoints are found.

Parameters:

serviceKey -

Returns:

endpoint

Throws:

RemoteException

org.apache.commons.configuration.ConfigurationException

TransportException

lookupEndpoint

public String lookupEndpoint(QName serviceQName,
                             String portName)
                      throws RemoteException,
                             org.apache.commons.configuration.ConfigurationException,
                             TransportException

Looks up the Endpoints for a Service. If the cache is in use it will try to obtain them from the cache. If no Endpoints are found, or if the cache is not in use, the clerk will do a lookup for this service. After Endpoints are found it will use a policy to pick one Endpoint to return. Returns null if no endpoints are found.

Parameters:

serviceQName -

portName -

Returns:

Returns null if no endpoints are found.

Throws:

TransportException

org.apache.commons.configuration.ConfigurationException

RemoteException