Package com.xebialabs.xlrelease.api.v1

Interface ConfigurationApi

  • All Superinterfaces:
    ApiService
    @Path("/api/v1/config")
@Consumes("application/json")
@Produces("application/json")
public interface ConfigurationApi
extends ApiService
    Operations on global variables and other configuration.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      com.xebialabs.xlrelease.domain.Configuration addConfiguration​(com.xebialabs.xlrelease.domain.Configuration configuration)
      Creates a new configuration.
      com.xebialabs.xlrelease.domain.variables.Variable addGlobalVariable​(com.xebialabs.xlrelease.api.v1.forms.Variable variable)
      Adds a global variable.
      com.xebialabs.xlrelease.views.SharedConfigurationStatusResponse checkStatus​(com.xebialabs.xlrelease.views.ConfigurationView configurationView)  
      com.xebialabs.xlrelease.views.SharedConfigurationStatusResponse checkStatus​(java.lang.String configurationId)  
      void deleteConfiguration​(java.lang.String configurationId)
      Deletes the configuration.
      void deleteGlobalVariable​(java.lang.String variableId)
      Deletes a global variable.
      com.xebialabs.xlrelease.domain.Configuration getConfiguration​(java.lang.String configurationId)
      Returns the configuration with the given ID.
      com.xebialabs.xlrelease.domain.variables.Variable getGlobalVariable​(java.lang.String variableId)
      Returns the global variable for the given identifier.
      java.util.List<com.xebialabs.xlrelease.domain.variables.Variable> getGlobalVariables()
      Returns global variables list.
      java.util.Map<java.lang.String,​java.lang.String> getGlobalVariableValues()
      Returns global variables list with replaced variable values.
      com.xebialabs.xlrelease.configuration.SystemMessageSettings getSystemMessage()  
      java.util.List<? extends com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> searchByTypeAndTitle​(java.lang.String configurationType, java.lang.String title)
      Searches configuration objects by type and title.
      java.util.List<? extends com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> searchByTypeAndTitle​(java.lang.String configurationType, java.lang.String title, java.lang.String folderId)
      Searches configuration objects by type and title.
      java.util.List<com.xebialabs.xlrelease.domain.Configuration> searchByTypeAndTitle​(java.lang.String configurationType, java.lang.String title, java.lang.String folderId, boolean folderOnly)
      Searches configuration objects by type and title.
      default java.lang.String serviceName()  
      com.xebialabs.xlrelease.domain.Configuration updateConfiguration​(com.xebialabs.xlrelease.domain.Configuration configuration)
      Updates the configuration.
      com.xebialabs.xlrelease.domain.Configuration updateConfiguration​(java.lang.String configurationId, com.xebialabs.xlrelease.domain.Configuration configuration)
      Updates the configuration.
      com.xebialabs.xlrelease.domain.variables.Variable updateGlobalVariable​(com.xebialabs.xlrelease.domain.variables.Variable variable)
      Updates properties of a global variable by its ID.
      com.xebialabs.xlrelease.domain.variables.Variable updateGlobalVariable​(java.lang.String variableId, com.xebialabs.xlrelease.domain.variables.Variable variable)  
      com.xebialabs.xlrelease.configuration.SystemMessageSettings updateSystemMessage​(com.xebialabs.xlrelease.configuration.SystemMessageSettings systemMessageSettings)  

    • Method Detail

      • serviceName

        default java.lang.String serviceName()
        Specified by:
        serviceName in interface ApiService

      • getGlobalVariables

        @GET
@Path("/Configuration/variables/global")
java.util.List<com.xebialabs.xlrelease.domain.variables.Variable> getGlobalVariables()
        Returns global variables list.
        Returns:
        variables list.

      • getGlobalVariableValues

        @GET
@Path("/Configuration/variableValues/global")
java.util.Map<java.lang.String,​java.lang.String> getGlobalVariableValues()
        Returns global variables list with replaced variable values.
        Returns:
        variables list.

      • getGlobalVariable

        @GET
@Path("/{variableId:.*/Variable[^/]*}")
com.xebialabs.xlrelease.domain.variables.Variable getGlobalVariable​(@PathParam("variableId")
                                                                    java.lang.String variableId)
        Returns the global variable for the given identifier.
        Parameters:
        variableId - the variable identifier.
        Returns:
        the variable.

      • addGlobalVariable

        @POST
@Path("/Configuration/variables/global")
com.xebialabs.xlrelease.domain.variables.Variable addGlobalVariable​(com.xebialabs.xlrelease.api.v1.forms.Variable variable)
        Adds a global variable.
        Parameters:
        variable - the global variable to add.
        Returns:
        the added global variable.

      • updateGlobalVariable

        @PUT
@Path("/{variableId:.*/Variable[^/]*}")
com.xebialabs.xlrelease.domain.variables.Variable updateGlobalVariable​(@PathParam("variableId")
                                                                       java.lang.String variableId,
                                                                       com.xebialabs.xlrelease.domain.variables.Variable variable)

      • updateGlobalVariable

        com.xebialabs.xlrelease.domain.variables.Variable updateGlobalVariable​(com.xebialabs.xlrelease.domain.variables.Variable variable)
        Updates properties of a global variable by its ID.
        Parameters:
        variable - the variable to update.
        Returns:
        the updated variable.

      • deleteGlobalVariable

        @DELETE
@Path("/{variableId:.*/Variable[^/]*}")
void deleteGlobalVariable​(@PathParam("variableId")
                          java.lang.String variableId)
        Deletes a global variable.
        Parameters:
        variableId - the variable identifier.

      • searchByTypeAndTitle

        java.util.List<? extends com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> searchByTypeAndTitle​(java.lang.String configurationType,
                                                                                                       java.lang.String title)
        Searches configuration objects by type and title.
        Parameters:
        configurationType - the type of the Configuration object.
        title - the title of the Configuration object.(optional)
        Returns:
        returns the first 100 results loaded with depth 1. Password properties are not returned.

      • searchByTypeAndTitle

        java.util.List<? extends com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> searchByTypeAndTitle​(java.lang.String configurationType,
                                                                                                       java.lang.String title,
                                                                                                       java.lang.String folderId)
        Searches configuration objects by type and title.
        Parameters:
        configurationType - the type of the Configuration object.
        title - the title of the Configuration object.(optional)
        folderId - the path of a parent.(optional)
        Returns:
        returns the first 100 results loaded with depth 1. Password properties are not returned.

      • searchByTypeAndTitle

        @GET
@Path("byTypeAndTitle")
java.util.List<com.xebialabs.xlrelease.domain.Configuration> searchByTypeAndTitle​(@QueryParam("configurationType")
                                                                                  java.lang.String configurationType,
                                                                                  @QueryParam("title")
                                                                                  java.lang.String title,
                                                                                  @QueryParam("folderId")
                                                                                  java.lang.String folderId,
                                                                                  @QueryParam("folderOnly")
                                                                                  boolean folderOnly)
        Searches configuration objects by type and title.
        Parameters:
        configurationType - the type of the Configuration object.
        title - the title of the Configuration object.(optional)
        folderId - the path of a parent.(optional)
        folderOnly - filter if you only want to get information from your parentId. (optional)
        Returns:
        returns the first 100 results loaded with depth 1. Password properties are not returned.

      • getConfiguration

        @GET
@Path("/{configurationId:.*/Configuration[^/]*}")
com.xebialabs.xlrelease.domain.Configuration getConfiguration​(@PathParam("configurationId")
                                                              java.lang.String configurationId)
        Returns the configuration with the given ID.
        Parameters:
        configurationId - the identifier of the configuration
        Returns:
        the configuration instance

      • addConfiguration

        @POST
com.xebialabs.xlrelease.domain.Configuration addConfiguration​(com.xebialabs.xlrelease.domain.Configuration configuration)
        Creates a new configuration.
        Parameters:
        configuration - the configuration to add.
        Returns:
        the created configuration.

      • updateConfiguration

        @PUT
@Path("{configurationId:.*/Configuration[^/]*}")
com.xebialabs.xlrelease.domain.Configuration updateConfiguration​(@PathParam("configurationId")
                                                                 java.lang.String configurationId,
                                                                 com.xebialabs.xlrelease.domain.Configuration configuration)
        Updates the configuration.
        Parameters:
        configurationId - the identifier of the configuration.
        configuration - new contents of the configuration.
        Returns:
        the updated configuration.

      • updateConfiguration

        com.xebialabs.xlrelease.domain.Configuration updateConfiguration​(com.xebialabs.xlrelease.domain.Configuration configuration)
        Updates the configuration.
        Parameters:
        configuration - new contents of the configuration.
        Returns:
        the updated configuration.

      • deleteConfiguration

        @DELETE
@Path("{configurationId:.*/Configuration[^/]*}")
void deleteConfiguration​(@PathParam("configurationId")
                         java.lang.String configurationId)
        Deletes the configuration.
        Parameters:
        configurationId - the identifier of the configuration.

      • getSystemMessage

        @GET
@Path("system-message")
com.xebialabs.xlrelease.configuration.SystemMessageSettings getSystemMessage()

      • updateSystemMessage

        @PUT
@Path("system-message")
com.xebialabs.xlrelease.configuration.SystemMessageSettings updateSystemMessage​(com.xebialabs.xlrelease.configuration.SystemMessageSettings systemMessageSettings)

      • checkStatus

        @POST
@Path("status")
com.xebialabs.xlrelease.views.SharedConfigurationStatusResponse checkStatus​(com.xebialabs.xlrelease.views.ConfigurationView configurationView)

      • checkStatus

        @POST
@Path("{configurationId:.*/Configuration[^/]*}/status")
com.xebialabs.xlrelease.views.SharedConfigurationStatusResponse checkStatus​(@PathParam("configurationId")
                                                                            java.lang.String configurationId)