com.atlassian.bamboo.plugins.rest.build

Class PlanDirectoryInformationResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.build.PlanDirectoryInformationResource

public class PlanDirectoryInformationResource
extends Object

Returns information about the directories where artifacts, build logs, and build results will be stored. Disabled by default. See https://confluence.atlassian.com/display/BAMBOO/Plan+directory+information+REST+API for more information.

Constructor Summary

Constructors

Constructor and Description
PlanDirectoryInformationResource(CachedPlanManager planManager, com.atlassian.event.api.EventPublisher eventPublisher, StorageLocationService storageLocationService, InputParser inputParser)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getPlanDirectory(String strPlanKey, com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext, javax.servlet.http.HttpServletRequest request) Provides the directories where artifacts and build logs can be found for a given plan key

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanDirectoryInformationResource

public PlanDirectoryInformationResource(CachedPlanManager planManager,
                                        com.atlassian.event.api.EventPublisher eventPublisher,
                                        StorageLocationService storageLocationService,
                                        InputParser inputParser)

Method Detail

getPlanDirectory

public javax.ws.rs.core.Response getPlanDirectory(String strPlanKey,
                                                  @Context
                                                  com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext,
                                                  @Context
                                                  javax.servlet.http.HttpServletRequest request)
                                           throws UnknownHostException

Provides the directories where artifacts and build logs can be found for a given plan key

Parameters:

strPlanKey - the plan key to retrieve directory information for. Can be a top-level key (i.e. 'PROJ-PLAN') or a branch key (i.e. 'PROJ-PLAN15')

Throws:

UnknownHostException