com.sap.cloud.security.spring.config.OAuth2ServiceConfigurationProperties Maven / Gradle / Ivy

Go to download
/**
 * SPDX-FileCopyrightText: 2018-2023 SAP SE or an SAP affiliate company and Cloud Security Client Java contributors
 * 
 * SPDX-License-Identifier: Apache-2.0
 */
package com.sap.cloud.security.spring.config;

import com.sap.cloud.security.config.*;

import java.net.URI;
import java.util.List;
import java.util.Map;
import java.util.Objects;

/**
 * PoJo of Spring configuration properties. It implements the {@link OAuth2ServiceConfiguration} and enhances it with
 * 

 * setters
 * Xsuaa specific setters to map Xsuaa specific configuration such as
 * {@code uaadomain}, {@code xsappname}
 * 
 * You can define your own prefix when declaring
 * {@code @ConfigurationProperties("xsuaa")}. This then needs to be mapped to
 * {@code $vcap.services..credentials} as part of
 * your application properties. 

 *
 * Alternatively, its possible to directly map the properties to
 * {@code VCAP_SERVICES} system environment variable: 

 * {@code @ConfigurationProperties("vcap.services..credentials")}
 */
public class OAuth2ServiceConfigurationProperties implements OAuth2ServiceConfiguration {
	final OAuth2ServiceConfigurationBuilder builder;
	OAuth2ServiceConfiguration configuration;

	/**
	 * Creates a new instance to map configuration of a dedicated identity service.
	 *
	 * @param service
	 * 		the kind of service
	 */
	public OAuth2ServiceConfigurationProperties(Service service) {
		builder = OAuth2ServiceConfigurationBuilder.forService(service);
	}

	@Override
	public String getClientId() {
		return getConfiguration().getClientId();
	}

	/**
	 * Sets client id of identity service instance.
	 *
	 * @param clientId
	 * 		client identifier
	 */
	public void setClientId(String clientId) {
		builder.withClientId(clientId);
	}

	/**
	 * Sets certificate of of identity service instance.
	 *
	 * @param certificate
	 * 		PEM encoded certificate
	 */
	public void setCertificate(String certificate) {
		builder.withCertificate(certificate);
	}

	/**
	 * Sets private key of identity service instance.
	 *
	 * @param key
	 * 		PEM encoded private key
	 */
	public void setKey(String key) {
		builder.withPrivateKey(key);
	}

	@Override
	public String getClientSecret() {
		return getConfiguration().getClientSecret();
	}

	/**
	 * Sets client secret of identity service instance.
	 *
	 * @param clientSecret
	 * 		client secret
	 */
	public void setClientSecret(String clientSecret) {
		builder.withClientSecret(clientSecret);
	}

	@Override
	public ClientIdentity getClientIdentity() {
		return getConfiguration().getClientIdentity();
	}

	@Override
	public CredentialType getCredentialType() {
		return getConfiguration().getCredentialType();
	}

	/**
	 * Sets credential type of identity service instance.
	 *
	 * @param credentialType
	 * 		the credential type
	 */
	public void setCredentialType(String credentialType) {
		builder.withCredentialType(
				Objects.requireNonNull(CredentialType.from(credentialType), "Credential-type must not be null"));
	}

	@Override
	public URI getCertUrl() {
		return getConfiguration().getCertUrl();
	}

	/**
	 * Sets cert url of identity service instance.
	 *
	 * @param certUrl
	 * 		the cert url
	 */
	public void setCertUrl(String certUrl) {
		builder.withCertUrl(certUrl);
	}

	@Override
	public URI getUrl() {
		return getConfiguration().getUrl();
	}

	@Override
	public List getDomains() {
		return getConfiguration().getDomains();
	}

	public void setDomains(String... domains) {
		builder.withDomains(domains);
	}

	/**
	 * Sets base URL of the OAuth2 identity service instance. In multi tenancy scenarios this is the url where the
	 * service instance was created.
	 *
	 * @param url
	 * 		base url
	 */
	public void setUrl(String url) {
		builder.withUrl(url);
	}

	/**
	 * Sets uaa domain of identity service instance.
	 *
	 * @param uaaDomain
	 * 		uaa domain
	 */
	public void setUaaDomain(String uaaDomain) {
		builder.withProperty(ServiceConstants.XSUAA.UAA_DOMAIN, uaaDomain);
	}

	/**
	 * Sets application name of xsuaa service instance.
	 *
	 * @param xsAppName
	 * 		the xsappname as specified in the {@code xs-security.json}.
	 */
	public void setXsAppName(String xsAppName) {
		builder.withProperty(ServiceConstants.XSUAA.APP_ID, xsAppName);
	}

	/**
	 * Sets the verification key of xsuaa service instance.
	 *
	 * @param verificationKey
	 * 		the verification key that provides the public key of the private key the token is signed with.
	 */
	public void setVerificationKey(String verificationKey) {
		builder.withProperty(ServiceConstants.XSUAA.VERIFICATION_KEY, verificationKey);
	}

	@Override
	public String getProperty(String name) {
		return getConfiguration().getProperty(name);
	}

	@Override
	public Map getProperties() {
		return getConfiguration().getProperties();
	}

	@Override
	public boolean hasProperty(String name) {
		return getConfiguration().hasProperty(name);
	}

	@Override
	public Service getService() {
		return getConfiguration().getService();
	}

	public void setName(String name) {
		builder.withProperty(ServiceConstants.NAME, name);
	}

	public String getName() {
		return getConfiguration().getProperty(ServiceConstants.NAME);
	}

	public void setPlan(String plan) {
		builder.withProperty(ServiceConstants.SERVICE_PLAN, plan);
	}

	public String getPlan() {
		return getConfiguration().getProperty(ServiceConstants.SERVICE_PLAN);
	}

	@Override
	public boolean isLegacyMode() {
		return getConfiguration().isLegacyMode();
	}

	protected OAuth2ServiceConfiguration getConfiguration() {
		if (configuration == null) {
			configuration = builder.build();
		}
		return configuration;
	}
}