Class DataManagerBaseClient
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient
-
- Direct Known Subclasses:
DatabaseManagerClient
,MetadataSourceClient
,SchemaManagerClient
,ValidValueManagement
public class DataManagerBaseClient extends java.lang.Object
DataManagerBaseClient supports the common properties and functions for the Data Manager OMAS.
-
-
Constructor Summary
Constructors Constructor Description DataManagerBaseClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
Create a new client with no authentication embedded in the HTTP request.DataManagerBaseClient(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.DataManagerBaseClient(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.DataManagerBaseClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize)
Create a new client that is going to be used in an OMAG Server.DataManagerBaseClient(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 void
removeReferenceable(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String elementGUIDParameterName, java.lang.String urlTemplate, java.lang.String methodName)
Remove the metadata element.
-
-
-
Constructor Detail
-
DataManagerBaseClient
public DataManagerBaseClient(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.
-
DataManagerBaseClient
public DataManagerBaseClient(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.
-
DataManagerBaseClient
public DataManagerBaseClient(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.
-
DataManagerBaseClient
public DataManagerBaseClient(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.
-
DataManagerBaseClient
public DataManagerBaseClient(java.lang.String serverName, java.lang.String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize) throws InvalidParameterException
Create a new client that is going to be used in an OMAG Server.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST serversrestClient
- client that issues the REST API callsmaxPageSize
- maximum number of results supported by this server- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
-
Method Detail
-
removeReferenceable
public void removeReferenceable(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String elementGUIDParameterName, java.lang.String urlTemplate, java.lang.String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove the metadata element.- Parameters:
userId
- calling userexternalSourceGUID
- unique identifier of software capability representing the callerexternalSourceName
- unique name of software capability representing the callerelementGUID
- unique identifier of the metadata element to removeelementGUIDParameterName
- name of parameter passing the elementGUIDurlTemplate
- URL to call (no expected placeholders)methodName
- calling method- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
-