Package org.odpi.openmetadata.commonservices.multitenant

Class AuditableServerServiceInstanceHandler

java.lang.Object

org.odpi.openmetadata.commonservices.multitenant.OMAGServerServiceInstanceHandler

org.odpi.openmetadata.commonservices.multitenant.AuditableServerServiceInstanceHandler

Direct Known Subclasses:

GovernanceServerServiceInstanceHandler, OMASServiceInstanceHandler, OMVSServiceInstanceHandler

public abstract class AuditableServerServiceInstanceHandler
extends OMAGServerServiceInstanceHandler

AuditableServerServiceInstanceHandler supports registered services that have an audit log.

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.frameworks.auditlog.AuditLog	getAuditLog(String userId, String serverName, String serviceOperationName)	Return the audit log for this access service and server.

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

getServerSecurityVerifier, getServiceName, isServerActive, removeServerServiceInstance

Methods inherited from class java.lang.Object

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

Method Details

getAuditLog

public org.odpi.openmetadata.frameworks.auditlog.AuditLog getAuditLog(String userId,
 String serverName,
 String serviceOperationName)
                                                               throws org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException,
org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException,
org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException

Return the audit log for this access service and server.

Parameters:

userId - calling userId

serverName - name of the server tied to the request

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

Returns:

audit log

Throws:

org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException - the server name is not known

org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException - the user is not authorized to issue the request.

org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException - the service name is not known or the metadata collection is not available - indicating a logic error