[ 
https://issues.apache.org/jira/browse/QPID-7095?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15211972#comment-15211972
 ] 

Lorenz Quack commented on QPID-7095:
------------------------------------

Hi Rob,
I just reviewed your patch.

* I am not sure I understand the intended use of the 
{{@ManagedContextDependency}} annotation which is currently unused. Is it that 
we can annotate a class and declare the usage of context variables that are 
define else where? For example the context variable 
{{qpid.security.tls.protocolWhiteList}} is defined as a 
{{ManagedContextDefault}} on the {{Broker}}. The {{Port}} interface would then 
be annotated with 
{{@ManagedContextDependency(value=\{"qpid.security.tls.protocolWhiteList"})}} 
and this would cause the context variable to show up in the ApiDocs for both 
the {{Broker}} as well as the {{Port}}. If that is the intended purpose then I 
don't think it is currently working. The problem is that 
{{ConfiguredObjectTypeRegistry#doWithAllParents}} considers the Java type 
hierarchy and not the Qpid model hierarchy when traversing the parents. So a 
context variable defined on the {{Broker}} will not be detected by the {{Port}}.
* While not being directly related to your patch I think I would like to see 
the default values for {{ManagedAttributes}} and {{ManagedContextDefaults}} in 
the ApiDocs and the MetaData.

> [Java Broker] Add meta data for context variables describing their usage
> ------------------------------------------------------------------------
>
>                 Key: QPID-7095
>                 URL: https://issues.apache.org/jira/browse/QPID-7095
>             Project: Qpid
>          Issue Type: Improvement
>          Components: Java Broker
>            Reporter: Rob Godfrey
>
> Currently there is no way to discover which context variables are used by the 
> broker, and the description of what they do.  We should add meta data 
> covering this and also provide this information through the dynamic API docs.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to