Class IntegrationDataAppSoapStub
- java.lang.Object
-
- com.collabnet.ce.soap60.webservices.ClientSoapStub
-
- com.collabnet.ce.soap60.webservices.integrationdata.IntegrationDataAppSoapStub
-
- All Implemented Interfaces:
IIntegrationDataAppSoap
public class IntegrationDataAppSoapStub extends ClientSoapStub implements IIntegrationDataAppSoap
-
-
Field Summary
-
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT
-
-
Constructor Summary
Constructors Constructor Description IntegrationDataAppSoapStub(String soapServerUrl)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SoapNamedValuesgetData(String sessionId, String namespaceId, String objectId)Gets data for an object from the integration data serviceStringgetDataByKey(String sessionId, String namespaceId, String objectId, String key)Gets data for an object from the integration data serviceStringgetNamespaceId(String sessionId, String name)Gets the key to an existing namespace.voidputData(String sessionId, String namespaceId, String objectId, SoapNamedValues namedValues)Adds or replaces a set of integration data values for the specified object.voidputDataByKey(String sessionId, String namespaceId, String objectId, String key, String value)Adds or replaces a single integration data value for the specified object.StringregisterNamespace(String sessionId, String name)Registers a new namespacevoidremoveData(String sessionId, String namespaceId, String objectId, String[] keys)Removes a set of integration data values from the specified object.voidremoveDataByKey(String sessionId, String namespaceId, String objectId, String key)Removes a single integration data value from the specified object.-
Methods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam
-
-
-
-
Constructor Detail
-
IntegrationDataAppSoapStub
public IntegrationDataAppSoapStub(String soapServerUrl)
-
-
Method Detail
-
registerNamespace
public String registerNamespace(String sessionId, String name) throws RemoteException
Description copied from interface:IIntegrationDataAppSoapRegisters a new namespace- Specified by:
registerNamespacein interfaceIIntegrationDataAppSoap- Parameters:
sessionId- SOAP session id.name- The name of the namespace to register- Returns:
- Integration data namespace id
- Throws:
InvalidSessionFault- when the sessionId is invalid.ObjectAlreadyExistsFault- when the specified name already existsSystemFault- when an unexpected system error occurs.RemoteException
-
getNamespaceId
public String getNamespaceId(String sessionId, String name) throws RemoteException
Description copied from interface:IIntegrationDataAppSoapGets the key to an existing namespace.- Specified by:
getNamespaceIdin interfaceIIntegrationDataAppSoap- Parameters:
sessionId- SOAP session id.name- The name of the namespace to get- Returns:
- Integration data namespace id
- Throws:
InvalidSessionFault- when the sessionId is invalid.NoSuchObjectFault- when the specified name doesn't exist.SystemFault- when an unexpected system error occurs.RemoteException
-
putData
public void putData(String sessionId, String namespaceId, String objectId, SoapNamedValues namedValues) throws RemoteException
Description copied from interface:IIntegrationDataAppSoapAdds or replaces a set of integration data values for the specified object.- Specified by:
putDatain interfaceIIntegrationDataAppSoap- Parameters:
sessionId- SOAP session id.namespaceId- The namespace to store data underobjectId- The object to associate the data withnamedValues- Key value pairs of data to associate- Throws:
InvalidSessionFault- when the sessionId is invalid.NoSuchObjectFault- when the object id doesn't existSystemFault- when an unexpected system error occurs.PermissionDeniedFault- when the user doesn't have permission to store data on the objectRemoteException
-
putDataByKey
public void putDataByKey(String sessionId, String namespaceId, String objectId, String key, String value) throws RemoteException
Description copied from interface:IIntegrationDataAppSoapAdds or replaces a single integration data value for the specified object.- Specified by:
putDataByKeyin interfaceIIntegrationDataAppSoap- Parameters:
sessionId- SOAP session id.namespaceId- The namespace to store data underobjectId- The object to associate the data withkey- The key of the piece of data to storevalue- The value to store- Throws:
InvalidSessionFault- when the sessionId is invalid.NoSuchObjectFault- when the object id doesn't existSystemFault- when an unexpected system error occurs.PermissionDeniedFault- when the user doesn't have permission to store data on the objectRemoteException
-
removeData
public void removeData(String sessionId, String namespaceId, String objectId, String[] keys) throws RemoteException
Description copied from interface:IIntegrationDataAppSoapRemoves a set of integration data values from the specified object.- Specified by:
removeDatain interfaceIIntegrationDataAppSoap- Parameters:
sessionId- SOAP session id.namespaceId- The namespace to store data underobjectId- The object to associate the data withkeys- Integration data keys (and associated values) to remove.- Throws:
InvalidSessionFault- when the sessionId is invalid.NoSuchObjectFault- when the object id doesn't existSystemFault- when an unexpected system error occurs.PermissionDeniedFault- when the user doesn't have permission to store data on the objectRemoteException
-
removeDataByKey
public void removeDataByKey(String sessionId, String namespaceId, String objectId, String key) throws RemoteException
Description copied from interface:IIntegrationDataAppSoapRemoves a single integration data value from the specified object.- Specified by:
removeDataByKeyin interfaceIIntegrationDataAppSoap- Parameters:
sessionId- SOAP session id.namespaceId- The namespace to store data underobjectId- The object to associate the data withkey- Integration data key (and associated value) to remove.- Throws:
InvalidSessionFault- when the sessionId is invalid.NoSuchObjectFault- when the object id doesn't existSystemFault- when an unexpected system error occurs.PermissionDeniedFault- when the user doesn't have permission to store data on the objectRemoteException
-
getData
public SoapNamedValues getData(String sessionId, String namespaceId, String objectId) throws RemoteException
Description copied from interface:IIntegrationDataAppSoapGets data for an object from the integration data service- Specified by:
getDatain interfaceIIntegrationDataAppSoap- Parameters:
sessionId- SOAP session id.namespaceId- The namespace to get data underobjectId- The object to get the data for- Returns:
- A SoapNamedValues collection of key/value pair stored data
- Throws:
InvalidSessionFault- when the sessionId is invalid.NoSuchObjectFault- when the object id doesn't existSystemFault- when an unexpected system error occurs.PermissionDeniedFault- when the user doesn't have permission to get data on the objectRemoteException
-
getDataByKey
public String getDataByKey(String sessionId, String namespaceId, String objectId, String key) throws RemoteException
Description copied from interface:IIntegrationDataAppSoapGets data for an object from the integration data service- Specified by:
getDataByKeyin interfaceIIntegrationDataAppSoap- Parameters:
sessionId- SOAP session id.namespaceId- The namespace to get data underobjectId- The object to get the data forkey- The key of the piece of data to retrieve- Returns:
- The value of the stored piece of data
- Throws:
InvalidSessionFault- when the sessionId is invalid.NoSuchObjectFault- when the object id doesn't existSystemFault- when an unexpected system error occurs.PermissionDeniedFault- when the user doesn't have permission to get data on the objectRemoteException
-
-