[GEODE-2092] Security examples should not be in product package

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.0.0-incubating
• Fix Version/s: 1.1.0
• Component/s: docs, security
• Assignee: Kevin Duling
• Reporter: Kirk Lund
• Created: 10/Nov/16 00:56
• Updated: 09/Feb/17 22:51
• Resolved: 14/Dec/16 17:51

Description

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.

Issue Links

• is related to: GEODE-2188 ExampleSecurityManager references SampleSecurityManager in javadoc
• links to: GitHub Pull Request #290