Package com.atlassian.bamboo.plugins.rest.common

Class RestHelper

java.lang.Object
com.atlassian.bamboo.plugins.rest.common.RestHelper
public final class RestHelper extends Object

  • Field Details

  • Method Details

    • getI18nBean

      public static I18nBean getI18nBean()

    • addAutoExpand

      public static jakarta.ws.rs.core.UriInfo addAutoExpand(jakarta.ws.rs.core.UriInfo uriInfo, String expandable)

    • addExpandParameterToMultiMap

      protected static void addExpandParameterToMultiMap(@NotNull @NotNull jakarta.ws.rs.core.MultivaluedMap<String,String> queryParameters, @NotNull @NotNull String expandable)

    • containsFavouriteQueryParam

      public static boolean containsFavouriteQueryParam(jakarta.ws.rs.core.UriInfo uriInfo)

    • containsPermissionQueryParam

      public static boolean containsPermissionQueryParam(jakarta.ws.rs.core.UriInfo uriInfo)

    • containsMyOnlyQueryParam

      public static boolean containsMyOnlyQueryParam(jakarta.ws.rs.core.UriInfo uriInfo)

    • areBuildPositionsRequested

      public static boolean areBuildPositionsRequested(jakarta.ws.rs.core.UriInfo uriInfo)

    • getPlanType

      public static Class<? extends ImmutablePlan> getPlanType(jakarta.ws.rs.core.UriInfo uriInfo)

    • hasCloverEnabledQueryParam

      public static boolean hasCloverEnabledQueryParam(jakarta.ws.rs.core.UriInfo uriInfo)

    • hasWithBuildPermissionOnlyParam

      public static boolean hasWithBuildPermissionOnlyParam(jakarta.ws.rs.core.UriInfo uriInfo)

    • hasQueryParam

      public static boolean hasQueryParam(jakarta.ws.rs.core.UriInfo uriInfo, String key)

    • getQueryParamAsList

      @Nullable public static @Nullable List<String> getQueryParamAsList(jakarta.ws.rs.core.UriInfo uriInfo, String key)

    • getQueryParamsMap

      @NotNull public static @NotNull Map<String,String> getQueryParamsMap(jakarta.ws.rs.core.UriInfo uriInfo)
      Returns first occurrence of parameters map
      Parameters:
      uriInfo -
      Returns:
      query parameters map

    • getFormParamsMap

      @NotNull public static @NotNull Map<String,String> getFormParamsMap(jakarta.ws.rs.core.MultivaluedMap<String,String> formParams)
      Returns first occurrence of parameters map
      Parameters:
      formParams -
      Returns:
      query parameters map

    • getBuildStateQueryParam

      public static BuildState getBuildStateQueryParam(@NotNull @NotNull jakarta.ws.rs.core.UriInfo uriInfo)

    • getLifeCycleStateQueryParam

      @Nullable public static @Nullable LifeCycleState getLifeCycleStateQueryParam(@NotNull @NotNull jakarta.ws.rs.core.UriInfo uriInfo)

    • formatDateTime

      public static String formatDateTime(long datetime)

    • cacheNever

      public static jakarta.ws.rs.core.CacheControl cacheNever()
      Removes caching in response

    • getReturnUri

      @Nullable public static @Nullable URI getReturnUri(jakarta.ws.rs.core.UriInfo uriInfo)
      Content of 'returnUrl' request parameter or null if empty.
      Parameters:
      uriInfo -
      Returns:
      'returnUrl' request parameter or null if empty

    • assertPlanPermission

      public static void assertPlanPermission(@NotNull @NotNull BambooPermission permission, @NotNull @NotNull PlanKey planKey, BambooPermissionManager bambooPermissionManager)
      Check user has provided or ADMINISTRATION permission on given plan
      Parameters:
      permission -
      planKey -
      bambooPermissionManager -

    • assertReadPermission

      public static void assertReadPermission()

    • assertExecutePermission

      public static void assertExecutePermission(PlanKey planKey, BambooPermissionManager bambooPermissionManager)

    • assertSystemAdminPermission

      public static void assertSystemAdminPermission()

    • assertRestrictedAdminPermission

      public static void assertRestrictedAdminPermission()

    • assertGlobalPermission

      public static void assertGlobalPermission(@NotNull @NotNull BambooPermission permission)
      Asserts that current user has the specified permission. If not, throws AccessDeniedException with a generic error message.
      Parameters:
      permission - permission to verify
      Throws:
      org.acegisecurity.AccessDeniedException - if user lacks the specified permission

    • assertGlobalPermission

      public static void assertGlobalPermission(@NotNull @NotNull BambooPermission permission, @NotNull @NotNull String errorMessage)
      Asserts that current user has the specified permission. If not, throws AccessDeniedException with the specified message
      Parameters:
      permission - permission to verify
      errorMessage - exception message to be used if user lacks the specified permission
      Throws:
      org.acegisecurity.AccessDeniedException - if user lacks the specified permission

    • assertIpAddressIsLocal

      public static void assertIpAddressIsLocal(@NotNull @NotNull String address) throws UnknownHostException
      Throws:
      UnknownHostException

    • assertNotRssPlan

      public static void assertNotRssPlan(@NotNull @NotNull PlanKey planKey, @NotNull @NotNull PlanRestService planRestService)
      Asserts plan is not managed by repository stored specs.

    • assertNotRssEnvironment

      public static void assertNotRssEnvironment(@NotNull @NotNull Environment environment, @NotNull @NotNull CachedDeploymentProjectService cachedDeploymentProjectService)
      Asserts environment is not managed by repository stored specs.

    • assertNotRssDeploymentProject

      public static void assertNotRssDeploymentProject(@NotNull @NotNull DeploymentProject deploymentProject)
      Asserts deployment project is not managed by repository stored specs.