com.esri.adf.web.ags.data.gp
Class AGSGPResource

java.lang.Object
  com.esri.adf.web.data.GISResource
      com.esri.adf.web.ags.data.gp.AGSGPResource

All Implemented Interfaces:

WebContextInitialize, WebLifecycle, Serializable

Direct Known Subclasses:

AGSLocalGPResource

public class AGSGPResource
extends GISResource

See Also:

Serialized Form

Field Summary

protected String	endPointURL
protected String	generatedAlias
protected com.esri.arcgisws.GPServerBindingStub	gpServer
protected com.esri.arcgisws.MapDescription	resultMapDescription
protected AGSMapResource	resultMapResource
protected com.esri.arcgisws.MapServerInfo	resultMapServerInfo
protected String	serviceCatalogURL The URL to a web service catalog end point.
protected AGSUser	user

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

alias, context, defaultSpatialReference, functionalities, hasFailedFunctionalities, init

Constructor Summary

AGSGPResource()

AGSGPResource(String endPointURL)

Method Summary

void	activate() This method is called by the associated WebContext when the context itself is being activated.
protected void	createGPServer()
protected void	createResultMapResource()
void	destroy() The cleanup (final) chores of the resource like releasing held resources must be performed in this method.
String	getEndPointURL()
com.esri.arcgisws.GPServerPort	getGPServer()
AGSMapResource	getResultMapResource()
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	passivate() This method is called by the associated WebContext when the context itself is being passivated.
void	setEndPointURL(String endPointURL)
void	setResultMapResource(AGSMapResource resultMapResource)
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

addFunctionality, getAlias, getDefaultSpatialReference, getFunctionalities, getFunctionality, getWebContext, setAlias, setFunctionalities

Methods inherited from class java.lang.Object

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

Field Detail

endPointURL

protected String endPointURL

serviceCatalogURL

protected String serviceCatalogURL

The URL to a web service catalog end point.

generatedAlias

protected String generatedAlias

gpServer

protected transient com.esri.arcgisws.GPServerBindingStub gpServer

resultMapResource

protected AGSMapResource resultMapResource

resultMapServerInfo

protected com.esri.arcgisws.MapServerInfo resultMapServerInfo

resultMapDescription

protected com.esri.arcgisws.MapDescription resultMapDescription

user

protected AGSUser user

Constructor Detail

AGSGPResource

public AGSGPResource()

AGSGPResource

public AGSGPResource(String endPointURL)

Method Detail

createGPServer

protected void createGPServer()

createResultMapResource

protected void createResultMapResource()

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)

activate

public void activate()

Description copied from class: GISResource

This method is called by the associated WebContext when the context itself is being activated. This typically happens when a new user request is received to perform a set of operations. A GISResource is available for the execution of these operations only after this method has been called.

This method iterates through all its supported GISFunctionalitys and calls the activate() method on those functionalities that implement WebLifecycle.

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

 public void activate() {
   super.activate();
   myActivate();
 }
 

Specified by:

activate in interface WebLifecycle

Overrides:

activate in class GISResource

See Also:

WebLifecycle.activate(), WebContext.activate()

destroy

public void destroy()

Description copied from class: GISResource

The cleanup (final) chores of the resource like releasing held resources must be performed in this method. This is typically called when the context itself is being destroyed or when users remove this resource from the context by using the WebContext.removeResource(GISResource) method. A GISResource is unusable after this method has been called.

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

Sub-classes that want to do custom cleanup chores should override this method and do the custom cleanup first before making the super call:

 public void destroy() {
   myDestroy();
   super.destroy();
 }
 

Specified by:

destroy in interface WebContextInitialize

Overrides:

destroy in class GISResource

See Also:

WebContextInitialize.destroy(), GISFunctionality.destroyFunctionality(), WebContext.destroy(), WebContext.removeResource(GISResource)

passivate

public void passivate()

Description copied from class: GISResource

This method is called by the associated WebContext when the context itself is being passivated. This typically happens after a user request to perform a set of operations has been serviced. A GISResource is unavailable for the execution of more operations after this method has been called.

This method iterates through all its supported GISFunctionalitys and calls the passivate() method on those functionalities that implement WebLifecycle.

Sub-classes that want to do custom passivation should override this method and do the custom passivation first before making the super call:

 public void passivate() {
   myPassivate();
   super.passivate();
 }
 

Specified by:

passivate in interface WebLifecycle

Overrides:

passivate in class GISResource

See Also:

WebLifecycle.passivate(), WebContext.passivate()

getGPServer

public com.esri.arcgisws.GPServerPort getGPServer()

getEndPointURL

public String getEndPointURL()

setEndPointURL

public void setEndPointURL(String endPointURL)

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

getResultMapResource

public AGSMapResource getResultMapResource()

setResultMapResource

public void setResultMapResource(AGSMapResource resultMapResource)

setUser

public void setUser(AGSUser user)

getUser

public AGSUser getUser()