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:

AccessServerServiceInstanceHandler, GovernanceServerServiceInstanceHandler, OMVSServiceInstanceHandler

public abstract class AuditableServerServiceInstanceHandler
extends OMAGServerServiceInstanceHandler

AuditableServerServiceInstanceHandler supports registered services that have an audit log.

Field Summary

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

platformInstanceMap, serviceName

Method Summary

Modifier and Type	Method	Description
AuditLog	getAuditLog(String userId, String serverName, String serviceOperationName)	Return the audit log for this access service and server.
AuditLog	getAuditLog(String userId, String delegatingUserId, 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, getServerServiceInstance, getServerServiceInstance, getServiceName, isServerActive, removeServerServiceInstance

Methods inherited from class java.lang.Object

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

Method Details

getAuditLog

public AuditLog getAuditLog(String userId,
 String serverName,
 String serviceOperationName)
                     throws InvalidParameterException,
UserNotAuthorizedException,
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:

InvalidParameterException - the server name is not known

UserNotAuthorizedException - the user is not authorized to issue the request.

PropertyServerException - the service name is not known or the metadata collection is not available - indicating a logic error

getAuditLog

public AuditLog getAuditLog(String userId,
 String delegatingUserId,
 String serverName,
 String serviceOperationName)
                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the audit log for this access service and server.

Parameters:

userId - calling userId

delegatingUserId - external userId making request

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:

InvalidParameterException - the server name is not known

UserNotAuthorizedException - the user is not authorized to issue the request.

PropertyServerException - the service name is not known or the metadata collection is not available - indicating a logic error