Skip to content

Commit

Permalink
Merge pull request #7967 from odttlnt/issue7857
Browse files Browse the repository at this point in the history
Add framework clients to OMASs
  • Loading branch information
mandy-chessell authored Dec 30, 2023
2 parents 6babe5f + 7609d2a commit 8e84a9b
Show file tree
Hide file tree
Showing 55 changed files with 1,653 additions and 36 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.assetcatalog;

import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase;

/**
* ConnectedAssetClient manages the retrieval of connections, and the creation of resource connectors used to access the
* content of data sources and services.
*/
public class ConnectedAssetClient extends ConnectedAssetClientBase
{
private final static String serviceURLMarker = "asset-catalog";

/**
* Create a new client with no authentication embedded in the HTTP request.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
*
* @throws InvalidParameterException there is a problem creating the client-side components to issue any
* REST API calls.
*/
public ConnectedAssetClient(String serverName,
String serverPlatformURLRoot) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot);
}


/**
* 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.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
* @param serverUserId caller's userId embedded in all HTTP requests
* @param serverPassword 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.
*/
public ConnectedAssetClient(String serverName,
String serverPlatformURLRoot,
String serverUserId,
String serverPassword) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot, serverUserId, serverPassword);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.assetconsumer.client;

import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase;

/**
* ConnectedAssetClient manages the retrieval of connections, and the creation of resource connectors used to access the
* content of data sources and services.
*/
public class ConnectedAssetClient extends ConnectedAssetClientBase
{
private final static String serviceURLMarker = "asset-consumer";

/**
* Create a new client with no authentication embedded in the HTTP request.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
*
* @throws InvalidParameterException there is a problem creating the client-side components to issue any
* REST API calls.
*/
public ConnectedAssetClient(String serverName,
String serverPlatformURLRoot) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot);
}


/**
* 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.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
* @param serverUserId caller's userId embedded in all HTTP requests
* @param serverPassword 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.
*/
public ConnectedAssetClient(String serverName,
String serverPlatformURLRoot,
String serverUserId,
String serverPassword) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot, serverUserId, serverPassword);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,19 @@ description = 'Asset Lineage OMAS Client'


dependencies {
implementation project(':open-metadata-implementation:framework-services:ocf-metadata-management:ocf-metadata-api')
implementation project(':open-metadata-implementation:framework-services:ocf-metadata-management:ocf-metadata-client')
implementation project(':open-metadata-implementation:framework-services:gaf-metadata-management:gaf-metadata-api')
implementation project(':open-metadata-implementation:framework-services:gaf-metadata-management:gaf-metadata-client')
implementation project(':open-metadata-implementation:framework-services:oif-metadata-management:oif-metadata-api')
implementation project(':open-metadata-implementation:framework-services:oif-metadata-management:oif-metadata-client')
implementation project(':open-metadata-implementation:repository-services:repository-services-apis')
implementation project(':open-metadata-implementation:frameworks:audit-log-framework')
implementation project(':open-metadata-implementation:frameworks:governance-action-framework')
implementation project(':open-metadata-implementation:frameworks:open-connector-framework')
implementation project(':open-metadata-implementation:frameworks:open-integration-framework')
implementation project(':open-metadata-implementation:common-services:ffdc-services')
implementation project(':open-metadata-implementation:adapters:open-connectors:rest-client-connectors:rest-client-connectors-api')
implementation project(':open-metadata-implementation:repository-services:repository-services-apis')
implementation 'org.springframework:spring-core'
testImplementation 'org.mockito:mockito-core'
testImplementation 'junit:junit'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.assetlineage;

import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase;

/**
* ConnectedAssetClient manages the retrieval of connections, and the creation of resource connectors used to access the
* content of data sources and services.
*/
public class ConnectedAssetClient extends ConnectedAssetClientBase
{
private final static String serviceURLMarker = "community-profile";

/**
* Create a new client with no authentication embedded in the HTTP request.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
*
* @throws InvalidParameterException there is a problem creating the client-side components to issue any
* REST API calls.
*/
public ConnectedAssetClient(String serverName,
String serverPlatformURLRoot) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot);
}


/**
* 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.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
* @param serverUserId caller's userId embedded in all HTTP requests
* @param serverPassword 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.
*/
public ConnectedAssetClient(String serverName,
String serverPlatformURLRoot,
String serverUserId,
String serverPassword) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot, serverUserId, serverPassword);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.assetlineage;

import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase;

/**
* OpenMetadataClientBase provides an interface to the open metadata store. This is part of the Governance Action Framework (GAF)
* and provides a comprehensive interface for working with all types of metadata, subject to the user's (and this OMAS's) security permissions.
* The interface supports search, maintenance of metadata elements, classifications and relationships plus the ability to raise incident reports
* and todos along with the ability to work with metadata valid values and translations.
*/
public class OpenMetadataStoreClient extends OpenMetadataClientBase
{
private final static String serviceURLMarker = "asset-lineage";

/**
* Create a new client with no authentication embedded in the HTTP request.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
*
* @throws InvalidParameterException there is a problem creating the client-side components to issue any
* REST API calls.
*/
public OpenMetadataStoreClient(String serverName,
String serverPlatformURLRoot) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot);
}


/**
* 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.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
* @param serverUserId caller's userId embedded in all HTTP requests
* @param serverPassword caller's password embedded in all HTTP requests
*
* @throws InvalidParameterException there is a problem creating the client-side components to issue any
* REST API calls.
*/
public OpenMetadataStoreClient(String serverName,
String serverPlatformURLRoot,
String serverUserId,
String serverPassword) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot, serverUserId, serverPassword);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
package org.odpi.openmetadata.accessservices.assetmanager.client;

import org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription;
import org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase;
import org.odpi.openmetadata.frameworks.auditlog.AuditLog;
import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase;

/**
* ConnectedAssetClient is used by applications and tools as a factory for Open
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
package org.odpi.openmetadata.accessservices.assetmanager.client;

import org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription;
import org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase;
import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase;

/**
* OpenMetadataClientBase provides an interface to the open metadata store. This is part of the Governance Action Framework (GAF)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.assetowner.client;

import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase;

/**
* ConnectedAssetClient manages the retrieval of connections, and the creation of resource connectors used to access the
* content of data sources and services.
*/
public class ConnectedAssetClient extends ConnectedAssetClientBase
{
private final static String serviceURLMarker = "community-profile";

/**
* Create a new client with no authentication embedded in the HTTP request.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
*
* @throws InvalidParameterException there is a problem creating the client-side components to issue any
* REST API calls.
*/
public ConnectedAssetClient(String serverName,
String serverPlatformURLRoot) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot);
}


/**
* 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.
*
* @param serverName name of the server to connect to
* @param serverPlatformURLRoot the network address of the server running the OMAS REST services
* @param serverUserId caller's userId embedded in all HTTP requests
* @param serverPassword 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.
*/
public ConnectedAssetClient(String serverName,
String serverPlatformURLRoot,
String serverUserId,
String serverPassword) throws InvalidParameterException
{
super(serviceURLMarker, serverName, serverPlatformURLRoot, serverUserId, serverPassword);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.assetowner.client;

import org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase;
import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase;

/**
* OpenMetadataClientBase provides an interface to the open metadata store. This is part of the Governance Action Framework (GAF)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.communityprofile.client;

import org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase;
import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.ConnectedAssetClientBase;

/**
* ConnectedAssetClient manages the retrieval of connections, and the creation of resource connectors used to access the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.communityprofile.client;

import org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase;
import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworkservices.gaf.client.OpenMetadataClientBase;

/**
* OpenMetadataClientBase provides an interface to the open metadata store. This is part of the Governance Action Framework (GAF)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,22 @@ plugins {
dependencies {
implementation project(':open-metadata-implementation:framework-services:ocf-metadata-management:ocf-metadata-api')
implementation project(':open-metadata-implementation:framework-services:ocf-metadata-management:ocf-metadata-client')
implementation project(':open-metadata-implementation:access-services:data-engine:data-engine-api')
implementation project(':open-metadata-implementation:frameworks:open-connector-framework')
implementation project(':open-metadata-implementation:framework-services:gaf-metadata-management:gaf-metadata-api')
implementation project(':open-metadata-implementation:framework-services:gaf-metadata-management:gaf-metadata-client')
implementation project(':open-metadata-implementation:framework-services:oif-metadata-management:oif-metadata-api')
implementation project(':open-metadata-implementation:framework-services:oif-metadata-management:oif-metadata-client')
implementation project(':open-metadata-implementation:repository-services:repository-services-apis')
implementation project(':open-metadata-implementation:frameworks:audit-log-framework')
implementation project(':open-metadata-implementation:frameworks:governance-action-framework')
implementation project(':open-metadata-implementation:frameworks:open-connector-framework')
implementation project(':open-metadata-implementation:frameworks:open-integration-framework')
implementation project(':open-metadata-implementation:common-services:ffdc-services')
implementation project(':open-metadata-implementation:access-services:data-engine:data-engine-api')
implementation project(':open-metadata-implementation:access-services:data-engine:data-engine-topic-connectors')
implementation project(':open-metadata-implementation:repository-services:repository-services-apis')

implementation project(':open-metadata-implementation:adapters:open-connectors:rest-client-connectors:rest-client-connectors-api')
implementation project(':open-metadata-implementation:repository-services:repository-services-apis')

implementation 'org.springframework:spring-core'
implementation 'org.apache.commons:commons-collections4'
compileOnly 'com.fasterxml.jackson.core:jackson-annotations'
Expand Down
Loading

0 comments on commit 8e84a9b

Please sign in to comment.