com.esri.adf.web.aws.data
Class AWSResource

java.lang.Object
  extended bycom.esri.adf.web.data.GISResource
      extended bycom.esri.adf.web.aws.data.AWSResource
All Implemented Interfaces:
java.io.Serializable, WebContextInitialize, WebLifecycle
Direct Known Subclasses:
AWSGeocodeResource, AWSMapResource, AWSQueryResource

public class AWSResource
extends GISResource

See Also:
Serialized Form

Field Summary
protected  com.esri.aws.IAuthentication_PortType authentication
           
protected  com.esri.aws.IContentFinder_PortType content
           
protected  int coordSysId
           
static int DEFAULT_COORDSYS
           
static java.lang.String NO_GEOM_RETURN
           
static java.lang.String TOKEN_EXPIRED_CODE
           
 
Fields inherited from class com.esri.adf.web.data.GISResource
alias, context, defaultSpatialReference, functionalities, init
 
Constructor Summary
AWSResource()
           
 
Method Summary
 java.lang.String getAlias()
           Returns a reader friendly name for this resource.
 java.lang.String getAuthenticationEndPointURL()
           
 java.lang.String getContentFinderEndPointURL()
           
 com.esri.aws.ContentFinderRecord getDataSourceMetadata(java.lang.String dataSourceName, java.lang.String serviceType)
           
 java.lang.String getPassword()
           
 java.lang.String getToken()
           
 int getTokenExpiryMinutes()
           
 java.lang.String getUserName()
           
 void init(WebContext context)
           This method is called by the WebContext to initialize the resource.
 boolean isPasswordEncrypted()
           
 void setAuthenticationEndPointURL(java.lang.String authenticationEndPointURL)
           
 void setContentFinderEndPointURL(java.lang.String contentFinderEndPointURL)
           
 void setPassword(java.lang.String password)
           
 void setPasswordEncrypted(boolean passwordEncrypted)
           
 void setToken(java.lang.String token)
           
 void setTokenExpiryMinutes(int tokenExpiryMinutes)
           
 void setUserName(java.lang.String userName)
           
 
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

TOKEN_EXPIRED_CODE

public static final java.lang.String TOKEN_EXPIRED_CODE
See Also:
Constant Field Values

NO_GEOM_RETURN

public static final java.lang.String NO_GEOM_RETURN
See Also:
Constant Field Values

authentication

protected com.esri.aws.IAuthentication_PortType authentication

content

protected com.esri.aws.IContentFinder_PortType content

DEFAULT_COORDSYS

public static int DEFAULT_COORDSYS

coordSysId

protected int coordSysId
Constructor Detail

AWSResource

public AWSResource()
Method Detail

init

public void init(WebContext context)
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(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:
context - 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(resourceId, 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

getToken

public java.lang.String getToken()

getAuthenticationEndPointURL

public java.lang.String getAuthenticationEndPointURL()

getContentFinderEndPointURL

public java.lang.String getContentFinderEndPointURL()

getUserName

public java.lang.String getUserName()

getPassword

public java.lang.String getPassword()

isPasswordEncrypted

public boolean isPasswordEncrypted()

getTokenExpiryMinutes

public int getTokenExpiryMinutes()

setToken

public void setToken(java.lang.String token)

setAuthenticationEndPointURL

public void setAuthenticationEndPointURL(java.lang.String authenticationEndPointURL)

setContentFinderEndPointURL

public void setContentFinderEndPointURL(java.lang.String contentFinderEndPointURL)

setUserName

public void setUserName(java.lang.String userName)

setPassword

public void setPassword(java.lang.String password)

setPasswordEncrypted

public void setPasswordEncrypted(boolean passwordEncrypted)

setTokenExpiryMinutes

public void setTokenExpiryMinutes(int tokenExpiryMinutes)

getDataSourceMetadata

public com.esri.aws.ContentFinderRecord getDataSourceMetadata(java.lang.String dataSourceName,
                                                              java.lang.String serviceType)