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

Class SharedCredentialResource

java.lang.Object

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

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 and Description
static RestSharedCredential	PASSWORD_SHARED_CREDENTIAL
static RestListModel<RestSharedCredential>	PASSWORD_SHARED_CREDENTIALS
static RestSharedCredential	SSH_SHARED_CREDENTIAL
static RestListModel<RestSharedCredential>	SSH_SHARED_CREDENTIALS

Constructor Summary

Constructors

Constructor and 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 and Description
RestSharedCredential	createPasswordSharedCredential(RestSharedCredential restSharedCredential, javax.ws.rs.core.UriInfo uriInfo) Create a new username/password shared credential.
RestSharedCredential	createSshSharedCredential(RestSharedCredential restSharedCredential, javax.ws.rs.core.UriInfo uriInfo) Create a new Ssh shared credential.
javax.ws.rs.core.Response	deletePasswordSharedCredential(long sharedCredentialId) Delete the given username/password shared credential
javax.ws.rs.core.Response	deleteSshSharedCredential(long sharedCredentialId) Delete the given ssh shared credential
RestSharedCredential	getPasswordSharedCredential(Long sharedCredentialId, javax.ws.rs.core.UriInfo uriInfo) Get configuration of a shared username/password credential.
RestListModel<RestSharedCredential>	getPasswordSharedCredentials(javax.ws.rs.core.UriInfo uriInfo, Expansion expansion) Rest endpoint to retrieve all username/password shared credentials.
RestSharedCredential	getSshSharedCredential(Long sharedCredentialId, javax.ws.rs.core.UriInfo uriInfo) Get configuration of a shared ssh credential.
RestListModel<RestSharedCredential>	getSshSharedCredentials(javax.ws.rs.core.UriInfo uriInfo, Expansion expansion) Rest endpoint to retrieve all ssh shared credentials.
RestSharedCredential	updatePasswordSharedCredential(long sharedCredentialId, RestSharedCredential restSharedCredential, javax.ws.rs.core.UriInfo uriInfo) Update existing username/password shared credential.
RestSharedCredential	updateSshSharedCredential(long sharedCredentialId, RestSharedCredential restSharedCredential, javax.ws.rs.core.UriInfo uriInfo) Update existing ssh shared credential.
protected ErrorCollection	validate(RestSharedCredential restSharedCredential, Long sharedCredentialId)

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

SharedCredentialResource

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

Method Detail

getSshSharedCredentials

@NotNull
public RestListModel<RestSharedCredential> getSshSharedCredentials(@Context @NotNull
                                                                            javax.ws.rs.core.UriInfo uriInfo,
                                                                            @Context @NotNull
                                                                            Expansion expansion)

Rest endpoint to retrieve all ssh shared credentials. Ssh key and passPhrase will be returned as salted hash.

Parameters:

uriInfo - Provides information about current request

expansion - Represents an expansion tree of additional information we want to retrieve

Returns:

List of ssh shared credentials

getSshSharedCredential

@NotNull
public RestSharedCredential getSshSharedCredential(@NotNull
                                                            Long sharedCredentialId,
                                                            @Context @NotNull
                                                            javax.ws.rs.core.UriInfo uriInfo)

Get configuration of a shared ssh credential. Ssh key and pass passParase will be returned as salted hash.

Parameters:

sharedCredentialId - Id of the shared credential

uriInfo - Provides information about current request

Returns:

Ssh shared credential configuration with the given id

createSshSharedCredential

@NotNull
public RestSharedCredential createSshSharedCredential(@NotNull
                                                               RestSharedCredential restSharedCredential,
                                                               @Context @NotNull
                                                               javax.ws.rs.core.UriInfo uriInfo)
                                                        throws WebValidationException

Create a new Ssh shared credential.

Parameters:

restSharedCredential - Configuration of the shared credential

uriInfo - Provides information about current request

Returns:

The created ssh shared credential

Throws:

WebValidationException

updateSshSharedCredential

public RestSharedCredential updateSshSharedCredential(long sharedCredentialId,
                                                      @NotNull
                                                      RestSharedCredential restSharedCredential,
                                                      @Context @NotNull
                                                      javax.ws.rs.core.UriInfo uriInfo)
                                               throws WebValidationException

Update existing ssh shared credential.

Parameters:

sharedCredentialId - Id of the shared credential

restSharedCredential - New configuration

uriInfo - Provides information about current request

Returns:

Updated configuration of the ssh shared credential

Throws:

WebValidationException

deleteSshSharedCredential

public javax.ws.rs.core.Response deleteSshSharedCredential(long sharedCredentialId)

Delete the given ssh shared credential

Parameters:

sharedCredentialId - Id of the shared credential to be deleted

Returns:

Response indicates status of the deletion

getPasswordSharedCredentials

@NotNull
public RestListModel<RestSharedCredential> getPasswordSharedCredentials(@Context @NotNull
                                                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                                                 @Context @NotNull
                                                                                 Expansion expansion)

Rest endpoint to retrieve all username/password shared credentials. Password will be returned as salted hash.

Parameters:

uriInfo - Provides information about current request

expansion - Represents an expansion tree of additional information we want to retrieve

Returns:

List of username/password shared credentials

getPasswordSharedCredential

@NotNull
public RestSharedCredential getPasswordSharedCredential(@NotNull
                                                                 Long sharedCredentialId,
                                                                 @Context @NotNull
                                                                 javax.ws.rs.core.UriInfo uriInfo)

Get configuration of a shared username/password credential. Password will be returned as salted hash.

Parameters:

sharedCredentialId - Id of the shared credential

uriInfo - Provides information about current request

Returns:

username/password shared credential configuration with the given id

createPasswordSharedCredential

@NotNull
public RestSharedCredential createPasswordSharedCredential(@NotNull
                                                                    RestSharedCredential restSharedCredential,
                                                                    @Context @NotNull
                                                                    javax.ws.rs.core.UriInfo uriInfo)
                                                             throws WebValidationException

Create a new username/password shared credential.

Parameters:

restSharedCredential - Configuration of the shared credential

uriInfo - Provides information about current request

Returns:

The created username/password shared credential

Throws:

WebValidationException

updatePasswordSharedCredential

public RestSharedCredential updatePasswordSharedCredential(long sharedCredentialId,
                                                           @NotNull
                                                           RestSharedCredential restSharedCredential,
                                                           @Context @NotNull
                                                           javax.ws.rs.core.UriInfo uriInfo)
                                                    throws WebValidationException

Update existing username/password shared credential.

Parameters:

sharedCredentialId - Id of the shared credential

restSharedCredential - New configuration

uriInfo - Provides information about current request

Returns:

Updated configuration of the username/password shared credential

Throws:

WebValidationException

deletePasswordSharedCredential

public javax.ws.rs.core.Response deletePasswordSharedCredential(long sharedCredentialId)

Delete the given username/password shared credential

Parameters:

sharedCredentialId - Id of the shared credential to be deleted

Returns:

Response indicates status of the deletion

validate

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