Package org.odpi.openmetadata.metadatasecurity.server

Class OpenMetadataPlatformSecurityVerifier

java.lang.Object

org.odpi.openmetadata.metadatasecurity.server.OpenMetadataPlatformSecurityVerifier

public class OpenMetadataPlatformSecurityVerifier
extends Object

OpenMetadataPlatformSecurityVerifier provides the plug-in point for the open metadata platform connector

Constructor Summary

Constructors

Constructor	Description
OpenMetadataPlatformSecurityVerifier()

Method Summary

Modifier and Type	Method	Description
static void	clearPlatformSecurityConnection(String userId, String delegatingUserId)	Clear the connection object for the configuration store.
static Connection	getPlatformSecurityConnection(String userId, String delegatingUserId)	Return the connection object for the configuration store.
static OpenMetadataUserAccount	getUser(String userId)	Return information about a user.
static void	setPlatformSecurityConnection(String userId, String delegatingUserId, String serverPlatformURL, Connection connection)	Override the default location of the configuration documents.
static void	validateUserAsInvestigatorForPlatform(String userId)	Check that the calling user is authorized to issue diagnostic requests to the OMAG Server Platform.
static void	validateUserAsOperatorForPlatform(String userId)	Check that the calling user is authorized to issue operator requests to the OMAG Server Platform.
static void	validateUserForNewServer(String userId)	Check that the calling user is authorized to create new servers.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenMetadataPlatformSecurityVerifier

public OpenMetadataPlatformSecurityVerifier()

Method Details

setPlatformSecurityConnection

public static void setPlatformSecurityConnection(String userId,
 String delegatingUserId,
 String serverPlatformURL,
 Connection connection)
                                          throws InvalidParameterException,
UserNotAuthorizedException

Override the default location of the configuration documents.

Parameters:

userId - calling user.

delegatingUserId - external userId making request

serverPlatformURL - URL Root of the server platform.

connection - connection used to create and configure the connector that interacts with the real store.

Throws:

InvalidParameterException - one of the properties is either null or invalid

UserNotAuthorizedException - the user is not authorized to access this platform

getPlatformSecurityConnection

public static Connection getPlatformSecurityConnection(String userId,
 String delegatingUserId)
                                                throws UserNotAuthorizedException

Return the connection object for the configuration store. Null is returned if the server should use the default store.

Parameters:

userId - calling user

delegatingUserId - external userId making request

Returns:

connection response

Throws:

UserNotAuthorizedException - the user is not authorized to access this platform

clearPlatformSecurityConnection

public static void clearPlatformSecurityConnection(String userId,
 String delegatingUserId)
                                            throws UserNotAuthorizedException

Clear the connection object for the configuration store. Null is returned if the server should use the default store.

Parameters:

userId - calling user

delegatingUserId - external userId making request

Throws:

UserNotAuthorizedException

getUser

public static OpenMetadataUserAccount getUser(String userId)

Return information about a user.

Parameters:

userId - user account identifier

Returns:

known details of the user

validateUserForNewServer

public static void validateUserForNewServer(String userId)
                                     throws UserNotAuthorizedException

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

Parameters:

userId - calling user

Throws:

UserNotAuthorizedException - the user is not authorized to access this platform

validateUserAsOperatorForPlatform

public static void validateUserAsOperatorForPlatform(String userId)
                                              throws UserNotAuthorizedException

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

Parameters:

userId - calling user

Throws:

UserNotAuthorizedException - the user is not authorized to issue operator commands to this platform

validateUserAsInvestigatorForPlatform

public static void validateUserAsInvestigatorForPlatform(String userId)
                                                  throws UserNotAuthorizedException

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

Parameters:

userId - calling user

Throws:

UserNotAuthorizedException - the user is not authorized to issue diagnostic commands to this platform