Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Still Maintained ? #1

Closed
SyCode7 opened this issue May 12, 2016 · 2 comments
Closed

Still Maintained ? #1

SyCode7 opened this issue May 12, 2016 · 2 comments
Labels
Milestone

Comments

@SyCode7
Copy link

SyCode7 commented May 12, 2016

Hi, this is a good work. Can I know if this is still maintained or integrated into something else ?
Could you also provide some guidelines as to how to use this..like a README.
Thanks.

@br3nt
Copy link
Owner

br3nt commented Aug 5, 2016

Hi @SyCode7, I developed this library as part of a uni project several years ago, so at this point it is not maintained.

For an example of how it all fits together and works have a look at the main method in OMP4J/src/com/omp4j/omp/Client.java. It shows connecting to omp, creating and running a task, and then printing the generated report. Each step is an example of sending and receiving responses to and from omp.

The com.omp4j.opm.Client is the entry point into the library.

The execute method is the lowest level method which sends commands to omp via the command line. It accepts subclasses of com.omp4j.commands.OMPCommand.

An com.omp4j.commands.OMPCommand is little more than an xml document with helper methods. Each of the subclasses creates the necessary xml required to interact with omp.

The com.omp4j.opm.Client#parseResponse method converts the response from omp into an XML document. The resulting document can be passed into the corresponding com.omp4j.responses.OMPResponse subclasses to extract some useful information. Each of the predefined command methods already parse the omp xml response into the correct subclass.

I hope my reply does not come too late and is of some assistance to you.

Feel free to submit pull requests for any fixes that may be required.

br3nt added a commit that referenced this issue Aug 5, 2016
Added some examples and brief explanations as requested in issue #1
@br3nt
Copy link
Owner

br3nt commented Aug 5, 2016

I've updated the readme so it contains the above information too.

@br3nt br3nt added the question label Aug 5, 2016
br3nt added a commit that referenced this issue Aug 5, 2016
Added Q&A to the readme in response to issue #1
@br3nt br3nt added this to the Resolved milestone Aug 5, 2016
@br3nt br3nt closed this as completed Aug 5, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants