Package org.odpi.openmetadata.metadatasecurity

Interface OpenMetadataPlatformSecurity

All Known Implementing Classes:

OpenMetadataAccessSecurityConnector, OpenMetadataPlatformSecurityConnector

public interface OpenMetadataPlatformSecurity

OpenMetadataPlatformSecurity provides the interface for a security connector that validates whether a calling user can access any service on an OMAG Server Platform. It is called within the context of a specific OMAG Server Platform request. Each OMAG Server can also define its own plugin connector implementation and will have its own instance of that connector.

Method Summary

Modifier and Type	Method	Description
void	setPlatformName(String platformName)	Set up the name for the platform where this is running.
void	validateUserAsInvestigatorForPlatform(String userId)	Check that the calling user is authorized to issue diagnostic requests to the OMAG Server Platform.
void	validateUserAsOperatorForPlatform(String userId)	Check that the calling user is authorized to issue operator requests to the OMAG Server Platform.
void	validateUserForNewServer(String userId)	Check that the calling user is authorized to create new servers.

Method Details

setPlatformName

void setPlatformName(String platformName)

Set up the name for the platform where this is running. This is used in log messages.

Parameters:

platformName - name

validateUserForNewServer

void validateUserForNewServer(String userId)
                       throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Check that the calling user is authorized to create new servers.

Parameters:

userId - calling user

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.

validateUserAsOperatorForPlatform

void validateUserAsOperatorForPlatform(String userId)
                                throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Check that the calling user is authorized to issue operator requests to the OMAG Server Platform.

Parameters:

userId - calling user

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.

validateUserAsInvestigatorForPlatform

void validateUserAsInvestigatorForPlatform(String userId)
                                    throws UserNotAuthorizedException,
InvalidParameterException,
PropertyServerException

Check that the calling user is authorized to issue diagnostic requests to the OMAG Server Platform.

Parameters:

userId - calling user

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.