Package org.odpi.openmetadata.accessservices.securityofficer.server.services

Class SecurityOfficerInstanceHandler

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.OMASServiceInstanceHandler

org.odpi.openmetadata.accessservices.securityofficer.server.services.SecurityOfficerInstanceHandler

public class SecurityOfficerInstanceHandler
extends OMASServiceInstanceHandler

GovernanceEngineServiceInstanceHandler retrieves information from the instance map for the access service instances. The instance map is thread-safe. Instances are added and removed by the GovernanceEngineAdmin class.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

platformInstanceMap, serviceName

Constructor Summary

Constructors

Constructor	Description
SecurityOfficerInstanceHandler()	Default constructor registers the access service

Method Summary

Modifier and Type	Method	Description
GovernedAssetHandler	getGovernedAssetHandler(String userId, String serverName, String serviceOperationName)	Retrieve the governance assets handler for the access service
SecurityOfficerRequestHandler	getSecurityOfficerRequestHandler(String userId, String serverName, String serviceOperationName)	Retrieve the governance assets handler for the access service

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.OMASServiceInstanceHandler

getDefaultZones, getDefaultZones, getErrorHandler, getExceptionHandler, getInTopicConnection, getMetadataCollection, getOutTopicConnection, getPublishZones, getPublishZones, getRepositoryConnector, getRepositoryHandler, getRepositoryHelper, getServiceName, getSupportedZones, getSupportedZones

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

getAuditLog

Methods inherited from class org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

getServerSecurityVerifier, getServerServiceInstance, getServiceName, isServerActive, removeServerServiceInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityOfficerInstanceHandler

public SecurityOfficerInstanceHandler()

Default constructor registers the access service

Method Detail

getSecurityOfficerRequestHandler

public SecurityOfficerRequestHandler getSecurityOfficerRequestHandler(String userId,
                                                                      String serverName,
                                                                      String serviceOperationName)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException

Retrieve the governance assets handler for the access service

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - the service name is not known - indicating a logic error

getGovernedAssetHandler

public GovernedAssetHandler getGovernedAssetHandler(String userId,
                                                    String serverName,
                                                    String serviceOperationName)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Retrieve the governance assets handler for the access service

Parameters:

userId - calling user

serverName - name of the server tied to the request

serviceOperationName - name of the REST API call (typically the top-level methodName)

Returns:

handler for use by the requested instance

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - the service name is not known - indicating a logic error