Package org.odpi.openmetadata.metadatasecurity

Interface OpenMetadataServerSecurity

All Known Implementing Classes:

OpenMetadataAccessSecurityConnector, OpenMetadataServerSecurityVerifier

public interface OpenMetadataServerSecurity

OpenMetadataServerSecurity provides the root interface for a connector that validates access to Open Metadata services and instances for a specific user. There are other optional interfaces that define which actions should be validated. Connectors are installed into a specific OMAG Server Instance

Method Summary

Modifier and Type	Method	Description
void	validateUserAsServerAdmin(String userId)	Check that the calling user is authorized to update the configuration for a server.
void	validateUserAsServerInvestigator(String userId)	Check that the calling user is authorized to issue operator requests to the OMAG Server.
void	validateUserAsServerOperator(String userId)	Check that the calling user is authorized to issue operator requests to the OMAG Server.
void	validateUserForServer(String userId)	Check that the calling user is authorized to issue a (any) request to the OMAG Server.

Method Details

validateUserForServer

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

Check that the calling user is authorized to issue a (any) request to the OMAG Server.

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.

validateUserAsServerAdmin

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

Check that the calling user is authorized to update the configuration for a server.

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.

validateUserAsServerOperator

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

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

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.

validateUserAsServerInvestigator

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

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

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.