[jira] [Created] (SANTUARIO-533) Inconsistent naming of actions SIGNATURE (noun) and ENCRYP (verb)

["Peter De Maeyer (Jira)" <ji...@apache.org>]

Peter De Maeyer created SANTUARIO-533:
-----------------------------------------

             Summary: Inconsistent naming of actions SIGNATURE (noun) and ENCRYP (verb)
                 Key: SANTUARIO-533
                 URL: https://issues.apache.org/jira/browse/SANTUARIO-533
             Project: Santuario
          Issue Type: Bug
          Components: Java
    Affects Versions: Java 2.1.5
            Reporter: Peter De Maeyer
            Assignee: Colm O hEigeartaigh


Inconsistent naming of actions:
* {{XMLSecurityConstants.SIGNATURE}} is a noun.
* {{XMLSecurityConstants.ENCRYPT}} is a verb in the imperative form.

h3. Solution 1
Since both are actions, it would make sense to align both to be a verb in the imperative form, which means renaming {{SIGNATURE}} to {{SIGN}}.

h3. Solution 2
An alternative solution is to align both to be a noun. {{SIGNATURE}} covers both "sign" (writing output) and "verify" (reading input). Similarly, {{ENCRYPT}} covers both "encrypt" and "decrypt". It would be more appropriate to rename {{ENCRYPT}} to {{ENCRYPTION}}

Since it's an essential constant that users are using, it's probably best to keep the old constant deprecated not to break the API.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)