com.xebialabs.deployit.engine.api

Interface MetadataService

@Path(value="/metadata")
@Consumes(value={"application/xml","application/json"})
@Produces(value={"application/xml","application/json"})
public interface MetadataService

Provides XL Deploy's metadata: available types, permissions and orchestrators.

Method Summary

Methods

Modifier and Type	Method and Description
com.xebialabs.deployit.plugin.api.reflect.Descriptor	findDescriptor(com.xebialabs.deployit.plugin.api.reflect.Type type) Gets the Descriptor for a specific type from the XL Deploy Type System.
java.util.List<com.xebialabs.deployit.plugin.api.reflect.Descriptor>	listDescriptors() Lists all the Descriptors of all the types known to the XL Deploy Type System.
java.util.List<java.lang.String>	listOrchestrators() Lists all the Orchestrator names that can be used to orchestrate a Deployment done by the DeploymentService.
java.util.List<Permission>	listPermissions() Lists all the Permissions that can be granted or revoked.

Method Detail

listDescriptors

@GET
@Path(value="type")
java.util.List<com.xebialabs.deployit.plugin.api.reflect.Descriptor> listDescriptors()

Lists all the Descriptors of all the types known to the XL Deploy Type System. Hidden properties are not exposed.

Returns:

A List of Descriptors

findDescriptor

@GET
@Path(value="type/{type}")
com.xebialabs.deployit.plugin.api.reflect.Descriptor findDescriptor(@PathParam(value="type")
                                                                           com.xebialabs.deployit.plugin.api.reflect.Type type)

Gets the Descriptor for a specific type from the XL Deploy Type System.

Parameters:

type - the type to get the descriptor of.

Returns:

The descriptor matching the type

listPermissions

@GET
@Path(value="permissions")
java.util.List<Permission> listPermissions()

Lists all the Permissions that can be granted or revoked.

Returns:

A List of Permissions

listOrchestrators

@GET
@Path(value="orchestrators")
java.util.List<java.lang.String> listOrchestrators()

Lists all the Orchestrator names that can be used to orchestrate a Deployment done by the DeploymentService.

Returns:

A List of orchestrator names.