org.figure8.join.services.remoting
Interface ProcessControlService

All Superinterfaces:

AuthenticatedService, java.rmi.Remote

All Known Implementing Classes:

ProcessControlServiceImpl

public interface ProcessControlService
extends AuthenticatedService

Remote service interface definition. This service allows you to monitor and control the different process managed by the Join application. Such process are : the construction of an Assembly, the deployments on integration environments and the construction of a Build. Typically, this service is called by scripts executing these process and reporting success/failures by setting Status upon this artifacts and process.
All this service methods require authentication through the usage of the login() method. The security token returned by this method should then be used as a parameter of every service call.

Version:

$Revision: 1.1 $

Author:

Laurent Broudoux

Method Summary

RemoteStatus	getAssemblyStatus(java.lang.String token, java.lang.String key) Retrieve the status of a specified Assembly.
RemoteStatus	getBuildStatus(java.lang.String token, java.lang.String key) Retrieve the status of a specified Build.
RemoteStatus	getDeploymentStatus(java.lang.String token, long deploymentId) Retrieve the status of a specified Deployment.
void	setAssemblyStatus(java.lang.String token, java.lang.String statusKey, java.lang.String assemblyKey) Set the specified status to a specified Assembly.
void	setBuildStatus(java.lang.String token, java.lang.String statusKey, java.lang.String buildKey) Set the specified status to a specified Build.
void	setDeploymentStatus(java.lang.String token, java.lang.String statusKey, long deploymentId) Set the specified status to a specified Deployment.

Methods inherited from interface org.figure8.join.services.remoting.AuthenticatedService

login, logout

Method Detail

getBuildStatus

RemoteStatus getBuildStatus(java.lang.String token,
                            java.lang.String key)
                            throws InvalidSessionException,
                                   java.rmi.RemoteException

Retrieve the status of a specified Build.

Parameters:

token - Authentication token provided earlier by login() method

key - The unique key identifier of Build to retrieve status for

Returns:

A RemoteStatus corresponding to status of build identified by key

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

setBuildStatus

void setBuildStatus(java.lang.String token,
                    java.lang.String statusKey,
                    java.lang.String buildKey)
                    throws InvalidSessionException,
                           java.rmi.RemoteException

Set the specified status to a specified Build.

Parameters:

token - Authentication token provided earlier by login() method

statusKey - Unique key idenitifer of the status to set to build

buildKey - The unique key idenitifer of Build to update status

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

getAssemblyStatus

RemoteStatus getAssemblyStatus(java.lang.String token,
                               java.lang.String key)
                               throws InvalidSessionException,
                                      java.rmi.RemoteException

Retrieve the status of a specified Assembly.

Parameters:

token - Authentication token provided earlier by login() method

key - The unique key identifier of Assembly to retrieve status for

Returns:

A RemoteStatus corresponding to status of assembly identified by key

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

setAssemblyStatus

void setAssemblyStatus(java.lang.String token,
                       java.lang.String statusKey,
                       java.lang.String assemblyKey)
                       throws InvalidSessionException,
                              java.rmi.RemoteException

Set the specified status to a specified Assembly.

Parameters:

token - Authentication token provided earlier by login() method

statusKey - Unique key idenitifer of the status to set to assembly

assemblyKey - The unique key idenitifer of Assembly to update status

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

getDeploymentStatus

RemoteStatus getDeploymentStatus(java.lang.String token,
                                 long deploymentId)
                                 throws InvalidSessionException,
                                        java.rmi.RemoteException

Retrieve the status of a specified Deployment.

Parameters:

token - Authentication token provided earlier by login() method

deploymentId - The unique identifier of Deployment to retrieve status for

Returns:

A RemoteStatus corresponding to status of deployment identified by deploymentId

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

setDeploymentStatus

void setDeploymentStatus(java.lang.String token,
                         java.lang.String statusKey,
                         long deploymentId)
                         throws InvalidSessionException,
                                java.rmi.RemoteException

Set the specified status to a specified Deployment.

Parameters:

token - Authentication token provided earlier by login() method

statusKey - Unique key idenitifer of the status to set to deployment

deploymentId - The unique identifier of Deployment to retrieve status for

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation