Skip to content

omero.gateway: deprecate BlitzObjectWrapper.getExternalInfo() - #483

Merged
sbesson merged 1 commit into
ome:masterfrom
sbesson:gateway_getExternalInfo_deprecation
Nov 26, 2025
Merged

omero.gateway: deprecate BlitzObjectWrapper.getExternalInfo()#483
sbesson merged 1 commit into
ome:masterfrom
sbesson:gateway_getExternalInfo_deprecation

Conversation

@sbesson

@sbesson sbesson commented Oct 2, 2025

Copy link
Copy Markdown
Member

See #481 and the latest discussion

BlitzObjectWrapper.getDetails().getExternalInfo() should provide the same lazy-loading functionality and return a wrapped ExternalInfo

Consumers who might have adopted the OMERO.py gateway API introduced in #453 should update their code to use the existing object.getDetails().getExternalInfo() API which is separately being fixed with #482.

This approach is consistent with similar metadata like getDetails().getGroup(), getDetails().getOwner() or getDetails().getPermissions(). Unlike BlitzObjectWrapper.getExternalInfo(), this API will return a wrapped ExternalInfo object allowing to use the convenience methods of the gateway e.g. object.getDetails().getExternalInfo().getLsid()

BlitzObjectWrapper.getDetails().getExternalInfo() should provide the
same lazy-loading functionality and return a wrapped ExternalInfo
@sbesson
sbesson requested review from knabar and will-moore October 2, 2025 08:30

@will-moore will-moore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK - It's consistent with other getDetails() methods.
Code changes look good.

@will-moore

Copy link
Copy Markdown
Member

Added a note to https://github.com/ome/omero-web/pull/613/files to drop usage of this method

@sbesson
sbesson merged commit ea9ae45 into ome:master Nov 26, 2025
14 checks passed
@sbesson
sbesson deleted the gateway_getExternalInfo_deprecation branch November 26, 2025 11:06
@github-project-automation github-project-automation Bot moved this from Todo to Done in OMERO.server 5.6.17 Jan 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects

Development

Successfully merging this pull request may close these issues.

3 participants