com.esri.core.tasks.ags.geoprocessing
Class GPServiceInfo

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

public class GPServiceInfo
extends Object

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

Since:

10.1.1

Constructor Summary

GPServiceInfo()

Method Summary

static GPServiceInfo	fromJson(org.codehaus.jackson.JsonParser parser) Create a GPServiceInfo instance from the json contained in the given JsonParser object.
static GPServiceInfo	fromUrl(String url) Create a GPServiceInfo instance for the service at the given url.
static GPServiceInfo	fromUrl(String url, UserCredentials credentials) Create 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPServiceInfo

public GPServiceInfo()

Method Detail

fromUrl

public static GPServiceInfo fromUrl(String url)
                             throws Exception

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

Parameters:

url - the url of the service

Returns:

the GP service info

Throws:

Exception - the exception

Since:

10.1.1

fromUrl

public static GPServiceInfo fromUrl(String url,
                                    UserCredentials credentials)
                             throws Exception

Create a GPServiceInfo instance for the 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 - the url of the service

credentials - the credentials required to access the service

Returns:

the GP service info

Throws:

Exception - the exception

Since:

10.1.1

fromJson

public static GPServiceInfo fromJson(org.codehaus.jackson.JsonParser parser)
                              throws Exception

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

Parameters:

parser - the parser

Returns:

the GP service info

Throws:

Exception - the exception

Since:

10.1.1

getTasks

public String[] getTasks()

Gets the names of the tasks defined by the service.

Returns:

the tasks

Since:

10.1.1

getExecutionType

public GPTaskInfo.ExecutionType getExecutionType()

Gets the execution type, either synchronous or asynchronous.

Returns:

the execution type

Since:

10.1.1

getResultMapServerName

public String getResultMapServerName()

Gets the result map server name, if any.

Returns:

the result map server name

Since:

10.1.1

getMaximumRecords

public int getMaximumRecords()

Gets the maximum records returned by the service.

Returns:

the maximum records

Since:

10.1.1

getServiceDescription

public String getServiceDescription()

Gets the service description.

Returns:

the service description

Since:

10.1.1

getCurrentVersion

public String getCurrentVersion()

Gets the current server version.

Returns:

the current version

Since:

10.1.1