com.esri.gpt.catalog.arcgis.agportal.publication
Class AgpUpdateRequest

java.lang.Object
  com.esri.gpt.catalog.arcgis.agportal.publication.AgpBaseRequest
      com.esri.gpt.catalog.arcgis.agportal.publication.AgpUpdateRequest

public class AgpUpdateRequest
extends AgpBaseRequest

ArcGIS Portal update request.

Nested Class Summary

Nested classes/interfaces inherited from class com.esri.gpt.catalog.arcgis.agportal.publication.AgpBaseRequest

AgpBaseRequest.AttrMap, AgpBaseRequest.ItemDesc, AgpBaseRequest.ItemEntry, AgpBaseRequest.ItemType

Field Summary

Fields inherited from class com.esri.gpt.catalog.arcgis.agportal.publication.AgpBaseRequest

credentialProvider, ep, requestContext, XSLTTEMPLATES

Constructor Summary

AgpUpdateRequest(RequestContext requestContext, CredentialProvider credentialProvider, EndPoint endPoint, String itemId, String folderName, String metadata)
Creates instance of the request.

AgpUpdateRequest(RequestContext requestContext, CredentialProvider credentialProvider, String itemId, String folderName, String metadata)
Creates instance of the request.

Method Summary

String	execute() Executes request.
String	getFolderName() Gets folder name.
String	getItemId() Gets item id.
String	getMetadata() Gets metadata.
boolean	getUpdateMetadataOnly() Checks if update metadata only.
void	setUpdateMetadataOnly(boolean updateMetadataOnly) Makes update metadata only.

Methods inherited from class com.esri.gpt.catalog.arcgis.agportal.publication.AgpBaseRequest

checkError, execute, extractCredentialProvider, extractEsriItemAttributes, extractId, extractItemInfo, fetchToken, getCompiledTemplate, getFolderUrl, getItemUrl, processEsriItemAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

AgpUpdateRequest

public AgpUpdateRequest(RequestContext requestContext,
                        CredentialProvider credentialProvider,
                        String itemId,
                        String folderName,
                        String metadata)

Creates instance of the request. End-point is extracted from the configuration file.

Parameters:

requestContext - request context

credentialProvider - credential provider

itemId - id of the item to update

folderName - folder name

metadata - metadata

AgpUpdateRequest

public AgpUpdateRequest(RequestContext requestContext,
                        CredentialProvider credentialProvider,
                        EndPoint endPoint,
                        String itemId,
                        String folderName,
                        String metadata)

Creates instance of the request.

Parameters:

requestContext - request context

credentialProvider - credential provider

endPoint - end-point definition

itemId - id of the item to update

folderName - folder name

metadata - metadata

Method Detail

getFolderName

public String getFolderName()

Gets folder name.

Returns:

folder name

getItemId

public String getItemId()

Gets item id.

Returns:

item id

getUpdateMetadataOnly

public boolean getUpdateMetadataOnly()

Checks if update metadata only.

Returns:

true to update metadata only

setUpdateMetadataOnly

public void setUpdateMetadataOnly(boolean updateMetadataOnly)

Makes update metadata only.

Parameters:

updateMetadataOnly - true to update metadata only

getMetadata

public String getMetadata()

Gets metadata.

Returns:

metadata

execute

public String execute()
               throws AgpServerException,
                      AgpPublishException

Executes request.

Returns:

item id

Throws:

AgpServerException - server exception

AgpPublishException - publish exception