Package com.sap.cloud.mt.subscription

Class SubscriberImpl

java.lang.Object

com.sap.cloud.mt.subscription.SubscriberImpl

All Implemented Interfaces:

Subscriber

public class SubscriberImpl
extends Object
implements Subscriber

Class Subscriber provides methods to subscribe new tenants, start DB artifact deployments and unsubscribe tenants.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_TENANTS

Method Summary

Modifier and Type	Method	Description
void	callSaasRegistry(boolean ok, String message, String applicationUrl, String saasRegistryUrl)	Calls the saas registry.
void	checkAuthority(SecurityChecker.Authority authority)
String	createInstanceAndOnBoard(String tenantId, SubscriptionPayload subscriptionPayload, String url, com.sap.xsa.core.instancemanager.client.InstanceCreationOptions instanceCreationOptions, AfterSubscribeMethod exit)
List<ApplicationDependency>	getApplicationDependencies()	Returns the list of microservices the program depends on
DbDeployer	getDbDeployer()
String	getSubscribeUrl(SubscriptionPayload subscriptionPayload)	Gets the URL of the saas application
void	setupDbTables(List<String> tenants)	Starts hdi deployment for the specified already subscribed tenants.
String	setupDbTablesAsync(List<String> tenants)	Starts hdi deployment for the specified already subscribed tenants asynchronously.
String	subscribe(String tenantId, SubscriptionPayload subscriptionPayload, String jwt)	Subscribes the specified tenant synchronously.
void	unsubscribe(String tenantId, DeletePayload deletePayload, String jwt)	Unsubscribes the specified tenant synchronously
String	updateStatus(String jobId)	Returns the status of an asynchronous upgrade operation.

Methods inherited from class java.lang.Object

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

Field Details

ALL_TENANTS

public static final String ALL_TENANTS

See Also:

• Constant Field Values

Method Details

unsubscribe

public void unsubscribe(String tenantId,
 DeletePayload deletePayload,
 String jwt)
                 throws InternalError,
ParameterError,
AuthorityError

Description copied from interface: Subscriber

Unsubscribes the specified tenant synchronously

Specified by:

unsubscribe in interface Subscriber

Parameters:

tenantId - the tenant identifier

deletePayload - Information provided by CIS about the subscribed application

jwt - OAuth2 authorization token

Throws:

InternalError - is thrown if instance manager reports an error

ParameterError - is thrown if needed configuration parameters aren't set

AuthorityError - is thrown in case of missing authority

getApplicationDependencies

public List<ApplicationDependency> getApplicationDependencies()
                                                       throws AuthorityError

Description copied from interface: Subscriber

Returns the list of microservices the program depends on

Specified by:

getApplicationDependencies in interface Subscriber

Returns:

list of dependent microservices

Throws:

AuthorityError

subscribe

public String subscribe(String tenantId,
 SubscriptionPayload subscriptionPayload,
 String jwt)
                 throws InternalError,
ParameterError,
AuthorityError

Description copied from interface: Subscriber

Subscribes the specified tenant synchronously.

Specified by:

subscribe in interface Subscriber

Parameters:

tenantId - is the tenant identifier

subscriptionPayload - is provided by CIS and describes the subscribing application

jwt - OAuth2 authorization token

Returns:

The URL of the application UI

Throws:

InternalError - is thrown if instance manager or hdi deployment app report an error

ParameterError - is thrown if needed configuration parameters aren't set

AuthorityError - is thrown in case of missing authority

getSubscribeUrl

public String getSubscribeUrl(SubscriptionPayload subscriptionPayload)
                       throws InternalError,
ParameterError,
AuthorityError

Description copied from interface: Subscriber

Gets the URL of the saas application

Specified by:

getSubscribeUrl in interface Subscriber

Parameters:

subscriptionPayload - is provided by CIS and describes the subscribing application

Returns:

The URL of the application UI

Throws:

InternalError - is thrown if instance manager or hdi deployment app report an error

ParameterError - is thrown if needed configuration parameters aren't set

AuthorityError - is thrown in case of missing authority

setupDbTables

public void setupDbTables(List<String> tenants)
                   throws InternalError,
ParameterError,
AuthorityError

Description copied from interface: Subscriber

Starts hdi deployment for the specified already subscribed tenants.

Specified by:

setupDbTables in interface Subscriber

Parameters:

tenants - is the list of tenant identifiers, if it contains only one entry "all" all tenants are updated

Throws:

InternalError - is thrown if the hdi deployment app reports an error

ParameterError - is thrown if needed configuration parameters aren't set

AuthorityError - is thrown in case of missing authority

setupDbTablesAsync

public String setupDbTablesAsync(List<String> tenants)
                          throws ParameterError,
AuthorityError

Description copied from interface: Subscriber

Starts hdi deployment for the specified already subscribed tenants asynchronously.

Specified by:

setupDbTablesAsync in interface Subscriber

Parameters:

tenants - is the list of tenant identifiers, if it contains only one entry "all" all tenants are updated

Returns:

JobId if sidecar is used, otherwise empty

Throws:

ParameterError - is thrown if needed configuration parameters aren't set

AuthorityError - is thrown in case of missing authority

updateStatus

public String updateStatus(String jobId)
                    throws NotSupported,
InternalError,
AuthorityError

Description copied from interface: Subscriber

Returns the status of an asynchronous upgrade operation. Only supported for sidecar.

Specified by:

updateStatus in interface Subscriber

Parameters:

jobId - returned from sidecar

Returns:

Returns a sidecar json :{ "error": null, "status": "RUNNING", "result": null }

Throws:

NotSupported - is thrown if operation is not supported by subscriber implementation

InternalError - is thrown if sidecar cannot be accessed.

AuthorityError - is thrown in case of missing authority

callSaasRegistry

public void callSaasRegistry(boolean ok,
 String message,
 String applicationUrl,
 String saasRegistryUrl)
                      throws InternalError

Description copied from interface: Subscriber

Calls the saas registry.

Specified by:

callSaasRegistry in interface Subscriber

Parameters:

ok - Operation worked.

message - Message returned to customers.

applicationUrl - Must be filled in case of subscription. The URL under which the UI of the subscribed application can be reached.

saasRegistryUrl - The callback URL provided by CIS.

Throws:

InternalError - Thrown in case the saas registry couldn't be called.

checkAuthority

public void checkAuthority(SecurityChecker.Authority authority)
                    throws AuthorityError

Specified by:

checkAuthority in interface Subscriber

Throws:

AuthorityError - thrown if authority is missing

createInstanceAndOnBoard

public String createInstanceAndOnBoard(String tenantId,
 SubscriptionPayload subscriptionPayload,
 String url,
 com.sap.xsa.core.instancemanager.client.InstanceCreationOptions instanceCreationOptions,
 AfterSubscribeMethod exit)
                                throws InternalError

Throws:

InternalError

getDbDeployer

public DbDeployer getDbDeployer()