net.roboconf.dm.rest.client.delegates

Class ManagementWsDelegate

java.lang.Object

net.roboconf.dm.rest.client.delegates.ManagementWsDelegate

public class ManagementWsDelegate
extends Object

Author:

Vincent Zurczak - Linagora

Constructor Summary

Constructors

Constructor and Description
ManagementWsDelegate(com.sun.jersey.api.client.WebResource resource) Constructor.

Method Summary

Modifier and Type	Method and Description
net.roboconf.core.model.beans.Application	createApplication(String applicationName, String templateName, String templateQualifier) Creates an application from a template.
void	deleteApplication(String applicationName) Deletes an application.
void	deleteApplicationTemplate(String templateName, String templateQualifier) Deletes an application.
List<net.roboconf.core.model.beans.Application>	listApplications() Lists all the applications.
List<net.roboconf.core.model.beans.Application>	listApplications(String exactName) Lists applications.
List<net.roboconf.core.model.beans.ApplicationTemplate>	listApplicationTemplates() Lists all the application templates.
List<net.roboconf.core.model.beans.ApplicationTemplate>	listApplicationTemplates(String exactName, String exactQualifier) Lists application templates.
void	loadApplicationTemplate(File applicationFile) Uploads a ZIP file and loads its application template.
void	loadApplicationTemplate(String remoteFilePath) Loads an application template from a file which was already uploaded (and unzipped) on the DM's machine.
void	shutdownApplication(String applicationName) Shutdowns an application.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManagementWsDelegate

public ManagementWsDelegate(com.sun.jersey.api.client.WebResource resource)

Constructor.

Parameters:

resource - a web resource

Method Detail

loadApplicationTemplate

public void loadApplicationTemplate(File applicationFile)
                             throws ManagementWsException,
                                    IOException

Uploads a ZIP file and loads its application template.

Parameters:

applicationFile - a ZIP archive file

Throws:

ManagementWsException - if a problem occurred with the applications management

IOException - if the file was not found or is invalid

loadApplicationTemplate

public void loadApplicationTemplate(String remoteFilePath)
                             throws ManagementWsException

Loads an application template from a file which was already uploaded (and unzipped) on the DM's machine.

Parameters:

remoteFilePath - the file path of a directory containing the application on the DM's machine

Throws:

ManagementWsException - if a problem occurred with the applications management

listApplicationTemplates

public List<net.roboconf.core.model.beans.ApplicationTemplate> listApplicationTemplates(String exactName,
                                                                                        String exactQualifier)
                                                                                 throws ManagementWsException

Lists application templates.

Parameters:

exactName - if specified, only the templates with this name will be returned (null to match all)

We only consider the application name, not the display name. It means that the parameter should not contain special characters.

exactQualifier - the exact qualifier to search (null to match all)

Returns:

a non-null list of application templates

Throws:

ManagementWsException - if a problem occurred with the applications management

listApplicationTemplates

public List<net.roboconf.core.model.beans.ApplicationTemplate> listApplicationTemplates()
                                                                                 throws ManagementWsException

Lists all the application templates.

Equivalent to listApplicationTemplates( null, null ).

Returns:

a non-null list of application templates

Throws:

ManagementWsException - if a problem occurred with the applications management

deleteApplicationTemplate

public void deleteApplicationTemplate(String templateName,
                                      String templateQualifier)
                               throws ManagementWsException

Deletes an application.

Parameters:

templateName - the template name

templateQualifier - the template qualifier

Throws:

ManagementWsException - if a problem occurred with the applications management

createApplication

public net.roboconf.core.model.beans.Application createApplication(String applicationName,
                                                                   String templateName,
                                                                   String templateQualifier)
                                                            throws ManagementWsException

Creates an application from a template.

Parameters:

applicationName - the application name

templateName - the template's name

templateQualifier - the template's qualifier

Returns:

the created application

Throws:

ManagementWsException - if a problem occurred with the applications management

listApplications

public List<net.roboconf.core.model.beans.Application> listApplications(String exactName)
                                                                 throws ManagementWsException

Lists applications.

Parameters:

exactName - if not null, the result list will contain at most one application (with this name)

Returns:

a non-null list of applications

Throws:

ManagementWsException - if a problem occurred with the applications management

listApplications

public List<net.roboconf.core.model.beans.Application> listApplications()
                                                                 throws ManagementWsException

Lists all the applications.

Equivalent to listApplications( null ).

Returns:

a non-null list of applications

Throws:

ManagementWsException - if a problem occurred with the applications management

shutdownApplication

public void shutdownApplication(String applicationName)
                         throws ManagementWsException

Shutdowns an application.

Parameters:

applicationName - the application name

Throws:

ManagementWsException - if a problem occurred with the applications management

deleteApplication

public void deleteApplication(String applicationName)
                       throws ManagementWsException

Deletes an application.

Parameters:

applicationName - the application name

Throws:

ManagementWsException - if a problem occurred with the applications management