Interface MetadataService
@Path("/metadata")
@Consumes({"application/xml","application/json"})
@Produces({"application/xml","application/json"})
public interface MetadataService
Provides XL Deploy's metadata: available types, permissions and orchestrators.
-
Method Summary
Modifier and TypeMethodDescriptioncom.xebialabs.deployit.plugin.api.reflect.DescriptorfindDescriptor(com.xebialabs.deployit.plugin.api.reflect.Type type) Gets theDescriptorfor a specific type from the XL Deploy Type System.getTypeNames(List<String> superTypes) Lists the names of all types assignable to any of the given super types — reachable via the class inheritance chain, a directly implemented interface, or a transitively implemented interface.Creates a map of the parent/child relationships of all the types known to the XL Deploy Type System.List<com.xebialabs.deployit.plugin.api.reflect.Descriptor> Lists all theDescriptorsof all the types known to the XL Deploy Type System.Lists all the Orchestrator names that can be used to orchestrate aDeploymentdone by theDeploymentService.Lists all thePermissionsthat can be granted or revoked.
-
Method Details
-
listDescriptors
Lists all theDescriptorsof all the types known to the XL Deploy Type System. Hidden properties are not exposed.- Returns:
- A List of
Descriptors
-
inheritance
Creates a map of the parent/child relationships of all the types known to the XL Deploy Type System.- Returns:
- A Map of descriptor type name to list of children types.
-
findDescriptor
@GET @Path("type/{type}") com.xebialabs.deployit.plugin.api.reflect.Descriptor findDescriptor(@PathParam("type") com.xebialabs.deployit.plugin.api.reflect.Type type) Gets theDescriptorfor 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
Lists all thePermissionsthat can be granted or revoked.- Returns:
- A List of
Permissions
-
listOrchestrators
Lists all the Orchestrator names that can be used to orchestrate aDeploymentdone by theDeploymentService.- Returns:
- A List of orchestrator names.
-
getTypeNames
@GET @Path("types/names") List<String> getTypeNames(@QueryParam("superType") List<String> superTypes) Lists the names of all types assignable to any of the given super types — reachable via the class inheritance chain, a directly implemented interface, or a transitively implemented interface. A requested super type that is itself a registered type is included in the result. A requested super type that is not a registered type contributes no matches and does not cause an error.When no super type is supplied at all (parameter missing or an empty list), the names of all registered types are returned. Blank values (empty, whitespace-only or null) are ignored; if every supplied value is blank the result is empty.
- Parameters:
superTypes- optional super type names to match against, each the type's full, exact, registered name (e.g. "udm.BaseContainer"); a value that is not an exact registered name (including a bare, unprefixed class name) contributes no matches, the same as any other unregistered name- Returns:
- the deduplicated list of type names assignable to any of the given super types, or all registered type names when no super type is supplied
-