Grouper Users - Open Discussion List

["Hyzer, Chris" <>]

I committed a new version of the 2.3 javadoc:

https://cdn.rawgit.com/Internet2/grouper/GROUPER_2_3_BRANCH/grouper/doc/api/

https://spaces.internet2.edu/display/Grouper/Javadoc+in+Git

Thanks
Chris

-----Original Message-----
From: 

 
[mailto:]
 On Behalf Of Scott Koranda
Sent: Thursday, June 22, 2017 5:15 PM
To: grouper-users 
<>
Subject: [grouper-users] Re: constructing GSH commands from the Grouper API

> Hi,
> 
> On this wiki page for GSH
> 
> https://spaces.internet2.edu/pages/viewpage.action?pageId=14517859
> 
> I read
> 
> "Any Grouper API method can be directly invoked just by referencing it,
> inclusive of the class in which it is defined."
> 
> Suppose I want to construct a GSH command or script that finds all
> composite owner groups under a particular stem. How do I inspect the
> Grouper API, other than browsing through GitHub, to find available
> methods that will help me construct the GSH command(s)?
> 
> Is there an up-to-date Javadoc somewhere? 
> 

Apologies for answering my own question.

I did not find an online API Javadoc, but the following process worked:

- Browse to the Internet2/Grouper GitHub repository at

https://github.com/Internet2/grouper/

- Download the current repository. I recommend downloading it rather
  than trying to clone it since it is surprisingly large (binary jar
  files in it?). Unless you plan to hack the code, a download will be
  fine.

- Unzip/untar the downloaded repository and with your web browser browse
  to

  .../grouper-master/grouper/doc/api/index.html

  There you can more easily track down classes and their methods.

- If you want to inspect the source code for the "helper" methods that
  "live" inside of GSH (like the ones you find in the wiki at

  https://spaces.internet2.edu/pages/viewpage.action?pageId=14517859

  ) to understand what they are doing at a lower level, 
  you can find them defined in

  
.../grouper-master/grouper/src/grouper/edu/internet2/middleware/grouper/app/gsh/

  in the source tree you downloaded, or via GitHub at

  
https://github.com/Internet2/grouper/tree/master/grouper/src/grouper/edu/internet2/middleware/grouper/app/gsh

Scott K