com.esri.adf.web.ags.data.image
Class AGSImageResource

java.lang.Object
  com.esri.adf.web.data.GISResource
      com.esri.adf.web.ags.data.image.AGSImageResource

All Implemented Interfaces:

WebContextInitialize, WebLifecycle, java.io.Serializable

Direct Known Subclasses:

AGSLocalImageResource

public class AGSImageResource
extends GISResource

The AGSImageResource represents a GISResource for ArcGIS Server image services. More specifically, this is the internet resource to the ArcGIS Server. Users will need to provide a URL to a web service end point which serves an ArcGIS server Image Service. Additionally, for secure web services, users will need to provide an AGSUser to authenticate against the service.

It is important to note that this resource uses the SOAP protocol to communicate with the server. More specifically, it uses SOAP over HTTP. In order for some of the AGS functionalities to share the same codebase we use SOAP to communicate with local services as well wherever possible. Given this scenario, this class serves as a super-class for the AGSLocalImageResource which represents a GISResource for ArcGIS Server local Image Services.

The capabilities of this service are restricted by the methods exposed by the ImageServerPort interface to ArcGIS Server internet Image services.

See Also:

Serialized Form

Field Summary

protected com.esri.arcgisws.ImageServerBindingStub

imageServer The remote stub to the image service that this resource represents

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

alias, context, defaultSpatialReference, functionalities, init

Constructor Summary

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

AGSImageResource(java.lang.String endPointURL)
Creates a new AGSImageResource to an ArcGIS Server image service at the given end point.

Method Summary

protected void	createImageServer() This method connects to the ArcGIS server image service end point and creates a remote stub to the server.
java.lang.String	getAlias() Returns a reader friendly name for this resource.
java.lang.String	getEndPointURL() Returns the URL to a web service end point which serves an ArcGIS server image
com.esri.arcgisws.EsriImageFormat	getImageFormat(java.lang.String format) Returns an EsriImageFormat constant corresponding to format string.
com.esri.arcgisws.ImageServerPort	getImageServer() Returns The remote stub to the image service that this resource represents
com.esri.arcgisws.ImageServiceInfo	getImageServiceInfo() Returns the ImageServiceInfo for associated ArcGIS Server image service.
java.lang.String	getServiceCatalogURL() Returns the service catalog end point URL.
AGSUser	getUser() Returns the AGSUser to authenticate connections to secure web services
void	init(WebContext webContext) This method is called by the WebContext to initialize the resource.
void	setDefaultSpatialReference(WebSpatialReference spatialReference) Sets the default WebSpatialReference for that resource.
void	setEndPointURL(java.lang.String endPointURL) Sets the URL to a web service end point which serves an ArcGIS server image
void	setImageServiceInfo(com.esri.arcgisws.ImageServiceInfo serviceInfo) Sets the ImageServiceInfo for associated ArcGIS Server image service.
void	setServiceCatalogURL(java.lang.String serviceCatalogURL) Sets the service catalog end point URL.
void	setUser(AGSUser user) Sets the AGSUser to authenticate connections to secure web services

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

imageServer

protected transient com.esri.arcgisws.ImageServerBindingStub imageServer

The remote stub to the image service that this resource represents

Constructor Detail

AGSImageResource

public AGSImageResource()

Creates a new AGSImageResource 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.

AGSImageResource

public AGSImageResource(java.lang.String endPointURL)

Creates a new AGSImageResource to an ArcGIS Server image service at the given end point. If you are to programmatically create this resource, it is recommended that you use this constructor

Parameters:

endPointURL - the URL to the ArcGIS Server image service. For example: http://[server]:[port]/arcgis/services/[service_name]/ImageServer

Method Detail

createImageServer

protected void createImageServer()

This method connects to the ArcGIS server image service end point and creates a remote stub to the server. If a user is provided, it will attempt to connect to the server with that user's credentials.

Throws:

ADFAGSException - if an error occurs while connecting to the endPointURL

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 java.lang.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

getImageServer

public com.esri.arcgisws.ImageServerPort getImageServer()

Returns The remote stub to the image service that this resource represents

Returns:

The remote stub to the image service that this resource represents

getImageServiceInfo

public com.esri.arcgisws.ImageServiceInfo getImageServiceInfo()

Returns the ImageServiceInfo for associated ArcGIS Server image service.

Returns:

the ImageServiceInfo for associated ArcGIS Server image service.

setImageServiceInfo

public void setImageServiceInfo(com.esri.arcgisws.ImageServiceInfo serviceInfo)

Sets the ImageServiceInfo for associated ArcGIS Server image service.

Parameters:

serviceInfo - the ImageServiceInfo for associated ArcGIS Server image service.

getEndPointURL

public java.lang.String getEndPointURL()

Returns the URL to a web service end point which serves an ArcGIS server image

Returns:

the URL to a web service end point which serves an ArcGIS server image

setEndPointURL

public void setEndPointURL(java.lang.String endPointURL)

Sets the URL to a web service end point which serves an ArcGIS server image

Parameters:

endPointURL - the URL to a web service end point which serves an ArcGIS server image. For example: http://[server]:[port]/arcgis/services/[service_name]/ImageServer

getUser

public AGSUser getUser()

Returns the AGSUser to authenticate connections to secure web services

Returns:

the AGSUser to authenticate connections to secure web services

setUser

public void setUser(AGSUser user)

Sets the AGSUser to authenticate connections to secure web services

Parameters:

user - the AGSUser to authenticate connections to secure web services

getServiceCatalogURL

public java.lang.String getServiceCatalogURL()

Returns the service catalog end point URL.

Returns:

the service catalog end point URL

setServiceCatalogURL

public void setServiceCatalogURL(java.lang.String serviceCatalogURL)

Sets the service catalog end point URL.

Parameters:

serviceCatalogURL - the service catalog end point URL

setDefaultSpatialReference

public void setDefaultSpatialReference(WebSpatialReference spatialReference)

Sets the default WebSpatialReference for that resource.

Parameters:

spatialReference - the default WebSpatialReference for that resource.

getImageFormat

public com.esri.arcgisws.EsriImageFormat getImageFormat(java.lang.String format)

Returns an EsriImageFormat constant corresponding to format string. The following strings are permitted: "ai", "bmp", "dib", "emf", "gif", "jpg", "none", "pdf", "png", "png24", "ps", "svg", "tiff".

Parameters:

format - a String defining the image format

Returns:

an EsriImageFormat constant