Class MetadataSourceClient
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.securitymanager.client.SecurityManagerBaseClient
-
- org.odpi.openmetadata.accessservices.securitymanager.client.MetadataSourceClient
-
- All Implemented Interfaces:
MetadataSourceInterface
public class MetadataSourceClient extends SecurityManagerBaseClient implements MetadataSourceInterface
MetadataSourceClient is the client for setting up the SoftwareServerCapabilities that represent metadata sources.
-
-
Constructor Summary
Constructors Constructor Description MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
Create a new client with no authentication embedded in the HTTP request.MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
Create a new client that passes userId and password in each HTTP request.MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
Create a new client that passes userId and password in each HTTP request.MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, SecurityManagerRESTClient restClient, int maxPageSize)
Create a new client that is to be used within an OMAG Server.MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
Create a new client with no authentication embedded in the HTTP request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
createExternalSecurityManager(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String typeName, SecurityManagerProperties securityManagerProperties)
Create information about a security manager such as a user access directory - such as an LDAP server or access control manager such as Apache Ranger.java.lang.String
getExternalSecurityManagerGUID(java.lang.String userId, java.lang.String qualifiedName)
Retrieve the unique identifier of the integration daemon.-
Methods inherited from class org.odpi.openmetadata.accessservices.securitymanager.client.SecurityManagerBaseClient
removeReferenceable
-
-
-
-
Constructor Detail
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog) throws InvalidParameterException
Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST serversauditLog
- logging destination- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot) throws InvalidParameterException
Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servers- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog) throws InvalidParameterException
Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST serversuserId
- caller's userId embedded in all HTTP requestspassword
- caller's userId embedded in all HTTP requestsauditLog
- logging destination- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password) throws InvalidParameterException
Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST serversuserId
- caller's userId embedded in all HTTP requestspassword
- caller's userId embedded in all HTTP requests- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
MetadataSourceClient
public MetadataSourceClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, SecurityManagerRESTClient restClient, int maxPageSize) throws InvalidParameterException
Create a new client that is to be used within an OMAG Server.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST serversrestClient
- pre-initialized REST clientmaxPageSize
- pre-initialized parameter limit- Throws:
InvalidParameterException
- there is a problem with the information about the remote OMAS
-
-
Method Detail
-
createExternalSecurityManager
public java.lang.String createExternalSecurityManager(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String typeName, SecurityManagerProperties securityManagerProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Create information about a security manager such as a user access directory - such as an LDAP server or access control manager such as Apache Ranger.- Specified by:
createExternalSecurityManager
in interfaceMetadataSourceInterface
- Parameters:
userId
- calling userexternalSourceGUID
- guid of the software server capability entity that represented the external source - null for localexternalSourceName
- name of the software server capability entity that represented the external sourcetypeName
- type name for the software server capabilitysecurityManagerProperties
- description of the security manager- Returns:
- unique identifier of the user directory's software server capability
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
getExternalSecurityManagerGUID
public java.lang.String getExternalSecurityManagerGUID(java.lang.String userId, java.lang.String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the unique identifier of the integration daemon.- Specified by:
getExternalSecurityManagerGUID
in interfaceMetadataSourceInterface
- Parameters:
userId
- calling userqualifiedName
- unique name of the integration daemon- Returns:
- unique identifier of the integration daemon's software server capability
- Throws:
InvalidParameterException
- the bean properties are invalidUserNotAuthorizedException
- user not authorized to issue this requestPropertyServerException
- problem accessing the property server
-
-