Package com.atlassian.bamboo.plugins.rest.admin.sharedcredentials

Class SharedCredentialResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.sharedcredentials.SharedCredentialResource

@Path("config/sharedCredentials")
@Produces("application/json")
@Consumes("application/json")
public class SharedCredentialResource
extends Object

REST endpoint that manage bamboo shared credentials. Different types of shared credentials can be provided via bamboo plugins and their configuration varies. This REST endpoint only supports ssh shared credentials for now.

Since:

5.10

Field Summary

Fields

Modifier and Type	Field	Description
static final RestSharedCredential	PASSWORD_SHARED_CREDENTIAL
static final RestListModel<RestSharedCredential>	PASSWORD_SHARED_CREDENTIALS
static final RestSharedCredential	SSH_SHARED_CREDENTIAL
static final RestListModel<RestSharedCredential>	SSH_SHARED_CREDENTIALS

Constructor Summary

Constructors

Constructor	Description
SharedCredentialResource(CredentialsManager credentialsManager, ProjectManager projectManager, com.atlassian.sal.api.message.I18nResolver i18nResolver, LinkService linkService, RestPermissionCheck restPermissionCheck, SharedCredentialConversionFunction sharedCredentialConversionFunction)

Method Summary

Modifier and Type	Method	Description
@NotNull RestSharedCredential	createPasswordSharedCredential(@NotNull RestSharedCredential restSharedCredential, @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
@NotNull RestSharedCredential	createSshSharedCredential(@NotNull RestSharedCredential restSharedCredential, @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	deletePasswordSharedCredential(long sharedCredentialId)
jakarta.ws.rs.core.Response	deleteSshSharedCredential(long sharedCredentialId)
@NotNull RestSharedCredential	getPasswordSharedCredential(@NotNull Long sharedCredentialId, @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
@NotNull RestListModel<RestSharedCredential>	getPasswordSharedCredentials(@NotNull jakarta.ws.rs.core.UriInfo uriInfo, @NotNull ExpansionParam expansion)
@NotNull RestSharedCredential	getSshSharedCredential(@NotNull Long sharedCredentialId, @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
@NotNull RestListModel<RestSharedCredential>	getSshSharedCredentials(@NotNull jakarta.ws.rs.core.UriInfo uriInfo, @NotNull ExpansionParam expansion)
RestSharedCredential	updatePasswordSharedCredential(long sharedCredentialId, @NotNull RestSharedCredential restSharedCredential, @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
RestSharedCredential	updateSshSharedCredential(long sharedCredentialId, @NotNull RestSharedCredential restSharedCredential, @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
protected @NotNull ErrorCollection	validate(@NotNull RestSharedCredential restSharedCredential, @Nullable Long sharedCredentialId)

Methods inherited from class java.lang.Object

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

Field Details

SSH_SHARED_CREDENTIAL

public static final RestSharedCredential SSH_SHARED_CREDENTIAL

PASSWORD_SHARED_CREDENTIAL

public static final RestSharedCredential PASSWORD_SHARED_CREDENTIAL

SSH_SHARED_CREDENTIALS

public static final RestListModel<RestSharedCredential> SSH_SHARED_CREDENTIALS

PASSWORD_SHARED_CREDENTIALS

public static final RestListModel<RestSharedCredential> PASSWORD_SHARED_CREDENTIALS

Constructor Details

SharedCredentialResource

@Inject
public SharedCredentialResource(CredentialsManager credentialsManager,
 ProjectManager projectManager,
 com.atlassian.sal.api.message.I18nResolver i18nResolver,
 LinkService linkService,
 RestPermissionCheck restPermissionCheck,
 SharedCredentialConversionFunction sharedCredentialConversionFunction)

Method Details

getSshSharedCredentials

@NotNull
@GET
@Path("ssh")
public @NotNull RestListModel<RestSharedCredential> getSshSharedCredentials(@Context @NotNull
 @NotNull jakarta.ws.rs.core.UriInfo uriInfo,
 @BeanParam @NotNull
 @NotNull ExpansionParam expansion)

getSshSharedCredential

@NotNull
@GET
@Path("ssh/{sharedCredentialId}")
public @NotNull RestSharedCredential getSshSharedCredential(@PathParam("sharedCredentialId") @NotNull
 @NotNull Long sharedCredentialId,
 @Context @NotNull
 @NotNull jakarta.ws.rs.core.UriInfo uriInfo)

createSshSharedCredential

@NotNull
@POST
@Path("ssh")
public @NotNull RestSharedCredential createSshSharedCredential(@NotNull
 @NotNull RestSharedCredential restSharedCredential,
 @Context @NotNull
 @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
                                                        throws WebValidationException

Throws:

WebValidationException

updateSshSharedCredential

@PUT
@Path("ssh/{sharedCredentialId}")
public RestSharedCredential updateSshSharedCredential(@PathParam("sharedCredentialId")
 long sharedCredentialId,
 @NotNull
 @NotNull RestSharedCredential restSharedCredential,
 @Context @NotNull
 @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
                                               throws WebValidationException

Throws:

WebValidationException

deleteSshSharedCredential

@DELETE
@Path("ssh/{sharedCredentialId}")
public jakarta.ws.rs.core.Response deleteSshSharedCredential(@PathParam("sharedCredentialId")
 long sharedCredentialId)

getPasswordSharedCredentials

@NotNull
@GET
@Path("password")
public @NotNull RestListModel<RestSharedCredential> getPasswordSharedCredentials(@Context @NotNull
 @NotNull jakarta.ws.rs.core.UriInfo uriInfo,
 @BeanParam @NotNull
 @NotNull ExpansionParam expansion)

getPasswordSharedCredential

@NotNull
@GET
@Path("password/{sharedCredentialId}")
public @NotNull RestSharedCredential getPasswordSharedCredential(@PathParam("sharedCredentialId") @NotNull
 @NotNull Long sharedCredentialId,
 @Context @NotNull
 @NotNull jakarta.ws.rs.core.UriInfo uriInfo)

createPasswordSharedCredential

@NotNull
@POST
@Path("password")
public @NotNull RestSharedCredential createPasswordSharedCredential(@NotNull
 @NotNull RestSharedCredential restSharedCredential,
 @Context @NotNull
 @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
                                                             throws WebValidationException

Throws:

WebValidationException

updatePasswordSharedCredential

@PUT
@Path("password/{sharedCredentialId}")
public RestSharedCredential updatePasswordSharedCredential(@PathParam("sharedCredentialId")
 long sharedCredentialId,
 @NotNull
 @NotNull RestSharedCredential restSharedCredential,
 @Context @NotNull
 @NotNull jakarta.ws.rs.core.UriInfo uriInfo)
                                                    throws WebValidationException

Throws:

WebValidationException

deletePasswordSharedCredential

@DELETE
@Path("password/{sharedCredentialId}")
public jakarta.ws.rs.core.Response deletePasswordSharedCredential(@PathParam("sharedCredentialId")
 long sharedCredentialId)

validate

@NotNull
protected @NotNull ErrorCollection validate(@NotNull
 @NotNull RestSharedCredential restSharedCredential,
 @Nullable
 @Nullable Long sharedCredentialId)