|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.adf.web.data.GISResource
com.esri.adf.web.ags.data.image.AGSImageResource
public class AGSImageResource
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.
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, hasFailedFunctionalities, init |
Constructor Summary | |
---|---|
AGSImageResource()
Creates a new AGSImageResource with no URL set. |
|
AGSImageResource(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. |
String |
getAlias()
Returns a reader friendly name for this resource. |
String |
getEndPointURL()
Returns the URL to a web service end point which serves an ArcGIS server image |
com.esri.arcgisws.EsriImageFormat |
getImageFormat(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. |
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(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(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 |
---|
protected transient com.esri.arcgisws.ImageServerBindingStub imageServer
Constructor Detail |
---|
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.
public AGSImageResource(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
endPointURL
- the URL to the ArcGIS Server image service. For example:
http://[server]:[port]/arcgis/services/[service_name]/ImageServerMethod Detail |
---|
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.
ADFAGSException
- if an error occurs while connecting to the endPointURL
public void init(WebContext webContext)
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 GISFunctionality
s 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(); }
init
in interface WebContextInitialize
init
in class GISResource
webContext
- the WebContext
that maintains a reference to this resourceWebContextInitialize.init(com.esri.adf.web.data.WebContext)
,
GISFunctionality.initFunctionality(GISResource)
,
WebContext.init(WebContext)
,
WebContext.addResource(String, GISResource)
public String getAlias()
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.
getAlias
in class GISResource
public com.esri.arcgisws.ImageServerPort getImageServer()
Returns The remote stub to the image service that this resource represents
public com.esri.arcgisws.ImageServiceInfo getImageServiceInfo()
ImageServiceInfo
for associated ArcGIS Server image service.
ImageServiceInfo
for associated ArcGIS Server image service.public void setImageServiceInfo(com.esri.arcgisws.ImageServiceInfo serviceInfo)
Sets the ImageServiceInfo
for associated ArcGIS Server image service.
serviceInfo
- the ImageServiceInfo
for associated ArcGIS Server image service.public String getEndPointURL()
Returns the URL to a web service end point which serves an ArcGIS server image
public void setEndPointURL(String endPointURL)
Sets the URL to a web service end point which serves an ArcGIS server image
endPointURL
- the URL to a web service end point which serves an ArcGIS server image. For example:
http://[server]:[port]/arcgis/services/[service_name]/ImageServerpublic AGSUser getUser()
Returns the AGSUser
to authenticate connections to secure web services
AGSUser
to authenticate connections to secure web servicespublic void setUser(AGSUser user)
Sets the AGSUser
to authenticate connections to secure web services
user
- the AGSUser
to authenticate connections to secure web servicespublic String getServiceCatalogURL()
public void setServiceCatalogURL(String serviceCatalogURL)
serviceCatalogURL
- the service catalog end point URLpublic void setDefaultSpatialReference(WebSpatialReference spatialReference)
Sets the default WebSpatialReference
for that resource.
spatialReference
- the default WebSpatialReference
for that resource.public com.esri.arcgisws.EsriImageFormat getImageFormat(String format)
format
- a String defining the image format
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |