com.esri.adf.web.ags.data
Class AGSGeocodeResource

java.lang.Object
  com.esri.adf.web.data.GISResource
      com.esri.adf.web.ags.data.AGSGeocodeResource

All Implemented Interfaces:

WebContextInitialize, WebLifecycle, Serializable

Direct Known Subclasses:

AGSLocalGeocodeResource

public class AGSGeocodeResource
extends GISResource

See Also:

Serialized Form

Field Summary

protected String	endPointURL
protected String	generatedAlias If the user does not provide an alias for the resource, an alias is generated by this object and is represented by this variable
protected com.esri.arcgisws.GeocodeServerBindingStub	geocodeServer
protected String	mapName
protected String	serviceCatalogURL The URL to a web service catalog end point.
protected AGSUser	user An AGSUser object to authenticate connections to secure web services

Fields inherited from class com.esri.adf.web.data.GISResource

alias, context, defaultSpatialReference, functionalities, hasFailedFunctionalities, init

Constructor Summary

AGSGeocodeResource()
Creates a new AGSGeocodeResource with no URL set.

AGSGeocodeResource(String endPointURL)

Method Summary

protected void	createGeocodeServer()
String	getAlias() Returns a reader friendly name for this resource.
String	getEndPointURL()
com.esri.arcgisws.GeocodeServerPort	getGeocodeServer()
String	getServiceCatalogURL() Returns the service catalog end point URL.
AGSUser	getUser()
void	init(WebContext webContext) This method is called by the WebContext to initialize the resource.
void	setEndPointURL(String geocodeEndPointURL)
void	setServiceCatalogURL(String serviceCatalogURL) Sets the service catalog end point URL.
void	setUser(AGSUser user)

Methods inherited from class com.esri.adf.web.data.GISResource

activate, addFunctionality, destroy, getDefaultSpatialReference, getFunctionalities, getFunctionality, getWebContext, passivate, setAlias, setFunctionalities

Methods inherited from class java.lang.Object

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

Field Detail

geocodeServer

protected transient com.esri.arcgisws.GeocodeServerBindingStub geocodeServer

endPointURL

protected String endPointURL

serviceCatalogURL

protected String serviceCatalogURL

The URL to a web service catalog end point.

mapName

protected String mapName

generatedAlias

protected String generatedAlias

If the user does not provide an alias for the resource, an alias is generated by this object and is represented by this variable

user

protected AGSUser user

An AGSUser object to authenticate connections to secure web services

Constructor Detail

AGSGeocodeResource

public AGSGeocodeResource()

Creates a new AGSGeocodeResource with no URL set. This constructor is typically used when one configures this resource in a JSF config file. If you are to programmatically create this resource, it is recommended that you use the other constructor that takes an end point URL as input.

AGSGeocodeResource

public AGSGeocodeResource(String endPointURL)

Method Detail

createGeocodeServer

protected void createGeocodeServer()

init

public void init(WebContext webContext)

Description copied from class: GISResource

This method is called by the WebContext to initialize the resource. This is typically called when the context itself is initialized or when users add a new resource to the context by using the WebContext.addResource(String, GISResource) method. A GISResource is usable only after this method has been called.

This method iterates through all its supported GISFunctionalitys and calls the GISFunctionality.initFunctionality(GISResource) on them all.

Sub-classes that want to do custom initialization should override this method and make the super call first before doing the custom stuff:

 public void init(WebContext context) {
   super.init(context);
   myInit();
 }
 

Specified by:

init in interface WebContextInitialize

Overrides:

init in class GISResource

Parameters:

webContext - the WebContext that maintains a reference to this resource

See Also:

WebContextInitialize.init(com.esri.adf.web.data.WebContext), GISFunctionality.initFunctionality(GISResource), WebContext.init(WebContext), WebContext.addResource(String, GISResource)

getAlias

public String getAlias()

Description copied from class: GISResource

Returns a reader friendly name for this resource.

It is a good practice for users to explicitly set an alias when the resource is created programmatically or declaratively. Resource providers should provide an auto-generated alias anyway in case users don't explicitly set an alias themselves.

Overrides:

getAlias in class GISResource

Returns:

a reader friendly name for this resource

getGeocodeServer

public com.esri.arcgisws.GeocodeServerPort getGeocodeServer()

getEndPointURL

public String getEndPointURL()

setEndPointURL

public void setEndPointURL(String geocodeEndPointURL)

getServiceCatalogURL

public String getServiceCatalogURL()

Returns the service catalog end point URL.

Returns:

the service catalog end point URL

setServiceCatalogURL

public void setServiceCatalogURL(String serviceCatalogURL)

Sets the service catalog end point URL.

Parameters:

serviceCatalogURL - the service catalog end point URL

setUser

public void setUser(AGSUser user)

getUser

public AGSUser getUser()