Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: extend federated catalogue to allow for goal-oriented skills #183

Merged
merged 6 commits into from
Mar 18, 2024
Merged

feat: extend federated catalogue to allow for goal-oriented skills #183

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9c9360b
feat: move the asset shapes graph into the default graph for easier i…
drcgjung Feb 1, 2024
e1e2546
fix: checkstyle redundant imports.
drcgjung Feb 1, 2024
f59dec9
fix: deal with literal subjects correctly.
drcgjung Feb 1, 2024
73b23aa
feat: move asset-shapes onto the top level of the federated data cata…
drcgjung Feb 9, 2024
65c680b
Merge remote-tracking branch 'eclipse/main' into feature/73-goal-orie…
drcgjung Mar 13, 2024
f233095
chore: fix copyright period upper limit for changed files.
drcgjung Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion ...-plane/agent-plane-protocol/src/main/java/org/eclipse/tractusx/agents/edc/SkillStore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,12 @@ static Matcher matchSkill(String key) {
* @param contract of skill optional
* @param dist of skill required
* @param isFederated whether skill maybe synchronized in catalogue
* @param allowServicePattern regex for service to call in skill
* @param denyServicePattern regex for services denied in skill
* @param ontologies a set of ontologies
* @return skill id
*/
String put(String key, String skill, String name, String description, String version, String contract, SkillDistribution dist, boolean isFederated, String... ontologies);
String put(String key, String skill, String name, String description, String version, String contract, SkillDistribution dist, boolean isFederated, String allowServicePattern, String denyServicePattern, String... ontologies);

/**
* return the skill distribution
Expand Down
36 changes: 19 additions & 17 deletions ...nt-plane-protocol/src/main/java/org/eclipse/tractusx/agents/edc/http/AgentController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ public class AgentController {
protected final SparqlQueryProcessor processor;
protected final DelegationService delegationService;

/**
/**
* creates a new agent controller
*
* @param monitor logging subsystem
* @param monitor logging subsystem
* @param agreementController agreement controller for remote skill/queries
* @param config configuration
* @param processor sparql processor
* @param config configuration
* @param processor sparql processor
*/
public AgentController(Monitor monitor, AgreementController agreementController, AgentConfig config, SparqlQueryProcessor processor, SkillStore skillStore, DelegationService delegationService) {
this.monitor = monitor;
Expand All @@ -95,7 +95,7 @@ public String toString() {
* @return response
*/
@POST
@Consumes({"application/sparql-query", "application/sparql-results+json"})
@Consumes({ "application/sparql-query", "application/sparql-results+json" })
public Response postSparqlQuery(@QueryParam("asset") String asset,
@Context HttpHeaders headers,
@Context HttpServletRequest request,
Expand All @@ -118,7 +118,7 @@ public Response postSparqlQuery(@QueryParam("asset") String asset,
* @return response compatible with graphdb convention
*/
@POST
@Consumes({"application/x-www-form-urlencoded"})
@Consumes({ "application/x-www-form-urlencoded" })
public Response postFormQuery(@QueryParam("asset") String asset,
@Context HttpHeaders headers,
@Context HttpServletRequest request,
Expand All @@ -143,7 +143,7 @@ public Response postFormQuery(@QueryParam("asset") String asset,
*/
@POST
@Path("/repositories/AGENT")
@Consumes({"application/x-www-form-urlencoded"})
@Consumes({ "application/x-www-form-urlencoded" })
public Response postFormRepositoryQuery(@QueryParam("asset") String asset,
@Context HttpHeaders headers,
@Context HttpServletRequest request,
Expand Down Expand Up @@ -429,15 +429,15 @@ public Response executeQuery(String asset, HttpHeaders headers, HttpServletReque
/**
* endpoint for posting a skill
*
* @param query mandatory query
* @param asset asset key
* @param name asset name
* @param query mandatory query
* @param asset asset key
* @param name asset name
* @param description asset description
* @param version asset version
* @param contract asset contract
* @param mode asset mode
* @param version asset version
* @param contract asset contract
* @param mode asset mode
* @param isFederated whether it appears in fed catalogue
* @param ontologies list of ontologies
* @param ontologies list of ontologies
* @return only status
*/
@POST
Expand All @@ -451,11 +451,13 @@ public Response postSkill(String query,
@QueryParam("contract") String contract,
@QueryParam("distributionMode") SkillDistribution mode,
@QueryParam("isFederated") boolean isFederated,
@QueryParam("allowServicesPattern") String allowServicePattern,
@QueryParam("denyServicesPattern") String denyServicePattern,
@QueryParam("ontology") String[] ontologies
) {
monitor.debug(String.format("Received a POST skill request %s %s %s %s %s %b %s ", asset, name, description, version, contract, mode.getMode(), isFederated, query));
monitor.debug(String.format("Received a POST skill request %s %s %s %s %s %b %s %s %s ", asset, name, description, version, contract, mode.getMode(), isFederated, allowServicePattern, denyServicePattern, query));
Response.ResponseBuilder rb;
if (skillStore.put(asset, query, name, description, version, contract, mode, isFederated, ontologies) != null) {
if (skillStore.put(asset, query, name, description, version, contract, mode, isFederated, allowServicePattern, denyServicePattern, ontologies) != null) {
rb = Response.ok();
} else {
rb = Response.status(HttpStatus.SC_CREATED);
Expand All @@ -471,7 +473,7 @@ public Response postSkill(String query,
*/
@GET
@Path("/skill")
@Produces({"application/sparql-query"})
@Produces({ "application/sparql-query" })
public Response getSkill(@QueryParam("asset") String asset) {
monitor.debug(String.format("Received a GET skill request %s", asset));
Response.ResponseBuilder rb;
Expand Down
52 changes: 33 additions & 19 deletions ...-plane-protocol/src/main/java/org/eclipse/tractusx/agents/edc/service/DataManagement.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,9 @@ public class DataManagement {
" \"proxyPath\": \"false\",\n" +
" \"proxyMethod\": \"true\",\n" +
" \"proxyQueryParams\": \"true\",\n" +
" \"proxyBody\": \"true\"\n" +
" }\n" +
" \"proxyBody\": \"true\",\n" +
" \"cx-common:allowServicePattern\": \"%10$s\",\n" +
" \"cx-common:denyServicePattern\": \"%11$s\"\n" +
"}\n";

public static final String SKILL_ASSET_CREATE_BODY_V3 = "{\n" +
Expand Down Expand Up @@ -140,7 +141,9 @@ public class DataManagement {
" \"proxyPath\": \"false\",\n" +
" \"proxyMethod\": \"true\",\n" +
" \"proxyQueryParams\": \"true\",\n" +
" \"proxyBody\": \"true\"\n" +
" \"proxyBody\": \"true\",\n" +
" \"cx-common:allowServicePattern\": \"%10$s\",\n" +
" \"cx-common:denyServicePattern\": \"%11$s\"\n" +
" }\n" +
"}\n";

Expand Down Expand Up @@ -215,10 +218,10 @@ public class DataManagement {
/**
* creates a service wrapper
*
* @param monitor logger
* @param monitor logger
* @param typeManager serialization
* @param httpClient remoting
* @param config typed config
* @param httpClient remoting
* @param config typed config
*/
public DataManagement(Monitor monitor, TypeManager typeManager, OkHttpClient httpClient, AgentConfig config) {
this.monitor = monitor;
Expand All @@ -233,7 +236,7 @@ public DataManagement(Monitor monitor, TypeManager typeManager, OkHttpClient htt
* TODO replace by accessing the federated data catalogue
*
* @param remoteControlPlaneIdsUrl url of the remote control plane ids endpoint
* @param assetId (connector-unique) identifier of the asset
* @param assetId (connector-unique) identifier of the asset
* @return a collection of contract options to access the given asset
* @throws IOException in case that the remote call did not succeed
*/
Expand All @@ -248,7 +251,7 @@ public DcatCatalog findContractOffers(String remoteControlPlaneIdsUrl, String as
* Access the catalogue
*
* @param remoteControlPlaneIdsUrl url of the remote control plane ids endpoint
* @param spec query specification
* @param spec query specification
* @return catalog object
* @throws IOException in case something went wrong
*/
Expand Down Expand Up @@ -313,19 +316,23 @@ public List<Asset> listAssets(QuerySpec spec) throws IOException {
/**
* creates or updates a given asset
*
* @param assetId key
* @param name of skill
* @param description of skill
* @param version of skill
* @param contract of skill
* @param ontologies of skill
* @param distributionMode of skill
* @param isFederated whether it should be distributed
* @param query of skill
* @param assetId key
* @param name of skill
* @param description of skill
* @param version of skill
* @param contract of skill
* @param ontologies of skill
* @param distributionMode of skill
* @param isFederated whether it should be distributed
* @param query of skill
* @param allowServicePattern option allow service pattern
* @param denyServicePattern optional deny service pattern
* @return idresponse
* @throws IOException in case interaction with EDC went wrong
*/
public IdResponse createOrUpdateSkill(String assetId, String name, String description, String version, String contract, String ontologies, String distributionMode, boolean isFederated, String query) throws IOException {
public IdResponse createOrUpdateSkill(String assetId, String name, String description, String version, String contract,
String ontologies, String distributionMode, boolean isFederated, String query, String allowServicePattern,
String denyServicePattern) throws IOException {

String apiVersion = config.isPrerelease() ? "/v2" : "/v3";
var url = String.format(ASSET_CREATE_CALL, config.getControlPlaneManagementProviderUrl(), apiVersion);
Expand All @@ -336,7 +343,14 @@ public IdResponse createOrUpdateSkill(String assetId, String name, String descri
}
String spec = config.isPrerelease() ? ASSET_CREATE_BODY : SKILL_ASSET_CREATE_BODY_V3;

var assetSpec = String.format(spec, assetId, name, description, version, contract, ontologies, distributionMode, isFederated, query);
if (allowServicePattern == null) {
allowServicePattern = config.getServiceAllowPattern().pattern();
}
if (denyServicePattern == null) {
denyServicePattern = config.getServiceDenyPattern().pattern();
}
var assetSpec = String.format(spec, assetId, name, description, version, contract, ontologies, distributionMode,
isFederated, query, allowServicePattern, denyServicePattern);

var request = new Request.Builder().url(url).post(RequestBody.create(assetSpec, MediaType.parse("application/json")));
config.getControlPlaneManagementHeaders().forEach(request::addHeader);
Expand Down
Loading
Loading