Package org.talend.sdk.component.server.api

Interface ComponentResource

@Path("component")
@Consumes("application/json")
@Produces("application/json")
public interface ComponentResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ComponentResource.SampleErrorForBulk

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IMAGE_SVG_XML

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	familyIcon(String id, String theme)
Dependencies	getDependencies(String[] ids)
javax.ws.rs.core.StreamingOutput	getDependency(String id)
ComponentDetailList	getDetail(String language, String[] ids)
javax.ws.rs.core.Response	getIconIndex(String theme)
ComponentIndices	getIndex(String language, boolean includeIconContent, String query, String theme)
javax.ws.rs.core.Response	icon(String id, String theme)
javax.ws.rs.core.Response	icon(String familyId, String iconKey, String theme)
Map<String,String>	migrate(String id, int version, Map<String,String> config)

Field Details

IMAGE_SVG_XML

static final String IMAGE_SVG_XML

See Also:

• Constant Field Values

Method Details

getDependencies

@GET
@Path("dependencies")
Dependencies getDependencies(@QueryParam("identifier")
 String[] ids)

getDependency

@GET
@Path("dependency/{id}")
@Produces("application/octet-stream")
javax.ws.rs.core.StreamingOutput getDependency(@PathParam("id")
 String id)

getIndex

@GET
@Path("index")
ComponentIndices getIndex(@QueryParam("language") @DefaultValue("en")
 String language,
 @QueryParam("includeIconContent") @DefaultValue("false")
 boolean includeIconContent,
 @QueryParam("q")
 String query,
 @QueryParam("theme")
 String theme)

familyIcon

@GET
@Path("icon/family/{id}")
@Produces({"application/json","application/octet-stream"})
javax.ws.rs.core.Response familyIcon(@PathParam("id")
 String id,
 @QueryParam("theme")
 String theme)

icon

@GET
@Path("icon/{id}")
@Produces({"application/json","application/octet-stream"})
javax.ws.rs.core.Response icon(@PathParam("id")
 String id,
 @QueryParam("theme")
 String theme)

icon

@GET
@Path("icon/custom/{familyId}/{iconKey}")
@Produces({"application/json","application/octet-stream"})
javax.ws.rs.core.Response icon(@PathParam("familyId")
 String familyId,
 @PathParam("iconKey")
 String iconKey,
 @QueryParam("theme")
 String theme)

getIconIndex

@GET
@Path("icon/index")
@Produces({"application/json","image/svg+xml"})
javax.ws.rs.core.Response getIconIndex(@QueryParam("theme")
 String theme)

migrate

@POST
@Path("migrate/{id}/{configurationVersion}")
Map<String,String> migrate(@PathParam("id")
 String id,
 @PathParam("configurationVersion")
 int version,
 Map<String,String> config)

getDetail

@GET
@Path("details")
ComponentDetailList getDetail(@QueryParam("language") @DefaultValue("en")
 String language,
 @QueryParam("identifiers")
 String[] ids)