com.esri.arcgis.gisclient
Class UploadsClient

java.lang.Object
  com.esri.arcgis.gisclient.UploadsClient

All Implemented Interfaces:

IAdminUploadsClient, IServiceUploadsClient, IUploadsClient, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class UploadsClient
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IUploadsClient, IAdminUploadsClient, IServiceUploadsClient

The uploads client object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

UploadsClient()
Constructs a UploadsClient using ArcGIS Engine.

UploadsClient(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
UploadsClient theUploadsClient = (UploadsClient) obj;

Method Summary

void	adminCommit(IUploadItem pUploadItem, ILongArray pPartNumbers) Commits a registered upload item.
void	adminDelete(IUploadItem pUploadItem) Deletes the upload item.
ILongArray	adminGetPartNumbers(IUploadItem pUploadItem) Returns the numbers of the parts that have already been uploaded for the upload item.
IUploadItem	adminRegister(String itemName, String description) Instruct the server to reserve space for a new upload item, to be uploaded in parts.
IUploadItem	adminUploadFile(String file, String description) Uploads a file to the server without breaking it into parts.
void	adminUploadPart(IUploadItem pUploadItem, String file, int uploadPartNumber, long offset, int bytesToWrite) Uploads a part for the upload item.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
long	getServiceMaxUploadSizeInBytes(IAGSServerObjectName pTargetSevice) Returns the maximum upload size for a service.
int	getTimeoutInSecs() .
IUploadItem	getUploadItem(String itemID) Returns the upload item with the given itemID.
IEnumUploadItem	getUploadItems() Returns all uploaded items.
int	hashCode() the hashcode for this object
void	init(IAGSServerConnection pConn) Initializes the uploads client object.
void	serviceCommit(IUploadItem pUploadItem, IAGSServerObjectName pTargetService, ILongArray pPartNumbers) Commits a registered upload item.
void	serviceDelete(IUploadItem pUploadItem, IAGSServerObjectName pTargetService) Deletes the upload item.
ILongArray	serviceGetPartNumbers(IUploadItem pUploadItem, IAGSServerObjectName pTargetService) Returns the numbers of the parts that have already been uploaded for the upload item.
IUploadItem	serviceRegister(String itemName, String description, IAGSServerObjectName pTargetService) Instruct the server to reserve space for a new upload item, to be uploaded in parts.
IUploadItem	serviceUploadFile(String file, String description, IAGSServerObjectName pTargetService) Uploads a file to the server without breaking it into parts.
void	serviceUploadPart(IUploadItem pUploadItem, String file, int uploadPartNumber, long offset, int bytesToWrite, IAGSServerObjectName pTargetService) Uploads a part for the upload item.
void	setTimeoutInSecs(int pTimeout) .

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

UploadsClient

public UploadsClient()
              throws IOException,
                     UnknownHostException

Constructs a UploadsClient using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

UploadsClient

public UploadsClient(Object obj)
              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
UploadsClient theUploadsClient = (UploadsClient) obj;

Construct a UploadsClient using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to UploadsClient.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

init

public void init(IAGSServerConnection pConn)
          throws IOException,
                 AutomationException

Initializes the uploads client object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

init in interface IUploadsClient

Parameters:

pConn - A reference to a com.esri.arcgis.gisclient.IAGSServerConnection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeoutInSecs

public void setTimeoutInSecs(int pTimeout)
                      throws IOException,
                             AutomationException

.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setTimeoutInSecs in interface IUploadsClient

Parameters:

pTimeout - The pTimeout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeoutInSecs

public int getTimeoutInSecs()
                     throws IOException,
                            AutomationException

.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getTimeoutInSecs in interface IUploadsClient

Returns:

The pTimeout

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

adminUploadFile

public IUploadItem adminUploadFile(String file,
                                   String description)
                            throws IOException,
                                   AutomationException

Uploads a file to the server without breaking it into parts.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

adminUploadFile in interface IAdminUploadsClient

Parameters:

file - The file (in)

description - The description (in)

Returns:

A reference to a com.esri.arcgis.gisclient.IUploadItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

adminRegister

public IUploadItem adminRegister(String itemName,
                                 String description)
                          throws IOException,
                                 AutomationException

Instruct the server to reserve space for a new upload item, to be uploaded in parts.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

adminRegister in interface IAdminUploadsClient

Parameters:

itemName - The itemName (in)

description - The description (in)

Returns:

A reference to a com.esri.arcgis.gisclient.IUploadItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

adminUploadPart

public void adminUploadPart(IUploadItem pUploadItem,
                            String file,
                            int uploadPartNumber,
                            long offset,
                            int bytesToWrite)
                     throws IOException,
                            AutomationException

Uploads a part for the upload item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

adminUploadPart in interface IAdminUploadsClient

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

file - The file (in)

uploadPartNumber - The uploadPartNumber (in)

offset - Unsigned 64-bit int (in)

bytesToWrite - The bytesToWrite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

adminGetPartNumbers

public ILongArray adminGetPartNumbers(IUploadItem pUploadItem)
                               throws IOException,
                                      AutomationException

Returns the numbers of the parts that have already been uploaded for the upload item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

adminGetPartNumbers in interface IAdminUploadsClient

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

adminCommit

public void adminCommit(IUploadItem pUploadItem,
                        ILongArray pPartNumbers)
                 throws IOException,
                        AutomationException

Commits a registered upload item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

adminCommit in interface IAdminUploadsClient

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

pPartNumbers - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUploadItems

public IEnumUploadItem getUploadItems()
                               throws IOException,
                                      AutomationException

Returns all uploaded items.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getUploadItems in interface IAdminUploadsClient

Returns:

A reference to a com.esri.arcgis.gisclient.IEnumUploadItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUploadItem

public IUploadItem getUploadItem(String itemID)
                          throws IOException,
                                 AutomationException

Returns the upload item with the given itemID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getUploadItem in interface IAdminUploadsClient

Parameters:

itemID - The itemID (in)

Returns:

A reference to a com.esri.arcgis.gisclient.IUploadItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

adminDelete

public void adminDelete(IUploadItem pUploadItem)
                 throws IOException,
                        AutomationException

Deletes the upload item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

adminDelete in interface IAdminUploadsClient

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceUploadFile

public IUploadItem serviceUploadFile(String file,
                                     String description,
                                     IAGSServerObjectName pTargetService)
                              throws IOException,
                                     AutomationException

Uploads a file to the server without breaking it into parts.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

serviceUploadFile in interface IServiceUploadsClient

Parameters:

file - The file (in)

description - The description (in)

pTargetService - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Returns:

A reference to a com.esri.arcgis.gisclient.IUploadItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceRegister

public IUploadItem serviceRegister(String itemName,
                                   String description,
                                   IAGSServerObjectName pTargetService)
                            throws IOException,
                                   AutomationException

Instruct the server to reserve space for a new upload item, to be uploaded in parts.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

serviceRegister in interface IServiceUploadsClient

Parameters:

itemName - The itemName (in)

description - The description (in)

pTargetService - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Returns:

A reference to a com.esri.arcgis.gisclient.IUploadItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceUploadPart

public void serviceUploadPart(IUploadItem pUploadItem,
                              String file,
                              int uploadPartNumber,
                              long offset,
                              int bytesToWrite,
                              IAGSServerObjectName pTargetService)
                       throws IOException,
                              AutomationException

Uploads a part for the upload item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

serviceUploadPart in interface IServiceUploadsClient

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

file - The file (in)

uploadPartNumber - The uploadPartNumber (in)

offset - Unsigned 64-bit int (in)

bytesToWrite - The bytesToWrite (in)

pTargetService - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceGetPartNumbers

public ILongArray serviceGetPartNumbers(IUploadItem pUploadItem,
                                        IAGSServerObjectName pTargetService)
                                 throws IOException,
                                        AutomationException

Returns the numbers of the parts that have already been uploaded for the upload item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

serviceGetPartNumbers in interface IServiceUploadsClient

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

pTargetService - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceCommit

public void serviceCommit(IUploadItem pUploadItem,
                          IAGSServerObjectName pTargetService,
                          ILongArray pPartNumbers)
                   throws IOException,
                          AutomationException

Commits a registered upload item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

serviceCommit in interface IServiceUploadsClient

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

pTargetService - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

pPartNumbers - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceDelete

public void serviceDelete(IUploadItem pUploadItem,
                          IAGSServerObjectName pTargetService)
                   throws IOException,
                          AutomationException

Deletes the upload item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

serviceDelete in interface IServiceUploadsClient

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

pTargetService - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceMaxUploadSizeInBytes

public long getServiceMaxUploadSizeInBytes(IAGSServerObjectName pTargetSevice)
                                    throws IOException,
                                           AutomationException

Returns the maximum upload size for a service.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getServiceMaxUploadSizeInBytes in interface IServiceUploadsClient

Parameters:

pTargetSevice - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Returns:

Unsigned 64-bit int

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.