[jira] [Commented] (GEODE-2092) Security examples should not be in product package

["ASF subversion and git services (JIRA)" <ji...@apache.org>]

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

ASF subversion and git services commented on GEODE-2092:
--------------------------------------------------------

Commit 22ec6a789a1cbf64e1d7677078558e17efb0c668 in geode's branch refs/heads/develop from [~karensmolermiller]
[ https://git-wip-us.apache.org/repos/asf?p=geode.git;h=22ec6a7 ]

GEODE-2092 Update docs with security examples location


> Security examples should not be in product package
> --------------------------------------------------
>
>                 Key: GEODE-2092
>                 URL: https://issues.apache.org/jira/browse/GEODE-2092
>             Project: Geode
>          Issue Type: Bug
>          Components: docs, security
>    Affects Versions: 1.0.0-incubating
>            Reporter: Kirk Lund
>            Assignee: Kevin Duling
>
> These three classes are currently in geode-core product package which implies they are fully supported user API. They cannot be released in a user API package. 
> 1) Move the security examples to examples package within geode-core
> * geode-core/src/main/java/org/apache/geode/security/templates/SampleSecurityManager.java
> * geode-core/src/main/java/org/apache/geode/security/templates/SamplePostProcessor.java
> To:
> * geode-core/src/main/java/org/apache/geode/security/examples/ExampleSecurityManager.java
> * geode-core/src/main/java/org/apache/geode/security/examples/ExamplePostProcessor.java
> Delete this one (it should only exist in some GitHub application for demoing):
> * geode-core/src/main/java/org/apache/geode/security/templates/SimpleSecurityManager.java
> 2) We have geode-core tests that use the security examples. These tests must be altered to use new classes that implement SecurityManager and PostProcessor. These new classes need to live under geode-core/src/tests/java/org/apache/geode/security.
> I also see geode-assembly/src/test/java/org/apache/geode/rest/internal/web/controllers/RedactingPostProcessor.java with javadocs indicating that it is an example. Either a) remove the javadocs saying it's an example or b) move it to geode-core/src/main/java/org/apache/geode/security/examples and then create a new implementation of PostProcessor which the rest tests will use.
> End results should be:
> a) all examples live in either geode-examples or geode-core/src/main/java/org/apache/geode/security/examples
> b) no tests should be using the examples, they should be using test specific implementations under geode-core/src/tests/java
> c) no demoing code should be GEODE -- such code belongs in GitHub or other project repos -- for a really good example, please see:
> * https://github.com/spring-projects/spring-gemfire-examples
> * https://github.com/spring-projects/spring-gemfire-examples/tree/master/quickstart/repository
> If anyone needs help creating an example repo outside of GEODE, then please discuss this on geode dev mailing list.



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