Package com.xebialabs.xlrelease.api.internal

Class SharedConfigurationResource

java.lang.Object
com.xebialabs.xlrelease.api.internal.SharedConfigurationResource
@Path("/configurations") @Consumes("application/json") @Produces("application/json") @Controller public class SharedConfigurationResource extends Object
Configuration objects are used to externalize configuration that can be referenced by custom script tasks.

One can declare new configuration types by adding it in the synthetic file

  • Constructor Summary

    Constructors
    Constructor
    Description
    SharedConfigurationResource(SharedConfigurationService sharedConfigurationService, com.xebialabs.xlrelease.security.PermissionChecker permissions, ConfigurationItemViewConverter configurationViewConverter, com.xebialabs.xlrelease.service.SharedConfigurationStatusService sharedConfigurationStatusService, com.xebialabs.xlrelease.service.ConfigurationAutoconfigService configurationAutoconfigService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.xebialabs.xlrelease.views.ConfigurationView
    addInstance(com.xebialabs.xlrelease.views.ConfigurationView configurationView)
    Creates a new configuration instance
    com.xebialabs.xlrelease.views.AutoconfigResponse
    autoconfigure(com.xebialabs.xlrelease.views.ConfigurationView configurationView)
     
    com.xebialabs.xlrelease.views.SharedConfigurationStatusResponse
    checkConnection(com.xebialabs.xlrelease.views.ConfigurationView configurationView)
     
    void
    deleteInstance(String configurationInstanceId)
    Deletes a configuration instance
    List<com.xebialabs.deployit.plugin.api.reflect.Descriptor>
    getDescriptors()
    Return the list of configuration types declared in synthetic file
    com.xebialabs.xlrelease.views.ConfigurationView
    getInstance(String configurationInstanceId)
    Returns a configuration instance
    List<com.xebialabs.xlrelease.views.ConfigurationView>
    getInstances(boolean anonymized)
    Return the list of configuration instance
    List<ReferencedType>
    getReferenceVariableTypes()
     
    Boolean
    hasScript(com.xebialabs.xlrelease.views.ConfigurationView configurationView)
     
    Boolean
    isAutoconfigure(com.xebialabs.xlrelease.views.ConfigurationView configurationView)
     
    com.xebialabs.xlrelease.views.ConfigurationView
    updateInstance(String configurationInstanceId, com.xebialabs.xlrelease.views.ConfigurationView configurationView)
    Updates a configuration instance

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SharedConfigurationResource

      @Autowired public SharedConfigurationResource(SharedConfigurationService sharedConfigurationService, com.xebialabs.xlrelease.security.PermissionChecker permissions, ConfigurationItemViewConverter configurationViewConverter, com.xebialabs.xlrelease.service.SharedConfigurationStatusService sharedConfigurationStatusService, com.xebialabs.xlrelease.service.ConfigurationAutoconfigService configurationAutoconfigService)

  • Method Details

    • getDescriptors

      @GET @Path("descriptors") public List<com.xebialabs.deployit.plugin.api.reflect.Descriptor> getDescriptors()
      Return the list of configuration types declared in synthetic file
      Returns:
      a list of type descriptor

    • getInstances

      @GET public List<com.xebialabs.xlrelease.views.ConfigurationView> getInstances(@QueryParam("anonymized") boolean anonymized)
      Return the list of configuration instance
      Parameters:
      anonymized - a boolean indicating whether the credentials should be stripped or not
      Returns:
      a list of configuration instance possibly anonymized

    • addInstance

      @POST public com.xebialabs.xlrelease.views.ConfigurationView addInstance(com.xebialabs.xlrelease.views.ConfigurationView configurationView)
      Creates a new configuration instance
      Parameters:
      configurationView - the information required to create the new instance
      Returns:
      the created instance

    • getInstance

      @GET @Path("{configurationInstanceId:((?!descriptors).)*}") public com.xebialabs.xlrelease.views.ConfigurationView getInstance(@PathParam("configurationInstanceId") String configurationInstanceId)
      Returns a configuration instance
      Parameters:
      configurationInstanceId - the configuration instance identifier
      Returns:
      the configuration instance

    • updateInstance

      @PUT @Path("{configurationInstanceId:((?!descriptors).)*}") public com.xebialabs.xlrelease.views.ConfigurationView updateInstance(@PathParam("configurationInstanceId") String configurationInstanceId, com.xebialabs.xlrelease.views.ConfigurationView configurationView)
      Updates a configuration instance
      Parameters:
      configurationInstanceId - the configuration instance identifier
      configurationView - the changes to apply
      Returns:
      the updated configuration instance

    • deleteInstance

      @DELETE @Path("{configurationInstanceId}") public void deleteInstance(@PathParam("configurationInstanceId") String configurationInstanceId)
      Deletes a configuration instance
      Parameters:
      configurationInstanceId - the configuration identifier

    • checkConnection

      @Path("status") @POST public com.xebialabs.xlrelease.views.SharedConfigurationStatusResponse checkConnection(com.xebialabs.xlrelease.views.ConfigurationView configurationView)

    • hasScript

      @Path("hasScript") @POST public Boolean hasScript(com.xebialabs.xlrelease.views.ConfigurationView configurationView)

    • autoconfigure

      @Path("autoconfigure") @POST public com.xebialabs.xlrelease.views.AutoconfigResponse autoconfigure(com.xebialabs.xlrelease.views.ConfigurationView configurationView)

    • isAutoconfigure

      @Path("isAutoconfigure") @POST public Boolean isAutoconfigure(com.xebialabs.xlrelease.views.ConfigurationView configurationView)

    • getReferenceVariableTypes

      @Path("referenceVariable/types") @GET public List<ReferencedType> getReferenceVariableTypes()