public class PluggableAppSoapStub extends com.collabnet.ce.soap60.webservices.ClientSoapStub implements IPluggableAppSoap
Constructor and Description |
---|
PluggableAppSoapStub(String soapServerUrl) |
Modifier and Type | Method and Description |
---|---|
PluggableComponentSoapDO |
createIntegratedApplication(String sessionId,
String plugName,
String description,
String baseUrl,
String goUrl,
String prefix,
String isScmRequired,
String requireProjPrefix,
String iconFileId,
String endPoint,
PluggableComponentParameterSoapDO[] paramDO,
String adminUrl,
PluggablePermissionSoapDO[] permSoapDO,
String pceInputType,
String pceResultFormat,
String pceDescription,
String pceTitle)
Creates a Integrated Application
|
PluggableComponent2SoapDO |
createIntegratedApplication2(String sessionId,
String plugName,
String description,
String baseUrl,
String goUrl,
String prefix,
String isScmRequired,
String requireProjPrefix,
String iconFileId,
String endPoint,
PluggableComponentParameterSoapDO[] paramDO,
String adminUrl,
PluggablePermissionSoapDO[] permSoapDO,
String isPageComponentRequired,
String pceInputType,
String pceResultFormat,
String pceDescription,
String pceTitle,
String idPattern,
String serviceType)
Creates a Integrated Application
|
PluggableComponent2SoapDO |
createIntegratedApplication3(String sessionId,
String plugName,
String description,
String baseUrl,
String goUrl,
String prefix,
String isScmRequired,
String requireProjPrefix,
String iconFileKey,
String iconFileName,
String iconMimeType,
String endPoint,
PluggableComponentParameterSoapDO[] paramDO,
String adminUrl,
PluggablePermissionSoapDO[] permSoapDO,
String isPageComponentRequired,
String pceInputType,
String pceResultFormat,
String pceDescription,
String pceTitle,
String idPattern,
String serviceType)
Creates a Integrated Application Note that the icon file has to be uploaded seperately (through FileStorageApp or SimpleFileStorageApp service) and the maximum size of the icon file is 10KB.
|
PluggableComponent3SoapDO |
createIntegratedApplication4(String sessionId,
PluggableComponent3SoapDO soapDO,
String iconFileKey,
String iconFileName,
String iconMimeType)
Creates a Integrated Application Note that the icon file has to be uploaded seperately (through FileStorageApp or SimpleFileStorageApp service) and the maximum size of the icon file is 10KB.
|
PluggableComponent4SoapDO |
createIntegratedApplication5(String sessionId,
PluggableComponent4SoapDO soapDO,
String iconFileKey,
String iconFileName,
String iconMimeType)
Creates a Integrated Application Note that the icon file has to be uploaded seperately (through FileStorageApp or SimpleFileStorageApp service) and the maximum size of the icon file is 10KB.
|
PluggableComponentSoapDO |
createIntegratedApplicationFromXMLFiles(String sessionId,
byte[] depXmlByteArray,
byte[] appXmlByteArray,
String iconFileId)
Creates/Imports an integrated application from xml files.
|
PluggableComponent2SoapDO |
createIntegratedApplicationFromXMLFiles2(String sessionId,
byte[] depXmlByteArray,
byte[] appXmlByteArray,
String iconFileId)
Create/import an integrated application from XML files.
|
PluggableComponent2SoapDO |
createIntegratedApplicationFromXMLFiles3(String sessionId,
byte[] depXmlByteArray,
byte[] appXmlByteArray,
String iconFileKey,
String iconFileName,
String iconMimeType)
Create/import an integrated application from XML files.
|
PluggableComponent3SoapDO |
createIntegratedApplicationFromXMLFiles4(String sessionId,
byte[] depXmlByteArray,
byte[] appXmlByteArray,
String iconFileKey,
String iconFileName,
String iconMimeType)
Create/import an integrated application from XML files.
|
PluggableComponent4SoapDO |
createIntegratedApplicationFromXMLFiles5(String sessionId,
byte[] depXmlByteArray,
byte[] appXmlByteArray,
String iconFileKey,
String iconFileName,
String iconMimeType)
Create/import an integrated application from XML files.
|
void |
editIntegratedApplication(String sessionId,
PluggableComponentSoapDO soapDO)
Edits the Integrated Application for the giving PluggableComponentSoapDO
|
void |
editIntegratedApplication2(String sessionId,
PluggableComponent2SoapDO soapDO)
Edit the integrated application properties.
|
void |
editIntegratedApplication3(String sessionId,
PluggableComponent3SoapDO soapDO)
Edit the integrated application properties.
|
void |
editIntegratedApplication4(String sessionId,
PluggableComponent4SoapDO soapDO)
Edit the integrated application properties.
|
void |
editIntegratedApplicationFromXMLFiles(String sessionId,
String integratedAppId,
byte[] depXmlByteArray,
byte[] appXmlByteArray,
String iconFileId)
Edit integrated application from xml files.
|
com.collabnet.ce.soap60.types.SoapNamedValues |
editProjectConfigurationParameters(String sessionId,
String projectId,
PluggableComponentParameterSoapDO[] paramDO)
Edits project specific configuration parameters of a pluggable application.
|
com.collabnet.ce.soap60.types.SoapNamedValues |
editProjectConfigurationParameters2(String sessionId,
String integratedAppId,
String projectId,
PluggableComponentParameterSoapDO[] paramDO)
Edit the project specific configuration parameters of an integrated application.
|
com.collabnet.ce.soap60.types.SoapNamedValues |
enablePluggableComponent(String sessionId,
String projectID,
String pluggableId,
PluggableComponentParameterSoapDO[] params,
String prefix)
Adds a pluggable application to a project
|
String |
getBaseUrlByLinkId(String sessionId,
String linkId)
Get the project integrated application's base URL.
|
PluggableComponentSoapDO |
getIntegratedApplicationByName(String sessionId,
String plugName)
Returns the PluggableComponentSoapDO object for the given Integrated Application Name
|
PluggableComponent2SoapDO |
getIntegratedApplicationByName2(String sessionId,
String integratedAppName)
Get the integrated application for a given name.
|
PluggableComponent3SoapDO |
getIntegratedApplicationByName3(String sessionId,
String integratedAppName)
Get the integrated application for a given name.
|
PluggableComponent4SoapDO |
getIntegratedApplicationByName4(String sessionId,
String integratedAppName)
Get the integrated application for a given name.
|
String[] |
getIntegratedAppPrefixes(String sessionId)
Gets the list of Integrated App Prefixes.
|
String |
getLinkPlugId(String sessionId,
String projectPath,
String baseUrl)
Gets the link id for the specified project and base URL.
|
String |
getLinkPlugIdByPlugId(String sessionId,
String projectId,
String pluggableId)
Get the integrated application id for the specified project and base URL.
|
String |
getPlugIdByBaseUrl(String sessionId,
String baseUrl)
Gets integrated application id for the given base URL
|
PluggableComponentParameterSoapDO[] |
getProjectConfigParameterData(String sessionId,
String linkId)
Gets project specific configuration parameters for a pluggable application.
|
String |
getProjectPathByIntegratedAppId(String sessionId,
String linkId)
Get the project path for the given integrated application id.
|
String |
getProjectPrefix(String sessionId,
String linkId)
Get the project prefix for an integrated application.
|
PluggableComponentSoapList |
listPluggableComponents(String sessionId)
Gets the list of integrated applications in the site.
|
PluggableComponent2SoapList |
listPluggableComponents2(String sessionId)
Gets the list of integrated applications in the site.
|
PluggableComponent2SoapList |
listPluggableComponentsByCategory(String sessionId,
String category)
Gets the list of integrated applications in the site based on the category.
|
LinkPluggableComponentSoapList |
listPluggableComponentsForProject(String sessionId,
String projectId)
Lists Pluggable Components.
|
void |
removeProjectIntegratedApplication(String sessionId,
String linkId)
Removes integrated application from a project.
|
void |
setIntegratedApplicationIcon(String sessionId,
String integratedAppId,
String iconFileKey,
String iconFileName,
String iconMimeType)
Sets new icon for specified integrated application
|
void |
setPluggableAppMessageResource(String sessionId,
String pluggableId,
String locale,
String key,
String value)
Creates / Updates the Pluggable App Message resource
|
void |
updateRecentAccess(String userId,
String objectId)
Updates the recent access entries for the user.
|
public PluggableAppSoapStub(String soapServerUrl)
public PluggableComponentSoapList listPluggableComponents(String sessionId) throws RemoteException
IPluggableAppSoap
listPluggableComponents
in interface IPluggableAppSoap
sessionId
- UserSession ID.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public PluggableComponent2SoapList listPluggableComponents2(String sessionId) throws RemoteException
IPluggableAppSoap
listPluggableComponents2
in interface IPluggableAppSoap
sessionId
- UserSession ID.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public PluggableComponent2SoapList listPluggableComponentsByCategory(String sessionId, String category) throws RemoteException
IPluggableAppSoap
listPluggableComponentsByCategory
in interface IPluggableAppSoap
sessionId
- UserSession ID.category
- category of the integrated application.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public com.collabnet.ce.soap60.types.SoapNamedValues enablePluggableComponent(String sessionId, String projectID, String pluggableId, PluggableComponentParameterSoapDO[] params, String prefix) throws RemoteException
IPluggableAppSoap
enablePluggableComponent
in interface IPluggableAppSoap
sessionId
- UserSession ID.projectID
- Project ID project to which the pluggable app should be added.pluggableId
- pluggable application that should be added to a projectparams
- Param Array of PluggableComponentParameter Valuesprefix
- the pluggablecomponent prefixcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project/integrated appln. id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.IntegratedAppDisabledFault
- thrown when the integrated application is disabled from addition to projectsRemoteException
public PluggableComponentParameterSoapDO[] getProjectConfigParameterData(String sessionId, String linkId) throws RemoteException
IPluggableAppSoap
getProjectConfigParameterData
in interface IPluggableAppSoap
sessionId
- UserSession ID.linkId
- the link id between a pluggable application and a projectcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project integrated appln. id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public com.collabnet.ce.soap60.types.SoapNamedValues editProjectConfigurationParameters(String sessionId, String projectId, PluggableComponentParameterSoapDO[] paramDO) throws RemoteException
IPluggableAppSoap
editProjectConfigurationParameters
in interface IPluggableAppSoap
sessionId
- UserSession ID.projectId
- project in which the pluggable application resides.paramDO
- project specific configuration parameters for a pluggable applicationcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id or the configuration params is invalid.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
public com.collabnet.ce.soap60.types.SoapNamedValues editProjectConfigurationParameters2(String sessionId, String integratedAppId, String projectId, PluggableComponentParameterSoapDO[] paramDO) throws RemoteException
IPluggableAppSoap
getProjectConfigParameterData
to get the existing configuration parameters.editProjectConfigurationParameters2
in interface IPluggableAppSoap
sessionId
- Soap session IDintegratedAppId
- integrated application IDprojectId
- project in which the integrated application residesparamDO
- project specific configuration parameters of an integrated applicationcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown if given project id or the configuration parameter is invalid.com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown if the soap session is invalid.com.collabnet.ce.soap60.fault.SystemFault
- thrown on the occurrence of an unexpected system level error.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown if the user has insufficient privileges.RemoteException
public void removeProjectIntegratedApplication(String sessionId, String linkId) throws RemoteException
IPluggableAppSoap
removeProjectIntegratedApplication
in interface IPluggableAppSoap
sessionId
- UserSession ID.linkId
- project pluggable application idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project integrated appln. id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public LinkPluggableComponentSoapList listPluggableComponentsForProject(String sessionId, String projectId) throws RemoteException
IPluggableAppSoap
listPluggableComponentsForProject
in interface IPluggableAppSoap
sessionId
- UserSession ID.projectId
- Project ID.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public String getLinkPlugId(String sessionId, String projectPath, String baseUrl) throws RemoteException
IPluggableAppSoap
getLinkPlugId
in interface IPluggableAppSoap
sessionId
- UserSession ID.projectPath
- the project pathbaseUrl
- integrated application base URLcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown when an association between the integrated application and the project does not existcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
public String getProjectPathByIntegratedAppId(String sessionId, String linkId) throws RemoteException
IPluggableAppSoap
getProjectPathByIntegratedAppId
in interface IPluggableAppSoap
sessionId
- UserSession ID.linkId
- linkId id of integrated application id/prpl idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified integrated application id is invalidcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
public String getBaseUrlByLinkId(String sessionId, String linkId) throws RemoteException
IPluggableAppSoap
getBaseUrlByLinkId
in interface IPluggableAppSoap
sessionId
- UserSession ID.linkId
- project integrated application id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified integrated application id is invalidcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
public String getPlugIdByBaseUrl(String sessionId, String baseUrl) throws RemoteException
IPluggableAppSoap
getPlugIdByBaseUrl
in interface IPluggableAppSoap
sessionId
- UserSession ID.baseUrl
- integrated application base URLcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.RemoteException
public PluggableComponentSoapDO createIntegratedApplication(String sessionId, String plugName, String description, String baseUrl, String goUrl, String prefix, String isScmRequired, String requireProjPrefix, String iconFileId, String endPoint, PluggableComponentParameterSoapDO[] paramDO, String adminUrl, PluggablePermissionSoapDO[] permSoapDO, String pceInputType, String pceResultFormat, String pceDescription, String pceTitle) throws RemoteException
IPluggableAppSoap
createIntegratedApplication
in interface IPluggableAppSoap
sessionId
- the soap session IDplugName
- the integratedApp Namedescription
- the integratedApp descriptionbaseUrl
- the app's baseUrlgoUrl
- the goUrlprefix
- the app's prefixisScmRequired
- the isScmRequiredrequireProjPrefix
- the project prefixiconFileId
- the iconfileIdendPoint
- the endPointparamDO
- the PluggableComponentParameterSoapDOadminUrl
- url for integrated app. site administration. the PluggableComponentParameterSoapDOpermSoapDO
- the PluggablePermissionSoapDOpceInputType
- pceInputType of integrated apppceResultFormat
- pceResultFormat of integrated apppceDescription
- pceDescription of integrated apppceTitle
- pceTitle of integrated appPluggableComponentSoapDO
of the created applicationcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
com.collabnet.ce.soap60.fault.IllegalArgumentFault
com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
RemoteException
public PluggableComponent2SoapDO createIntegratedApplication2(String sessionId, String plugName, String description, String baseUrl, String goUrl, String prefix, String isScmRequired, String requireProjPrefix, String iconFileId, String endPoint, PluggableComponentParameterSoapDO[] paramDO, String adminUrl, PluggablePermissionSoapDO[] permSoapDO, String isPageComponentRequired, String pceInputType, String pceResultFormat, String pceDescription, String pceTitle, String idPattern, String serviceType) throws RemoteException
IPluggableAppSoap
createIntegratedApplication2
in interface IPluggableAppSoap
sessionId
- the soap session IDplugName
- the integratedApp Namedescription
- the integratedApp descriptionbaseUrl
- the app's baseUrlgoUrl
- the goUrlprefix
- the app's prefixisScmRequired
- the isScmRequiredrequireProjPrefix
- the project prefixiconFileId
- the iconfileIdendPoint
- the endPointparamDO
- the PluggableComponentParameterSoapDOadminUrl
- url for integrated app. site administration.permSoapDO
- the PluggablePermissionSoapDOpceInputType
- pceInputType of integrated apppceResultFormat
- pceResultFormat of integrated apppceDescription
- pceDescription of integrated apppceTitle
- pceTitle of integrated appidPattern
- Regular expression for the object id which used for creating association links.serviceType
- The service type REST / SOAPPluggableComponent2SoapDO
of the created applicationcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
com.collabnet.ce.soap60.fault.IllegalArgumentFault
com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
RemoteException
public PluggableComponent2SoapDO createIntegratedApplication3(String sessionId, String plugName, String description, String baseUrl, String goUrl, String prefix, String isScmRequired, String requireProjPrefix, String iconFileKey, String iconFileName, String iconMimeType, String endPoint, PluggableComponentParameterSoapDO[] paramDO, String adminUrl, PluggablePermissionSoapDO[] permSoapDO, String isPageComponentRequired, String pceInputType, String pceResultFormat, String pceDescription, String pceTitle, String idPattern, String serviceType) throws RemoteException
IPluggableAppSoap
createIntegratedApplication3
in interface IPluggableAppSoap
sessionId
- the soap session IDplugName
- the integratedApp Namedescription
- the integratedApp descriptionbaseUrl
- the app's baseUrlgoUrl
- the goUrlprefix
- the app's prefixisScmRequired
- the isScmRequiredrequireProjPrefix
- the project prefixiconFileKey
- the uploaded icon file key (through FileStorageApp or SimpleFileStorageApp service)iconFileName
- the icon file nameiconMimeType
- the mime-type of the icon (supported icon file formats are GIF/JPEG/PNG)endPoint
- the endPointparamDO
- the PluggableComponentParameterSoapDOadminUrl
- url for integrated app. site administration.permSoapDO
- the PluggablePermissionSoapDOpceInputType
- pceInputType of integrated apppceResultFormat
- pceResultFormat of integrated apppceDescription
- pceDescription of integrated apppceTitle
- pceTitle of integrated appidPattern
- Regular expression for the object id which used for creating association links.serviceType
- The service type REST / SOAPPluggableComponent2SoapDO
of the created applicationcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
com.collabnet.ce.soap60.fault.IllegalArgumentFault
com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
com.collabnet.ce.soap60.fault.SystemFault
com.collabnet.ce.soap60.fault.NoSuchObjectFault
RemoteException
public PluggableComponent3SoapDO createIntegratedApplication4(String sessionId, PluggableComponent3SoapDO soapDO, String iconFileKey, String iconFileName, String iconMimeType) throws RemoteException
IPluggableAppSoap
createIntegratedApplication4
in interface IPluggableAppSoap
sessionId
- the soap session IDsoapDO
- a PluggableComponent3SoapDO
with integrated application propertiesiconFileKey
- the uploaded icon file key (through FileStorageApp or SimpleFileStorageApp service)iconFileName
- the icon file nameiconMimeType
- the mime-type of the icon (supported icon file formats are GIF/JPEG/PNG)PluggableComponent3SoapDO
of the created applicationcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
com.collabnet.ce.soap60.fault.IllegalArgumentFault
com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
com.collabnet.ce.soap60.fault.SystemFault
com.collabnet.ce.soap60.fault.NoSuchObjectFault
RemoteException
public PluggableComponent4SoapDO createIntegratedApplication5(String sessionId, PluggableComponent4SoapDO soapDO, String iconFileKey, String iconFileName, String iconMimeType) throws RemoteException
IPluggableAppSoap
createIntegratedApplication5
in interface IPluggableAppSoap
sessionId
- the soap session IDsoapDO
- a PluggableComponent4SoapDO
with integrated application propertiesiconFileKey
- the uploaded icon file key (through FileStorageApp or SimpleFileStorageApp service)iconFileName
- the icon file nameiconMimeType
- the mime-type of the icon (supported icon file formats are GIF/JPEG/PNG)PluggableComponent4SoapDO
of the created applicationcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
com.collabnet.ce.soap60.fault.IllegalArgumentFault
com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
com.collabnet.ce.soap60.fault.SystemFault
com.collabnet.ce.soap60.fault.NoSuchObjectFault
RemoteException
public PluggableComponentSoapDO createIntegratedApplicationFromXMLFiles(String sessionId, byte[] depXmlByteArray, byte[] appXmlByteArray, String iconFileId) throws RemoteException
IPluggableAppSoap
createIntegratedApplicationFromXMLFiles
in interface IPluggableAppSoap
sessionId
- user session iddepXmlByteArray
- integrated app deployment xml byte arrayappXmlByteArray
- integrated app application xml byte arrayiconFileId
- icon file id, should be a StoredFileKey idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown when the user does not have the permission to perform this operationcom.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- thrown when an application by the same name/prefix/baseurl existcom.collabnet.ce.soap60.fault.SystemFault
- thrown when the content/syntax of the XML is invalid or any other system errorRemoteException
public PluggableComponent2SoapDO createIntegratedApplicationFromXMLFiles2(String sessionId, byte[] depXmlByteArray, byte[] appXmlByteArray, String iconFileId) throws RemoteException
IPluggableAppSoap
createIntegratedApplicationFromXMLFiles2
in interface IPluggableAppSoap
sessionId
- soap session IDdepXmlByteArray
- integrated application deployment XML byte arrayappXmlByteArray
- integrated application application XML byte arrayiconFileId
- icon file id, should be a StoredFileKey idPluggableComponent2SoapDO
for the integrated application that was just created.com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown when the user does not have the permission to perform this operationcom.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- thrown when an application by the same name/prefix/baseurl existcom.collabnet.ce.soap60.fault.SystemFault
- thrown when the content/syntax of the XML is invalid or any other system errorRemoteException
public PluggableComponent2SoapDO createIntegratedApplicationFromXMLFiles3(String sessionId, byte[] depXmlByteArray, byte[] appXmlByteArray, String iconFileKey, String iconFileName, String iconMimeType) throws RemoteException
IPluggableAppSoap
createIntegratedApplicationFromXMLFiles3
in interface IPluggableAppSoap
sessionId
- soap session IDdepXmlByteArray
- integrated application deployment XML byte arrayappXmlByteArray
- integrated application application XML byte arrayiconFileKey
- the uploaded icon file key (through FileStorageApp or SimpleFileStorageApp service)iconFileName
- the name of the icon fileiconMimeType
- the mime-type of the icon file (supported icon file formats are GIF/JPEG/PNG)PluggableComponent2SoapDO
for the integrated application that was just created.com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown when the user does not have the permission to perform this operationcom.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- thrown when an application by the same name/prefix/baseurl existcom.collabnet.ce.soap60.fault.SystemFault
- thrown when the content/syntax of the XML is invalid or any other system errorcom.collabnet.ce.soap60.fault.IllegalArgumentFault
com.collabnet.ce.soap60.fault.NoSuchObjectFault
RemoteException
public PluggableComponent3SoapDO createIntegratedApplicationFromXMLFiles4(String sessionId, byte[] depXmlByteArray, byte[] appXmlByteArray, String iconFileKey, String iconFileName, String iconMimeType) throws RemoteException
IPluggableAppSoap
createIntegratedApplicationFromXMLFiles4
in interface IPluggableAppSoap
sessionId
- soap session IDdepXmlByteArray
- integrated application deployment XML byte arrayappXmlByteArray
- integrated application application XML byte arrayiconFileKey
- the uploaded icon file key (through FileStorageApp or SimpleFileStorageApp service)iconFileName
- the name of the icon fileiconMimeType
- the mime-type of the icon file (supported icon file formats are GIF/JPEG/PNG)PluggableComponent3SoapDO
for the integrated application that was just created.com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown when the user does not have the permission to perform this operationcom.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- thrown when an application by the same name/prefix/baseurl existcom.collabnet.ce.soap60.fault.SystemFault
- thrown when the content/syntax of the XML is invalid or any other system errorcom.collabnet.ce.soap60.fault.IllegalArgumentFault
com.collabnet.ce.soap60.fault.NoSuchObjectFault
RemoteException
public PluggableComponent4SoapDO createIntegratedApplicationFromXMLFiles5(String sessionId, byte[] depXmlByteArray, byte[] appXmlByteArray, String iconFileKey, String iconFileName, String iconMimeType) throws RemoteException
IPluggableAppSoap
createIntegratedApplicationFromXMLFiles5
in interface IPluggableAppSoap
sessionId
- soap session IDdepXmlByteArray
- integrated application deployment XML byte arrayappXmlByteArray
- integrated application application XML byte arrayiconFileKey
- the uploaded icon file key (through FileStorageApp or SimpleFileStorageApp service)iconFileName
- the name of the icon fileiconMimeType
- the mime-type of the icon file (supported icon file formats are GIF/JPEG/PNG)PluggableComponent4SoapDO
for the integrated application that was just created.com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown when the user does not have the permission to perform this operationcom.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- thrown when an application by the same name/prefix/baseurl existcom.collabnet.ce.soap60.fault.SystemFault
- thrown when the content/syntax of the XML is invalid or any other system errorcom.collabnet.ce.soap60.fault.IllegalArgumentFault
com.collabnet.ce.soap60.fault.NoSuchObjectFault
RemoteException
public PluggableComponentSoapDO getIntegratedApplicationByName(String sessionId, String plugName) throws RemoteException
IPluggableAppSoap
getIntegratedApplicationByName
in interface IPluggableAppSoap
sessionId
- the soap sessionidplugName
- the Integrated App Namecom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the session is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
public PluggableComponent2SoapDO getIntegratedApplicationByName2(String sessionId, String integratedAppName) throws RemoteException
IPluggableAppSoap
getIntegratedApplicationByName2
in interface IPluggableAppSoap
sessionId
- soap session IDintegratedAppName
- integrated application namePluggableComponent2SoapDO
for a given integrated application namecom.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the soap session is invalidcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown if the given integrated application name does not existRemoteException
public PluggableComponent3SoapDO getIntegratedApplicationByName3(String sessionId, String integratedAppName) throws RemoteException
IPluggableAppSoap
getIntegratedApplicationByName3
in interface IPluggableAppSoap
sessionId
- soap session IDintegratedAppName
- integrated application namePluggableComponent3SoapDO
for a given integrated application namecom.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the soap session is invalidcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown if the given integrated application name does not existRemoteException
public PluggableComponent4SoapDO getIntegratedApplicationByName4(String sessionId, String integratedAppName) throws RemoteException
IPluggableAppSoap
getIntegratedApplicationByName4
in interface IPluggableAppSoap
sessionId
- soap session IDintegratedAppName
- integrated application namePluggableComponent4SoapDO
for a given integrated application namecom.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the soap session is invalidcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown if the given integrated application name does not existRemoteException
public void editIntegratedApplication(String sessionId, PluggableComponentSoapDO soapDO) throws RemoteException
IPluggableAppSoap
editIntegratedApplication
in interface IPluggableAppSoap
sessionId
- the soap sessionIdsoapDO
- the PluggableComponentSoapDOcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when current user doesn't have enough permissioncom.collabnet.ce.soap60.fault.IllegalArgumentFault
- when given PluggableComponetSoapDO has invalid valuecom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the integrated app with the given details does not exists.RemoteException
public void editIntegratedApplication2(String sessionId, PluggableComponent2SoapDO soapDO) throws RemoteException
IPluggableAppSoap
editIntegratedApplication2
in interface IPluggableAppSoap
sessionId
- soap session IDsoapDO
- a PluggableComponent2SoapDO
with the properties to be edited.com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown if the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown if the user has insufficient privilegescom.collabnet.ce.soap60.fault.IllegalArgumentFault
- thrown if application properties are invalidcom.collabnet.ce.soap60.fault.SystemFault
- thrown if there is an error when marshaling the SOAP objectcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown if an integrated application with the given details does not existsRemoteException
public void editIntegratedApplication3(String sessionId, PluggableComponent3SoapDO soapDO) throws RemoteException
IPluggableAppSoap
editIntegratedApplication3
in interface IPluggableAppSoap
sessionId
- soap session IDsoapDO
- a PluggableComponent3SoapDO
with the properties to be edited.com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown if the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown if the user has insufficient privilegescom.collabnet.ce.soap60.fault.IllegalArgumentFault
- thrown if application properties are invalidcom.collabnet.ce.soap60.fault.SystemFault
- thrown if there is an error when marshaling the SOAP objectcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown if an integrated application with the given details does not existsRemoteException
public void editIntegratedApplication4(String sessionId, PluggableComponent4SoapDO soapDO) throws RemoteException
IPluggableAppSoap
editIntegratedApplication4
in interface IPluggableAppSoap
sessionId
- soap session IDsoapDO
- a PluggableComponent4SoapDO
with the properties to be edited.com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown if the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown if the user has insufficient privilegescom.collabnet.ce.soap60.fault.IllegalArgumentFault
- thrown if application properties are invalidcom.collabnet.ce.soap60.fault.SystemFault
- thrown if there is an error when marshaling the SOAP objectcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown if an integrated application with the given details does not existsRemoteException
public void editIntegratedApplicationFromXMLFiles(String sessionId, String integratedAppId, byte[] depXmlByteArray, byte[] appXmlByteArray, String iconFileId) throws RemoteException
IPluggableAppSoap
editIntegratedApplicationFromXMLFiles
in interface IPluggableAppSoap
sessionId
- user session iddepXmlByteArray
- integrated app deployment xml byte arrayappXmlByteArray
- integrated app application xml byte arrayiconFileId
- icon file id, should be a StoredFileKey idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown when the user does not have the permission to perform this operationcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown when an application doesn not exists with the given idcom.collabnet.ce.soap60.fault.SystemFault
- thrown when the content/syntax of the XML is invalid or any other system errorRemoteException
public void setIntegratedApplicationIcon(String sessionId, String integratedAppId, String iconFileKey, String iconFileName, String iconMimeType) throws RemoteException
IPluggableAppSoap
setIntegratedApplicationIcon
in interface IPluggableAppSoap
sessionId
- soap session IDintegratedAppId
- integrated application for which the icon to be seticonFileKey
- the uploaded icon file key (through FileStorageApp or SimpleFileStorageApp service).iconFileName
- the icon file nameiconMimeType
- the mime-type of the icon (supported icon file formats are GIF/JPEG/PNG and the maximum size of the icon file is 10KB)com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown when the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown when the user does not have the permission to perform this operationcom.collabnet.ce.soap60.fault.SystemFault
- thrown when the content/syntax of the XML is invalid or any other system errorcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- thrown if any of the parameters is not setcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown when the specified integrated application does not exist.RemoteException
public String getLinkPlugIdByPlugId(String sessionId, String projectId, String pluggableId) throws RemoteException
IPluggableAppSoap
getLinkPlugIdByPlugId
in interface IPluggableAppSoap
sessionId
- UserSession ID.projectId
- the project IDpluggableId
- integrated application ID.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
public String getProjectPrefix(String sessionId, String linkId) throws RemoteException
IPluggableAppSoap
getProjectPrefix
in interface IPluggableAppSoap
sessionId
- UserSession Id.linkId
- , integrated application link idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified integrated application does not exist.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
public void updateRecentAccess(String userId, String objectId) throws RemoteException
IPluggableAppSoap
updateRecentAccess
in interface IPluggableAppSoap
userId
- user who recently accessed this objectobjectId
- recently accessed object id of the form glpl_prplXXXX_prefix_objectId_objectTitlecom.collabnet.ce.soap60.fault.IllegalArgumentFault
- thrown when the objectId is invalidRemoteException
public String[] getIntegratedAppPrefixes(String sessionId) throws RemoteException
IPluggableAppSoap
getIntegratedAppPrefixes
in interface IPluggableAppSoap
sessionId
- the Session id of the usercom.collabnet.ce.soap60.fault.InvalidSessionFault
- when session is invalidRemoteException
public void setPluggableAppMessageResource(String sessionId, String pluggableId, String locale, String key, String value) throws RemoteException
IPluggableAppSoap
setPluggableAppMessageResource
in interface IPluggableAppSoap
pluggableId
- The Pluggable Id for which this message resource to be createdlocale
- The Localekey
- The Resource Keyvalue
- The Resource Valuecom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
Copyright © 2016 CollabNet. All Rights Reserved.