org.ligoj.app.plugin.req.squash

Class SquashPluginResource

java.lang.Object

org.ligoj.app.resource.plugin.AbstractToolPluginResource

org.ligoj.app.plugin.req.squash.SquashPluginResource

All Implemented Interfaces:

Comparable<org.ligoj.app.api.FeaturePlugin>, org.ligoj.app.api.FeaturePlugin, org.ligoj.app.api.ServicePlugin, org.ligoj.app.api.ToolPlugin, org.ligoj.app.plugin.req.ReqServicePlugin

@Path(value="/service/req/squash")
 @Service
 @Produces(value="application/json")
public class SquashPluginResource
extends org.ligoj.app.resource.plugin.AbstractToolPluginResource
implements org.ligoj.app.plugin.req.ReqServicePlugin

Squash TM resource.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY Plug-in key.
static String	PARAMETER_PASSWORD Squash TM user password able to connect to instance.
static String	PARAMETER_PROJECT Squash TM project's identifier, an integer
static String	PARAMETER_URL Web site URL
static String	PARAMETER_USER Squash TM user name able to connect to instance.
static String	URL Plug-in key.

Fields inherited from class org.ligoj.app.resource.plugin.AbstractToolPluginResource

nodeResource, subscriptionRepository, subscriptionResource

Constructor Summary

Constructors

Constructor and Description
SquashPluginResource()

Method Summary

Modifier and Type	Method and Description
boolean	checkStatus(Map<String,String> parameters)
org.ligoj.app.api.SubscriptionStatusWithData	checkSubscriptionStatus(Map<String,String> parameters)
List<SquashProject>	findAllByName(String node, String criteria) Search the Squash TM the projects matching to the given criteria.
String	getKey()
String	getLastVersion()
protected SquashProject	getProject(Map<String,String> parameters, int id) Return Squash project from its identifier.
protected List<SquashProject>	getProjects(Map<String,String> parameters) Return all Squash TM projects without limit.
protected List<SquashProject>	getProjectsDataTables(Map<String,String> parameters, String criteria) Return all Squash TM projects without limit and an optional criteria.
protected String	getResource(org.ligoj.app.resource.plugin.CurlProcessor processor, Map<String,String> parameters, String url, String resource) Return a Squash's resource.
protected String	getResource(Map<String,String> parameters, String resource) Return a Squash's resource.
String	getVersion(Map<String,String> parameters)
void	link(int subscription)
javax.ws.rs.core.Response	redirect(int subscription) Redirect to the home page of the linked project.
protected String	validateAdminAccess(Map<String,String> parameters) Validate the basic REST connectivity to Squash.
protected SquashProject	validateProject(Map<String,String> parameters) Validate the project connectivity.

Methods inherited from class org.ligoj.app.resource.plugin.AbstractToolPluginResource

create, download, getInstalledEntities, getVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ligoj.app.api.ServicePlugin

create, delete

Methods inherited from interface org.ligoj.app.api.FeaturePlugin

compareTo, getInstalledEntities, getName, getVendor, getVersion, install, update

Methods inherited from interface org.ligoj.app.api.ToolPlugin

checkStatus, checkSubscriptionStatus, checkSubscriptionStatus

Field Detail

URL

public static final String URL

Plug-in key.

See Also:

Constant Field Values

KEY

public static final String KEY

Plug-in key.

PARAMETER_USER

public static final String PARAMETER_USER

Squash TM user name able to connect to instance.

PARAMETER_PASSWORD

public static final String PARAMETER_PASSWORD

Squash TM user password able to connect to instance.

PARAMETER_PROJECT

public static final String PARAMETER_PROJECT

Squash TM project's identifier, an integer

PARAMETER_URL

public static final String PARAMETER_URL

Web site URL

Constructor Detail

SquashPluginResource

public SquashPluginResource()

Method Detail

link

public void link(int subscription)
          throws IOException

Specified by:

link in interface org.ligoj.app.api.ServicePlugin

Throws:

IOException

validateProject

protected SquashProject validateProject(Map<String,String> parameters)
                                 throws IOException

Validate the project connectivity.

Parameters:

parameters - the project parameters.

Returns:

project details.

Throws:

IOException

validateAdminAccess

protected String validateAdminAccess(Map<String,String> parameters)

Validate the basic REST connectivity to Squash.

Parameters:

parameters - the server parameters.

Returns:

the detected Squash version.

getResource

protected String getResource(Map<String,String> parameters,
                             String resource)

Return a Squash's resource. Return null when the resource is not found.

getResource

protected String getResource(org.ligoj.app.resource.plugin.CurlProcessor processor,
                             Map<String,String> parameters,
                             String url,
                             String resource)

Return a Squash's resource. Return null when the resource is not found.

redirect

@GET
 @Path(value="redirect/{subscription:\\d+}")
public javax.ws.rs.core.Response redirect(@PathParam(value="subscription")
                                                                                              int subscription)
                                                                                       throws URISyntaxException

Redirect to the home page of the linked project. Send a redirect code with the relevant cookies used by Squash TM since there is no way to force the link to a desired project.

Returns:

The response redirection to go to the right project.

Throws:

URISyntaxException

getVersion

public String getVersion(Map<String,String> parameters)

Specified by:

getVersion in interface org.ligoj.app.api.ToolPlugin

getProjects

protected List<SquashProject> getProjects(Map<String,String> parameters)
                                   throws IOException

Return all Squash TM projects without limit.

Throws:

IOException

getProjectsDataTables

protected List<SquashProject> getProjectsDataTables(Map<String,String> parameters,
                                                    String criteria)
                                             throws IOException

Return all Squash TM projects without limit and an optional criteria.

Throws:

IOException

getProject

protected SquashProject getProject(Map<String,String> parameters,
                                   int id)
                            throws IOException

Return Squash project from its identifier.

Throws:

IOException

findAllByName

@GET
 @Path(value="{node}/{criteria}")
 @Consumes(value="application/json")
public List<SquashProject> findAllByName(@PathParam(value="node")
                                                                                                                        String node,
                                                                                                                        @PathParam(value="criteria")
                                                                                                                        String criteria)
                                                                                                                 throws IOException

Search the Squash TM the projects matching to the given criteria. Name only is considered.

Parameters:

node - the node to be tested with given parameters.

criteria - the search criteria.

Returns:

project names matching the criteria.

Throws:

IOException

getKey

public String getKey()

Specified by:

getKey in interface org.ligoj.app.api.FeaturePlugin

getLastVersion

public String getLastVersion()
                      throws IOException

Specified by:

getLastVersion in interface org.ligoj.app.api.ToolPlugin

Throws:

IOException

checkSubscriptionStatus

public org.ligoj.app.api.SubscriptionStatusWithData checkSubscriptionStatus(Map<String,String> parameters)
                                                                     throws IOException

Specified by:

checkSubscriptionStatus in interface org.ligoj.app.api.ToolPlugin

Throws:

IOException

checkStatus

public boolean checkStatus(Map<String,String> parameters)

Specified by:

checkStatus in interface org.ligoj.app.api.ToolPlugin