Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/stormpath/stormpath-spring-boot-fun-with-custom-data-sample


https://github.com/stormpath/stormpath-spring-boot-fun-with-custom-data-sample

Last synced: 17 days ago
JSON representation

Awesome Lists containing this project

README 

          
#Stormpath is Joining Okta

We are incredibly excited to announce that [Stormpath is joining forces with Okta](https://stormpath.com/blog/stormpaths-new-path?utm_source=github&utm_medium=readme&utm-campaign=okta-announcement). Please visit [the Migration FAQs](https://stormpath.com/oktaplusstormpath?utm_source=github&utm_medium=readme&utm-campaign=okta-announcement) for a detailed look at what this means for Stormpath users.



We're available to answer all questions at [support@stormpath.com](mailto:support@stormpath.com).



# Fun with Stormpath CustomData

#### Oh, yeah - It's also Spring Boot + Spring Security too!



[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)



## The Story so Far



A bunch of us at Stormpath were talking about our favorite books and one of us thought it would be cool to both have a list of these books and

order them by popularity. He setup a private [subreddit](https://reddit.com) for us to do just that.



Only, some of us here at Stormpath don't have reddit accounts. Some of us, don't even like reddit (not naming names, here).



So I thought: "I wonder how hard it would be to implement this book voting system in Stormpath?" 



Well, the answer is it took a couple of days to create, coding it outside of my normal working time (What does that even mean in a startup?)



## What is Stormpath?



Stormpath is a complete identity API. It gives you powerful authentication, authorization, and user management for any application.



Check out the docs for a variety of platforms [here](https://docs.stormpath.com/home/).



[Here](http://docs.stormpath.com/java/spring-boot-web/quickstart.html) is the Java Quickstart. Follow the Quickstart to create a Stormpath account.

That's all you need to get going.



## What the Heck is CustomData?



Stormpath has up to 10MB of text based `CustomData` attached to every first class Object. For example, Every Stormpath Directory, Group and Account can have

`CustomData` attached to it.



The actual data is schema-less JSON. Ordinarily, this would be data would have something to do with your identity management needs. But, there's no rule book.



## Setup your Stormpath Application and Groups



To exercise this app, you'll need to create a Stormpath Application, as well as an Admin Group and a User Group. Make note of the `href` of each of these.

We'll use them later.



Anyone - even someone who is not logged in - can see the list of books ordere by upvote.



Anyone can create an account.



Only members of the User Group you specify can add new books. For the sake of making the app as hands-off as possible, authenticated users can add themselves to the User Group.



Only members of the Admin Group you specify can rebuild the book list. More on that later.



## Data Structure



We're going to use a particular key so as not to interfere with any other `CustomData` you might want to have. Here's a sample of what it looks like:



```

{

  "books": [

    {

      "author": "Dan Suarez",

      "title": "Daemon",

      "url": "http://www.amazon.com/DAEMON-Daniel-Suarez/dp/0451228731/ref=sr_1_1?ie=UTF8&qid=1447719382&sr=8-1&keywords=daemon",

      "votes": 2

    },

    {

      "author": "Dan Suarez",

      "title": "Freedom (TM)",

      "url": "http://www.amazon.com/Freedom-TM-Daniel-Suarez/dp/0451231899/ref=sr_1_1?ie=UTF8&qid=1447795097&sr=8-1&keywords=freedom%28tm%29",

      "votes": 3

    },

    {

      "author": "Neal Stephenson",

      "title": "Snow Crash",

      "url": "http://www.amazon.com/Snow-Crash-Neal-Stephenson/dp/0553380958/ref=sr_1_1?ie=UTF8&qid=1447677686&sr=8-1&keywords=snow+crash",

      "votes": 3

    }

  ]

}

```



The top level key is `books`. It's an array of book data including the number of votes a book has.



The books you submit will be stored in the `CustomData` attached to your Stormpath Account.



Now, here's the tricky bit: The `CustomData` attached to the the User Group you set up earlier will store the aggregated book data. Why?

So that the app is responsive in returning the book data to you. Otherwise, it would need to gather up all the books `CustomData` from 

each member of the User Group and build the book list on the fly.



*Note*: This is not a very scalable app. You would not want to store thousands of books in Stormpath `CustomData`. It is functional and

fun to play with.



## Build and Run



If you want to see this in action right away, use the Deploy button below.



[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)



To build and run locally, do the following:



```

mvn clean package

STORMPATH_API_KEY_FILE= \

STORMPATH_APPLICATION_HREF= \

STORMPATH_AUTHORIZED_GROUP_USER_HREF= \

STORMPATH_AUTHORIZED_GROUP_ADMIN_HREF= \

java -jar target/*.jar

```



## What It Is



Once you are a member of the User Group, you can add new books to the list and you can upvote books from others.



That's pretty much it. There's not a ton of bells and whistles.



## What It Is Not



It's not a SPA (Single Page Application). Making an Angular app out of it would be a fun improvement.



It's not meant to have tons of data. It should be very responsive with a couple of hundred books. It may start to

become less responsive if you have thousands of books. Maybe I'll do a little stress testing to see how it performs

with a ridiculous number of books. I'll keep you posted.



## Known Issues



1. There's an issue with Spring Security and creating a new Account when email verification is turned off.



     You can define Account Registration & Verification workflows in the Directory attached to your Stormpath Application.



     One of these workflows is Verification Email. That is, when a user creates an Account for your application, they will

     get an email with a link in it to verify their Account. By default, this is turned off.

     

     Under these conditions, when you create an Account, you are immediately logged in to the Application. Only, the

     Stormpath Spring Security integration is not properly handling that login event, so it doesn't know you've authenticated.

     

     The workaround is to enable the Verification Email in the Stormpath Admin Console for the Directory associated with

     your Application.

     

This issue will be addressed in a upcoming release and this README will be updated then.