Package lumis.portal.monitor.impl

Class AbstractMonitorResource

java.lang.Object

lumis.portal.monitor.impl.AbstractMonitorResource

Direct Known Subclasses:

AbstractResourceForDouiAdministrations, CustomerExperienceResource, EventAnalyticsReportResource, EventAnalyticsResource, FlowResource, UserAttributesResource, UserSegmentationRestAPI

public abstract class AbstractMonitorResource
extends java.lang.Object

Abstract class to aid Monitor-related REST resources.

Since:

14.0.0

Version:

$Revision: 24836 $ $Date: 2022-02-07 13:32:15 -0300 (Mon, 07 Feb 2022) $

Field Summary

Fields

Modifier and Type	Field	Description
protected CustomerExperienceApp	app

Constructor Summary

Constructors

Constructor	Description
AbstractMonitorResource(CustomerExperienceApp app)

Method Summary

Modifier and Type	Method	Description
ServiceInstanceConfig	checkModeManagePermission(java.lang.String serviceInstanceId)	Checks user has the required manage permissions.
static ServiceInstanceConfig	checkModeManagePermission(CustomerExperienceApp app, java.lang.String serviceInstanceId)	Checks user has the required manage permissions.
ServiceInstanceConfig	checkModeViewPermission(java.lang.String serviceInstanceId)	Checks user has the required view permissions.
ServiceInstanceConfig	checkModeViewPermission(CustomerExperienceApp app, java.lang.String serviceInstanceId)	Checks user has the required view permissions.
static ServiceInstanceConfig	checkViewServiceInstancePermission(java.lang.String serviceInstanceId)	Checks user has the required view service instance permission.

Methods inherited from class java.lang.Object

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

Field Detail

app

protected final CustomerExperienceApp app

Constructor Detail

AbstractMonitorResource

public AbstractMonitorResource(CustomerExperienceApp app)

Method Detail

checkModeViewPermission

public ServiceInstanceConfig checkModeViewPermission(CustomerExperienceApp app,
                                                     java.lang.String serviceInstanceId)
                                              throws PortalException

Checks user has the required view permissions.

Parameters:

app - the customer app to which the permission should be checked.

serviceInstanceId - the service instance identifier.

Throws:

java.lang.IllegalArgumentException - if the given service instance identifier is null or an empty string.

java.lang.IllegalArgumentException - if the given service instance identifier refers to a service other than customer experience.

PortalObjectNotFoundException - if no service instance was found with the given identifier.

PortalException - if some error occur during the service instance reading.

AccessDeniedException - if the user doesn't have the requested permission.

Since:

14.0.0

checkModeManagePermission

public static ServiceInstanceConfig checkModeManagePermission(CustomerExperienceApp app,
                                                              java.lang.String serviceInstanceId)
                                                       throws PortalException

Checks user has the required manage permissions.

Parameters:

app - the customer app to which the permission should be checked.

serviceInstanceId - the service instance identifier.

Throws:

java.lang.IllegalArgumentException - if the given service instance identifier is null or an empty string.

java.lang.IllegalArgumentException - if the given service instance identifier refers to a service other than customer experience.

PortalObjectNotFoundException - if no service instance was found with the given identifier.

PortalException - if some error occur during the service instance reading.

AccessDeniedException - if the user doesn't have the requested permission.

Since:

14.0.0

checkModeViewPermission

public ServiceInstanceConfig checkModeViewPermission(java.lang.String serviceInstanceId)
                                              throws PortalException

Checks user has the required view permissions.

Parameters:

serviceInstanceId - the service instance identifier.

Throws:

java.lang.IllegalArgumentException - if the given service instance identifier is null or an empty string.

java.lang.IllegalArgumentException - if the given service instance identifier refers to a service other than customer experience.

PortalObjectNotFoundException - if no service instance was found with the given identifier.

PortalException - if some error occur during the service instance reading.

AccessDeniedException - if the user doesn't have the requested permission.

Since:

14.0.0

checkModeManagePermission

public ServiceInstanceConfig checkModeManagePermission(java.lang.String serviceInstanceId)
                                                throws PortalException

Checks user has the required manage permissions.

Parameters:

serviceInstanceId - the service instance identifier.

Throws:

java.lang.IllegalArgumentException - if the given service instance identifier is null or an empty string.

java.lang.IllegalArgumentException - if the given service instance identifier refers to a service other than customer experience.

PortalObjectNotFoundException - if no service instance was found with the given identifier.

PortalException - if some error occur during the service instance reading.

AccessDeniedException - if the user doesn't have the requested permission.

Since:

14.0.0

checkViewServiceInstancePermission

public static ServiceInstanceConfig checkViewServiceInstancePermission(java.lang.String serviceInstanceId)
                                                                throws PortalException

Checks user has the required view service instance permission.

Parameters:

serviceInstanceId - the service instance identifier.

Throws:

java.lang.IllegalArgumentException - if the given service instance identifier is null or an empty string.

java.lang.IllegalArgumentException - if the given service instance identifier refers to a service other than customer experience.

PortalObjectNotFoundException - if no service instance was found with the given identifier.

PortalException - if some error occur during the service instance reading.

AccessDeniedException - if the user doesn't have the requested permission.

Since:

14.0.0