Package org.odpi.openmetadata.metadatasecurity

Interface OpenMetadataServiceSecurity

All Known Implementing Classes:

OpenMetadataAccessSecurityConnector, OpenMetadataServerSecurityVerifier

public interface OpenMetadataServiceSecurity

OpenMetadataServiceSecurity provides the interface for a plugin connector that validates whether a calling user can access a specific metadata service. It is called within the context of a specific OMAG Server. Each OMAG Server can define its own plugin connector implementation and will have its own instance of the connector. However the server name is supplied so a single connector can use it for logging error messages and locating the valid user list for the server.

Method Summary

Modifier and Type	Method	Description
void	validateUserForService(String userId, String serviceName)	Check that the calling user is authorized to issue this request.
void	validateUserForServiceOperation(String userId, String serviceName, String operationName)	Check that the calling user is authorized to issue this specific request.

Method Details

validateUserForService

void validateUserForService(String userId,
 String serviceName)
                     throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Check that the calling user is authorized to issue this request.

Parameters:

userId - calling user

serviceName - name of called service

Throws:

InvalidParameterException - one of the elements is invisible to the requesting user.

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

PropertyServerException - unable to retrieve necessary information to make the decision.

validateUserForServiceOperation

void validateUserForServiceOperation(String userId,
 String serviceName,
 String operationName)
                              throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Check that the calling user is authorized to issue this specific request.

Parameters:

userId - calling user

serviceName - name of called service

operationName - name of called operation

Throws:

InvalidParameterException - one of the elements is invisible to the requesting user.

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

PropertyServerException - unable to retrieve necessary information to make the decision.