com.atlassian.bamboo.plugins.rest.admin.imserver

Class IMServerResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.imserver.IMServerResource

public class IMServerResource
extends Object

Rest endpoint to manage Instant Messenger configuration in bamboo

Since:

5.10

Field Summary

Fields

Modifier and Type	Field and Description
static RestIMServerConfiguration	IM_SERVER_CONFIG

Constructor Summary

Constructors

Constructor and Description
IMServerResource(InstantMessagingServerManager instantMessagingServerManager, RestPermissionCheck permissionCheck, IMServerConfigurationConversionFunction function)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteIMServerConfiguration() Delete current IM Server configuration
RestIMServerConfiguration	getIMServerConfig(Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) REST endpoint to get instant message server configurations in bamboo.
RestIMServerConfiguration	updateIMServerConfig(RestIMServerConfiguration restIMServerConfiguration, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) Update or create existing IM server configuration in bamboo.

Methods inherited from class java.lang.Object

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

Field Detail

IM_SERVER_CONFIG

public static final RestIMServerConfiguration IM_SERVER_CONFIG

Constructor Detail

IMServerResource

public IMServerResource(InstantMessagingServerManager instantMessagingServerManager,
                        RestPermissionCheck permissionCheck,
                        IMServerConfigurationConversionFunction function)

Method Detail

getIMServerConfig

@NotNull
public RestIMServerConfiguration getIMServerConfig(@Context
                                                            Expansion expansion,
                                                            @Context
                                                            javax.ws.rs.core.UriInfo uriInfo)

REST endpoint to get instant message server configurations in bamboo. Password will be returned in salted hash.

Parameters:

expansion -

uriInfo -

Returns:

IM server configuration

deleteIMServerConfiguration

@NotNull
public javax.ws.rs.core.Response deleteIMServerConfiguration()

Delete current IM Server configuration

updateIMServerConfig

@NotNull
public RestIMServerConfiguration updateIMServerConfig(@NotNull
                                                               RestIMServerConfiguration restIMServerConfiguration,
                                                               @Context @NotNull
                                                               Expansion expansion,
                                                               @Context @NotNull
                                                               javax.ws.rs.core.UriInfo uriInfo)
                                                        throws WebValidationException

Update or create existing IM server configuration in bamboo. If IM server is already configured in bamboo, update existing configuration. Otherwise, create IM server configuration

Parameters:

restIMServerConfiguration - IM server configuration

Returns:

Updated configuration of IM server

Throws:

WebValidationException