org.figure8.join.services.remoting
Interface ArtifactService

All Superinterfaces:
AuthenticatedService, java.rmi.Remote
All Known Implementing Classes:
ArtifactServiceImpl

public interface ArtifactService
extends AuthenticatedService

Remote service interface definition. This service allows to interact with project artifacts managed by the Join application. All this service requires 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.2 $
Author:
Laurent Broudoux

Method Summary
 void bindComponent(java.lang.String token, RemoteComponent component, java.lang.String assemblyKey)
          Bind a component to a given assembly.
 RemoteDeliverableType[] getDeliverableTypes(java.lang.String token)
          Retrieve all the deliverable categories (or types) managed within the project.
 RemoteDeliverableType[] getDeliverableTypesForDelivery(java.lang.String token)
          Get the deliverable categories where authenticated user can supply deliverables for.
 RemoteRelease[] getReleases(java.lang.String token)
          Retrieve all the releases managed within the project.
 void supplyDeliverable(java.lang.String token, RemoteDeliverable deliverable, java.io.File content)
          Supply a new deliverable using the remote wrapper.
 
Methods inherited from interface org.figure8.join.services.remoting.AuthenticatedService
login, logout
 

Method Detail

getReleases

RemoteRelease[] getReleases(java.lang.String token)
                            throws InvalidSessionException,
                                   java.rmi.RemoteException
Retrieve all the releases managed within the project.

Parameters:
token - Authentication token provided earlier by login() method
Returns:
An array of RemoteRelease objects
Throws:
InvalidSessionException - if user has no valid session on server-side
java.rmi.RemoteException - if an exception occurs during the remote conversation

getDeliverableTypes

RemoteDeliverableType[] getDeliverableTypes(java.lang.String token)
                                            throws InvalidSessionException,
                                                   java.rmi.RemoteException
Retrieve all the deliverable categories (or types) managed within the project.

Parameters:
token - Authentication token provided earlier by login() method
Returns:
An array of RemoteDeliverableType objects
Throws:
InvalidSessionException - if user has no valid session on server-side
java.rmi.RemoteException - if an exception occurs during the remote conversation

getDeliverableTypesForDelivery

RemoteDeliverableType[] getDeliverableTypesForDelivery(java.lang.String token)
                                                       throws InvalidSessionException,
                                                              java.rmi.RemoteException
Get the deliverable categories where authenticated user can supply deliverables for.

Parameters:
token - Authentication token provided earlier by login() method
Returns:
An array of authorized RemoteDeliverableType objects for deliverables supplying
Throws:
InvalidSessionException - if user has no valid session on server-side
java.rmi.RemoteException - if an exception occurs during the remote conversation

supplyDeliverable

void supplyDeliverable(java.lang.String token,
                       RemoteDeliverable deliverable,
                       java.io.File content)
                       throws InvalidParameterException,
                              DuplicateEntityException,
                              InvalidSessionException,
                              java.rmi.RemoteException
Supply a new deliverable using the remote wrapper. This wrapper must contains release and type informations. This delivery may include a File object as deliverable content if deliverables from this type are not retrieved using direct VCS or SCM connection.

Parameters:
token - Authentication token provided earlier by login() method
deliverable - The remote wrapper for deliverable to create into Join
content - The deliverable content if not VCS dleiverable
Throws:
InvalidParameterException - if deliverable is already registered or parameter is missing
DuplicateEntityException - if another deliverable with same key already exists
InvalidSessionException - if user has no valid session on server-side
java.rmi.RemoteException - if an exception occurs during the remote conversation

bindComponent

void bindComponent(java.lang.String token,
                   RemoteComponent component,
                   java.lang.String assemblyKey)
                   throws InvalidParameterException,
                          InvalidSessionException,
                          java.rmi.RemoteException
Bind a component to a given assembly.

Parameters:
token - Authentication token provided earlier by login() method
component - The remote wrapper for component to bind to assembly/build
assemblyKey - The key of assembly to bind component to
Throws:
InvalidParameterException - if parameter is missing
InvalidSessionException - if user has no valid session on server-side
java.rmi.RemoteException - if an exception occurs during the remote conversation


Copyright © 2005-2008 Join. All Rights Reserved.