public class

GPServiceInfo

extends Object
java.lang.Object
   ↳ com.esri.core.tasks.ags.geoprocessing.GPServiceInfo

Class Overview

This class provides information on a geoprocessing service at a given URL. Information includes:

  • Current server version
  • Service description
  • Maximum number of records returned by a task
  • Name of the result map service, if any
  • Whether the service's tasks are synchronous or asynchronous
  • A list of tasks defined by the service

Summary

Public Constructors
GPServiceInfo()
Public Methods
static GPServiceInfo fromJson(JsonParser parser)
Create a GPServiceInfo instance from the json contained in the given JsonParser object.
static GPServiceInfo fromUrl(String url, UserCredentials credentials)
Creates a GPServiceInfo instance for the secure service at the given URL.
static GPServiceInfo fromUrl(String url)
Creates a GPServiceInfo instance for the service at the given URL.
String getCurrentVersion()
Gets the current server version.
GPTaskInfo.ExecutionType getExecutionType()
Gets the execution type, either synchronous or asynchronous.
int getMaximumRecords()
Gets the maximum records returned by the service.
String getResultMapServerName()
Gets the result map server name, if any.
String getServiceDescription()
Gets the service description.
String[] getTasks()
Gets the names of the tasks defined by the service.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public GPServiceInfo ()

Public Methods

public static GPServiceInfo fromJson (JsonParser parser)

Create a GPServiceInfo instance from the json contained in the given JsonParser object.

Parameters
parser JsonParser: the parser
Returns
GPServiceInfo the GP service info
Throws
Exception the exception

public static GPServiceInfo fromUrl (String url, UserCredentials credentials)

Creates a GPServiceInfo instance for the secure service at the given URL. Login credentials are provided by the credentials parameter. This method will query the service and return the service information.

Parameters
url String: the URL of the service
credentials UserCredentials: the credentials required to access the service
Returns
GPServiceInfo the GP service info
Throws
Exception any exception occuring during the request for information

public static GPServiceInfo fromUrl (String url)

Creates a GPServiceInfo instance for the service at the given URL. This method will query the service and return the service information.

Parameters
url String: the URL of the service
Returns
GPServiceInfo the GP service info
Throws
Exception any exception occuring during the request for information

public String getCurrentVersion ()

Gets the current server version.

Returns
String the current version

public GPTaskInfo.ExecutionType getExecutionType ()

Gets the execution type, either synchronous or asynchronous.

Returns
GPTaskInfo.ExecutionType the execution type

public int getMaximumRecords ()

Gets the maximum records returned by the service.

Returns
int the maximum records

public String getResultMapServerName ()

Gets the result map server name, if any.

Returns
String the result map server name

public String getServiceDescription ()

Gets the service description.

Returns
String the service description

public String[] getTasks ()

Gets the names of the tasks defined by the service.

Returns
String[] the tasks