[ https://issues.jboss.org/browse/AS7-5112?page=com.atlassian.jira.plugin.s... ] Tomaz Cerar reassigned AS7-5112: -------------------------------- Assignee: Tomaz Cerar (was: Brian Stansberry) -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa For more information on JIRA, see: http://www.atlassian.com/software/jira

[ https://issues.jboss.org/browse/AS7-5112?page=com.atlassian.jira.plugin.s... ] Jeff Mesnil commented on AS7-5112: ---------------------------------- I think the "deprecated-replacement" property still need to be a (likely i18ned) free-form text. e.g. in the messaging subsystem, I want to deprecate an attribute and replace it by a child subresource. Having a sentence is the best way to transmit this change: I also think we MUST have the version in which the attribute was deprecated. I don't think it is a good idea to make a promise about when this item will be removed. We could have decided it'd be removed in 1.3.0, then we cut this release without removing the attribute by lack of time and now we have to update the attribute *just* to change its removal version. I'd prefer we state the version when the attribute is deprecated and make *no promise* about when it is removed. I'd also remove the deprecated property: having the deprecated-since prop is enough to know the attribute is deprecated. For my messaging's deprecated attribute, that'd give: {noformat} name: roles type: OBJECT value-type: ... deprecated-since: X.Y.Z deprecated-replacement: Use the role children resources instead. {noformat} or depending on the complexity we want for the deprecated information: {noformat} name: roles type: OBJECT value-type: ... deprecated: { since => "X.Y.Z", message => "Use the role children resources instead." } {noformat} I have no strong opinion yet on whether the version should be the subsystem management API or AS version. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira

[ https://issues.jboss.org/browse/AS7-5112?page=com.atlassian.jira.plugin.s... ] Tomaz Cerar commented on AS7-5112: ---------------------------------- Current impl looks like this: example is from messaging subsystem CoreAddressDefinition mgmt code: {code:java} private static final AttributeDefinition ROLES = ObjectListAttributeDefinition.Builder.of(CommonAttributes.ROLES_ATTR_NAME, SecurityRoleDefinition.getObjectTypeAttributeDefinition()) .setFlags(AttributeAccess.Flag.STORAGE_RUNTIME) .setDeprecated(ModelVersion.create(1,2,0)) .build(); {code} dmr output {noformat} ... "roles" => { "type" => LIST, "description" => "Deprecated (use the role children instead). A list of the security roles (name and permissions) associated with the address.", "expressions-allowed" => false, "nillable" => false, "deprecated" => { "since" => "1.2.0", "reason" => "Attribute is deprecated in favor of xyz (todo real reason)" }, "value-type" => { ... {noformat} it automatically looks for "name of attribute".deprecated in this case: {noformat}roles.deprecated=Attribute is deprecated in favor of xyz (todo real reason){noformat} -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira

[ https://issues.jboss.org/browse/AS7-5112?page=com.atlassian.jira.plugin.s... ] Tomaz Cerar commented on AS7-5112: ---------------------------------- yes if "roles.deprecated" does not exist tests fail, same as when descriptions is missing. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira

[ https://issues.jboss.org/browse/AS7-5112?page=com.atlassian.jira.plugin.s... ] Tomaz Cerar commented on AS7-5112: ---------------------------------- example for deprecating operations and/or its prameters {code:java} private static final SimpleAttributeDefinition MIME_NAME = new SimpleAttributeDefinitionBuilder(Constants.NAME, ModelType.STRING, true) .setFlags(AttributeAccess.Flag.RESTART_ALL_SERVICES) .setValidator(new StringLengthValidator(1, true)) .setDeprecated(ModelVersion.create(1,2,0)) .build(); private static final SimpleAttributeDefinition MIME_VALUE = new SimpleAttributeDefinitionBuilder(Constants.VALUE, ModelType.STRING, true) .setFlags(AttributeAccess.Flag.RESTART_ALL_SERVICES) .setValidator(new StringLengthValidator(1, true)) .build(); private static final OperationDefinition ADD_MIME = new SimpleOperationDefinitionBuilder("add-mime", WebExtension.getResourceDescriptionResolver("container.mime-mapping")) .setDeprecated(ModelVersion.create(1,2)) .setParameters(MIME_NAME, MIME_VALUE) .build(); {code} and dmr output {noformat} "operations" => { "add-mime" => { "operation-name" => "add-mime", "description" => "Adds mime type", "request-properties" => { "name" => { "type" => STRING, "description" => "A mime-mapping name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "deprecated" => { "since" => "1.2.0", "reason" => "this attribute is deprecated" } }, "value" => { "type" => STRING, "description" => "A mime-mapping value.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L } }, "reply-properties" => {}, "deprecated" => { "since" => "1.2.0", "reason" => "operation is deprecated" } }, {noformat} -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira

[ https://issues.jboss.org/browse/AS7-5112?page=com.atlassian.jira.plugin.s... ] Tomaz Cerar edited comment on AS7-5112 at 9/5/12 12:10 PM: ----------------------------------------------------------- for latest example, in this case properties added for i18n support ware: {noformat} web.container.mime-mapping.add-mime.deprecated=operation is deprecated web.container.mime-mapping.add-mime.name.deprecated=this attribute is deprecated web.container.mime-mapping.remove-mime.name.deprecated=this attribute is deprecated {noformat} * note that this attributes/operations are not actually deprecated just here to prove a concept was (Author: ctomc): for latest example, in this case properties added for i18n support ware: web.container.mime-mapping.add-mime.deprecated=operation is deprecated web.container.mime-mapping.add-mime.name.deprecated=this attribute is deprecated web.container.mime-mapping.remove-mime.name.deprecated=this attribute is deprecated * note that this attributes/operations are not actually deprecated just here to prove a concept -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira