org.globus.ogsa
Interface GridLocator

All Superinterfaces:

Referenceable, Serializable, javax.xml.rpc.Service

All Known Implementing Classes:

AdminServiceGridLocator, AnyServiceGridLocator, ArraySampleServiceGridLocator, ChatServiceGridLocator, CounterServiceGridLocator, EncodedCounterServiceGridLocator, ExceptionServiceGridLocator, FactoryServiceGroupServiceGridLocator, GenerateCounterServiceGridLocator, GoogleSearchServiceGridLocator, JMSAdapterServiceGridLocator, NotificationCounterServiceGridLocator, NotificationFactoryServiceGridLocator, OGSIAllServiceGridLocator, OgsiLoggingServiceGridLocator, OgsiManagementServiceGridLocator, OGSINotificationServiceGridLocator, OGSIServiceGridLocator, OGSIServiceGroupServiceGridLocator, PingServiceGridLocator, RoutableCounterServiceGridLocator, SecureContextEstablishmentServiceGridLocator, ServiceDataServiceGridLocator, ServiceGroupRegistrationServiceGridLocator, ServiceLocator, SinkListenerServiceGridLocator, TemperatureServiceGridLocator, TopServiceGridLocator, WeatherServiceGridLocator

public interface GridLocator

extends javax.xml.rpc.Service, Serializable, Referenceable

The GridLocator interface defines the base class of all type specific ServiceLocators used to create stubs on the client side. It is en extension of the JAX-RPC defined Locator.

Method Summary

GSR	getGSR() gets the GSR that was last resolved
Object	getServicePort(HandleType handle) creates a proxy for a particular handle (which is inspected and resolved into a GSR)
Object	getServicePort(LocatorType locator) creates a proxy using an OGSI LocatorType (the return parameter of an OGSI Factory createService call).
Object	getServicePort(URL url) creates a proxy for a particular endpoint URL
void	setEnableCacheGSR(boolean enableCacheGSR) determines whether all stubs created by this locator should be associated with the same reference.
void	setStubClass(Class stubClass) sets the stub class to be created, typically done by generated typed locators

Methods inherited from interface javax.xml.rpc.Service

createCall, createCall, createCall, createCall, getCalls, getHandlerRegistry, getPort, getPort, getPorts, getServiceName, getTypeMappingRegistry, getWSDLDocumentLocation

Methods inherited from interface javax.naming.Referenceable

getReference

Method Detail

setEnableCacheGSR

public void setEnableCacheGSR(boolean enableCacheGSR)

determines whether all stubs created by this locator should be associated with the same reference. It can be used to do lazy initialization of a proxy.

Parameters:

enableCacheGSR - if set to true (false is default) the locator will cache resolved GSRs

getGSR

public GSR getGSR()

gets the GSR that was last resolved

setStubClass

public void setStubClass(Class stubClass)

sets the stub class to be created, typically done by generated typed locators

getServicePort

public Object getServicePort(URL url)
                      throws GridServiceException

creates a proxy for a particular endpoint URL

Parameters:

url - endpoint URL that will be used to send messages invoked on the proxy created by this method

Returns:

JAX-RPC compliant client stub (only service interface is typically exposed)

Throws:

GridServiceException

getServicePort

public Object getServicePort(HandleType handle)
                      throws FaultType,
                             GridServiceException

creates a proxy for a particular handle (which is inspected and resolved into a GSR)

Parameters:

handle - the handle to resolve and create a stub for

Returns:

JAX-RPC compliant client stub (only service interface is typically exposed)

Throws:

FaultType - if a something went wrong during remote handle resolution

GridServiceException - if a local exception occurred internally in the framework

getServicePort

public Object getServicePort(LocatorType locator)
                      throws FaultType,
                             GridServiceException

creates a proxy using an OGSI LocatorType (the return parameter of an OGSI Factory createService call). If the locator does not contain a reference its handle will be resolved.

Parameters:

locator - the OGSI locator to (potentially) resolve and create a stub for

Returns:

JAX-RPC compliant client stub (only service interface is typically exposed)

Throws:

FaultType - if a something went wrong during remote handle resolution

GridServiceException - if a local exception occurred internally in the framework