com.esri.arcgis.gisclient
Class UploadsClient

java.lang.Object
  extended by com.esri.arcgis.gisclient.UploadsClient
All Implemented Interfaces:
IAdminUploadsClient, IServiceUploadsClient, IUploadsClient, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

COM Class 'UploadsClient'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriGISClient.olb'

Description 'The uploads client object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.gisclient.IUploadsClient
IID, IIDedb37aff_c199_4063_ab1f_fe936d5b5fd0, xxDummy
 
Fields inherited from interface com.esri.arcgis.gisclient.IAdminUploadsClient
IID, IID2362ad5f_c545_4bd8_b538_557a1c5b89f1, xxDummy
 
Fields inherited from interface com.esri.arcgis.gisclient.IServiceUploadsClient
IID, IIDddcbdaac_b932_4279_a2c1_5a151632b793, xxDummy
 
Constructor Summary
UploadsClient()
          Constructs a UploadsClient using ArcGIS Engine.
UploadsClient(java.lang.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(java.lang.String itemName, java.lang.String description)
          Instruct the server to reserve space for a new upload item, to be uploaded in parts.
 IUploadItem adminUploadFile(java.lang.String file, java.lang.String description)
          Uploads a file to the server without breaking it into parts.
 void adminUploadPart(IUploadItem pUploadItem, java.lang.String file, int uploadPartNumber, long offset, int bytesToWrite)
          Uploads a part for the upload item.
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 long getServiceMaxUploadSizeInBytes(IAGSServerObjectName pTargetSevice)
          Returns the maximum upload size for a service.
 int getTimeoutInSecs()
          .
 IUploadItem getUploadItem(java.lang.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 release()
          Release a UploadsClient.
 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(java.lang.String itemName, java.lang.String description, IAGSServerObjectName pTargetService)
          Instruct the server to reserve space for a new upload item, to be uploaded in parts.
 IUploadItem serviceUploadFile(java.lang.String file, java.lang.String description, IAGSServerObjectName pTargetService)
          Uploads a file to the server without breaking it into parts.
 void serviceUploadPart(IUploadItem pUploadItem, java.lang.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
 

Constructor Detail

UploadsClient

public UploadsClient()
              throws java.io.IOException,
                     java.net.UnknownHostException
Constructs a UploadsClient using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

UploadsClient

public UploadsClient(java.lang.Object obj)
              throws java.io.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:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a UploadsClient.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

init

public void init(IAGSServerConnection pConn)
          throws java.io.IOException,
                 AutomationException
Initializes the uploads client object.

Specified by:
init in interface IUploadsClient
Parameters:
pConn - A reference to a com.esri.arcgis.gisclient.IAGSServerConnection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeoutInSecs

public void setTimeoutInSecs(int pTimeout)
                      throws java.io.IOException,
                             AutomationException
.

Specified by:
setTimeoutInSecs in interface IUploadsClient
Parameters:
pTimeout - The pTimeout (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeoutInSecs

public int getTimeoutInSecs()
                     throws java.io.IOException,
                            AutomationException
.

Specified by:
getTimeoutInSecs in interface IUploadsClient
Returns:
The pTimeout
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adminUploadFile

public IUploadItem adminUploadFile(java.lang.String file,
                                   java.lang.String description)
                            throws java.io.IOException,
                                   AutomationException
Uploads a file to the server without breaking it into parts.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adminRegister

public IUploadItem adminRegister(java.lang.String itemName,
                                 java.lang.String description)
                          throws java.io.IOException,
                                 AutomationException
Instruct the server to reserve space for a new upload item, to be uploaded in parts.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adminUploadPart

public void adminUploadPart(IUploadItem pUploadItem,
                            java.lang.String file,
                            int uploadPartNumber,
                            long offset,
                            int bytesToWrite)
                     throws java.io.IOException,
                            AutomationException
Uploads a part for the upload item.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adminGetPartNumbers

public ILongArray adminGetPartNumbers(IUploadItem pUploadItem)
                               throws java.io.IOException,
                                      AutomationException
Returns the numbers of the parts that have already been uploaded for the upload item.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adminCommit

public void adminCommit(IUploadItem pUploadItem,
                        ILongArray pPartNumbers)
                 throws java.io.IOException,
                        AutomationException
Commits a registered upload item.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUploadItems

public IEnumUploadItem getUploadItems()
                               throws java.io.IOException,
                                      AutomationException
Returns all uploaded items.

Specified by:
getUploadItems in interface IAdminUploadsClient
Returns:
A reference to a com.esri.arcgis.gisclient.IEnumUploadItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUploadItem

public IUploadItem getUploadItem(java.lang.String itemID)
                          throws java.io.IOException,
                                 AutomationException
Returns the upload item with the given itemID.

Specified by:
getUploadItem in interface IAdminUploadsClient
Parameters:
itemID - The itemID (in)
Returns:
A reference to a com.esri.arcgis.gisclient.IUploadItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

adminDelete

public void adminDelete(IUploadItem pUploadItem)
                 throws java.io.IOException,
                        AutomationException
Deletes the upload item.

Specified by:
adminDelete in interface IAdminUploadsClient
Parameters:
pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serviceUploadFile

public IUploadItem serviceUploadFile(java.lang.String file,
                                     java.lang.String description,
                                     IAGSServerObjectName pTargetService)
                              throws java.io.IOException,
                                     AutomationException
Uploads a file to the server without breaking it into parts.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serviceRegister

public IUploadItem serviceRegister(java.lang.String itemName,
                                   java.lang.String description,
                                   IAGSServerObjectName pTargetService)
                            throws java.io.IOException,
                                   AutomationException
Instruct the server to reserve space for a new upload item, to be uploaded in parts.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serviceUploadPart

public void serviceUploadPart(IUploadItem pUploadItem,
                              java.lang.String file,
                              int uploadPartNumber,
                              long offset,
                              int bytesToWrite,
                              IAGSServerObjectName pTargetService)
                       throws java.io.IOException,
                              AutomationException
Uploads a part for the upload item.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serviceGetPartNumbers

public ILongArray serviceGetPartNumbers(IUploadItem pUploadItem,
                                        IAGSServerObjectName pTargetService)
                                 throws java.io.IOException,
                                        AutomationException
Returns the numbers of the parts that have already been uploaded for the upload item.

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:
java.io.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 java.io.IOException,
                          AutomationException
Commits a registered upload item.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serviceDelete

public void serviceDelete(IUploadItem pUploadItem,
                          IAGSServerObjectName pTargetService)
                   throws java.io.IOException,
                          AutomationException
Deletes the upload item.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServiceMaxUploadSizeInBytes

public long getServiceMaxUploadSizeInBytes(IAGSServerObjectName pTargetSevice)
                                    throws java.io.IOException,
                                           AutomationException
Returns the maximum upload size for a service.

Specified by:
getServiceMaxUploadSizeInBytes in interface IServiceUploadsClient
Parameters:
pTargetSevice - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)
Returns:
Unsigned 64-bit int
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.