com.atlassian.plugins.authentication.sso.rest

Class IdpsResourceService

java.lang.Object

com.atlassian.plugins.authentication.sso.rest.IdpsResourceService

@Named
public class IdpsResourceService
extends Object

Constructor Summary

Constructors

Constructor and Description
IdpsResourceService(IdpConfigService idpConfigService, ApplicationStateValidator applicationStateValidator)

Method Summary

Modifier and Type	Method and Description
IdpConfigEntity	addConfig(IdpConfigEntity entity) Update configuration of SSO from the data from IdpConfigEntity.
IdpConfigEntity	getConfig(Long id)
List<IdpConfigEntity>	getConfigs(RestPageRequest pageRequest)
IdpConfigEntity	removeConfig(Long id)
IdpConfigEntity	updateConfig(Long id, IdpConfigEntity entity)

Methods inherited from class java.lang.Object

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

Constructor Detail

IdpsResourceService

@Inject
public IdpsResourceService(IdpConfigService idpConfigService,
                                   ApplicationStateValidator applicationStateValidator)

Method Detail

getConfigs

@Nonnull
public List<IdpConfigEntity> getConfigs(RestPageRequest pageRequest)

Parameters:

pageRequest - determines how the results should be paged

Returns:

the currently configured IdPs, paged as requested

getConfig

public IdpConfigEntity getConfig(Long id)

addConfig

@Nonnull
public IdpConfigEntity addConfig(@Nonnull
                                          IdpConfigEntity entity)

Update configuration of SSO from the data from IdpConfigEntity.

The entity may provide all the necessary fields to configure a given IdP, but it may also provide partial data to be updated. The latter behaviour will only work if the SSO protocol remains unchanged after the update.

Returns:

data effectively persisted to the DB

Throws:

InvalidConfigException - if the config is invalid due to user input errors

IllegalArgumentException - if the config is invalid due to wrong usage of the REST API

InsecureUrlException - if HTTPS protocol is not used

InvalidLicenseException - if the current product license does not allow the given SSO setup

updateConfig

@Nonnull
public IdpConfigEntity updateConfig(Long id,
                                             @Nonnull
                                             IdpConfigEntity entity)

removeConfig

public IdpConfigEntity removeConfig(Long id)