[overlord-issues] [JBoss JIRA] (ARTIF-465) Investigate alternative methods for relationship resolution

[Brett Meyer (JIRA)]

    [ https://issues.jboss.org/browse/ARTIF-465?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13038879#comment-13038879 ] 

Brett Meyer edited comment on ARTIF-465 at 2/9/15 11:37 AM:
------------------------------------------------------------

Relevant (from the S-RAMP spec):

2.3.5.3.1 Resolving Internal References

Some documents have dependencies on other documents. From our earlier scenario, a WSDL document might import an XSD document. When the WSDL document was published to the repository, the XSD document would have been published as well, but the original WSDL document published would not typically have the correct import statement to reference the XSD file which is actually persisted in the repository. More likely, it would be a local reference based on the development environment from which both files originated. It is important that the repository support the capability for tooling to resolve these dependencies to the correct version of the document which is actually published in the repository. S-RAMP provides two implementation choices for achieving this. Compliant implementations SHALL support at least one of them.

1. When returning a requested document, the repository MAY dynamically re-write the document’s references to other documents to correctly reference the appropriate file(s) stored in the repository. The actual document stored in the repository is unaffected. Only the serialized content returned in a GET is altered as the content is returned.
2. When the URL of a document containing dependent links is requested, the repository MAY instead redirect to another URL of its own creation, against which all relative path references to dependent documents will resolve properly with the redirected URL as a base. S-RAMP does not describe how such an implementation is done, only the REQUIRED behavior when implementations choose to support this option.

Regardless of which option is implemented, its activation is achieved by adding the type=relative query string to the URL in the request (a sample URL format is shown here):

/s-ramp/<artifactModel>/<artifactType>/{uuid:artifactDocument}/media?type=relative


was (Author: brmeyer):
Relevant (from the S-RAMP spec):

2.3.5.3.1 Resolving Internal References

Some documents have dependencies on other documents. From our earlier scenario, a WSDL document might import an XSD document. When the WSDL document was published to the repository, the XSD document would have been published as well, but the original WSDL document published would not typically have the correct import statement to reference the XSD file which is actually persisted in the repository. More likely, it would be a local reference based on the development environment from which both files originated. It is important that the repository support the capability for tooling to resolve these dependencies to the correct version of the document which is actually published in the repository. S-RAMP provides two implementation choices for achieving this. Compliant implementations SHALL support at least one of them.

    When returning a requested document, the repository MAY dynamically re-write the document’s references to other documents to correctly reference the appropriate file(s) stored in the repository. The actual document stored in the repository is unaffected. Only the serialized content returned in a GET is altered as the content is returned.
    When the URL of a document containing dependent links is requested, the repository MAY instead redirect to another URL of its own creation, against which all relative path references to dependent documents will resolve properly with the redirected URL as a base. S-RAMP does not describe how such an implementation is done, only the REQUIRED behavior when implementations choose to support this option.

Regardless of which option is implemented, its activation is achieved by adding the type=relative query string to the URL in the request (a sample URL format is shown here):

/s-ramp/<artifactModel>/<artifactType>/{uuid:artifactDocument}/media?type=relative

> Investigate alternative methods for relationship resolution
> -----------------------------------------------------------
>
>                 Key: ARTIF-465
>                 URL: https://issues.jboss.org/browse/ARTIF-465
>             Project: Artificer
>          Issue Type: Feature Request
>            Reporter: Brett Meyer
>            Assignee: Brett Meyer
>
> Investigate increased automatic artifact relationships (ie, service A depends on service B), useful for impact analysis.  Possibly include Java-specific improvements, such as custom annotations (and scanning).



--
This message was sent by Atlassian JIRA
(v6.3.11#6341)