Skip to content

Commit d7a8e5a

Browse files
jodastephenjodastephen
committed
Update README, Travis, License
1 parent b8304db commit d7a8e5a

5 files changed

Lines changed: 289 additions & 1 deletion

File tree

‎.github/deploy-settings.xml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
2+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
4+
https://maven.apache.org/xsd/settings-1.0.0.xsd">
5+
<servers>
6+
<server>
7+
<id>og-public-release</id>
8+
<username>${DEPLOY_USER}</username>
9+
<password>${DEPLOY_PASSWORD}</password>
10+
</server>
11+
</servers>
12+
</settings>

‎.gitignore‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
*~
2+
foo~
3+
*.class
4+
*.log
5+
*.pyc
6+
.project
7+
.classpath
8+
.checkstyle
9+
.pmd
10+
.clover/
11+
.settings/
12+
bin/
13+
target/
14+
temp/
15+
tests/classes/
16+
tests/output/
17+
test-output/
18+
.DS_Store
19+
20+
# IntelliJ config files
21+
*.iws
22+
*.iml
23+
*.ids
24+
.idea/
25+
!.idea/runConfigurations/
26+
atlassian-ide-plugin.xml

‎.travis.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
sudo: required
2+
language: java
3+
jdk:
4+
- oraclejdk8
5+
cache:
6+
directories:
7+
- "$HOME/.m2/repository"
8+
before_cache:
9+
- rm -rf $HOME/.m2/repository/com/opengamma/margining
10+
# install
11+
before_install:
12+
- echo "MAVEN_OPTS='-Xms512m -Xmx2g'" > ~/.mavenrc
13+
install:
14+
- mvn --version
15+
script:
16+
- mvn install -e -B --settings .github/maven-settings.xml
17+
# deploy
18+
after_success:
19+
- if [[ $TRAVIS_TAG =~ ^v.*$ ]] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then mvn deploy -Ddist -DaltDeploymentRepository="og-public-release::default::https://api.bintray.com/maven/opengamma/releases/ServiceClient/" --settings .github/maven-settings.xml; fi
20+
# secure keys for DEPLOY_USER and DEPLOY_PASSWORD
21+
env:
22+
global:
23+
- secure: VGI5Ee0gvq0O5ZluRT2Biq+MLnrXpGqiZZ1YTVOCIJVi58pb6tDGL8jylEyM5uqm5Vnn+nAqelZfnJZUpdAdI5k3+hi/H9zsI86cZ6LkLfA/AzWsNFNjKb971Jnq50s3Sqgs/n1ln+bHjYiLNWWJ+vFgjEGmmMKeM+gR++8o7MNuOyhI+95iVrtgWvytV5bJxYOQlu23qlKqylrz5dr+IhxcsG/m0K6HdB4qESCBPG+zuV0hJ9NtKu7N0wnaLgagcfJvq7aSt+ZaCasebOWaVPXDjbW6Zj8zvHb9uEtIXSZuZzhLAPadqnOn1dPg6SV4d8rDhhwr7w4JlzxT3mqX8jJNJZ1oBTnij27IfEkFN51HDiQ3OjnhFMuzxF7iS2mAbWWzawFGQhYlfeXurMJXWKVFmtPE0ed/SpA0q/Bfcy1fyTIbfv27+j7469jNiOzfI2ntZtC6THU83HZ9DXrI+blE6U5vh4QQF9ryCEV7QAVcmAMkbEAIwUkH2LLDeXiQYWmZv/sXTsHW5MJiQUyxexgsV8r/ZcdbAHsPJyRPR6Qq3/tbxi+6i8buUMEM3PaiL04OVY+t+9agOZvaVH40UlLErxLsTSOa7ibCDnDfrfKxlnZTBQIttrcBE+a1xjX1M5bOyysyqnwJwZtDqZn5Gx3EjDNlZIxBKf+174FntHo=
24+
- secure: OTRbHmfcODn5l9sSOulDgif9VjJiIz+p+nUPwpYA1WBoQJBOq/j7nL0mKtc6JHxqIRWdrrdH/0DfG0bz6VWu+WQf9VMxddleODJjjYI+HQAyiGB0Q8QT29pHEGJGH6pIrRQk1jL5S7RLsGonCNNr3X2s6DNjpbFYoPRh+Yoweku0IgZXAiIjj3Wd168sg6pwE20Yue3lyaHo9jET+uzJ4RT8vJD/XyKcwcr9klfKvYIXv/Y01HZi5IfsnnYnEjXlqpyve5kA9CKaPaQTNtJozwSiLY2Y59p8niZhKU8f9au/iZJCbOl6Ua+5SMFS2TKi6t4FYRVkeUSM/ECcxbzLYFgUCsAod1e4bAPWrBlnodZQJWwKimx7dCzbLcshwN8VxGF1RzDaC3OkSFfF/g5m4ep2rnFZv9VoWqngBQ7UfYlm/VLr9/pzHVCadICOp4x82gj+xLtZXDhaTU5jLpWYNclEiTsJyz75/hwRdhD79gtFra9HuE2Bl6/A7j+XW4O6BLY20Ojdb8ItYiWGJ6vl+nOUxTUYLPQYfDwaOqYPNNwm00FmjrNV6dyCA1dQrCcFCai7lQUvWwHMPaWgZMMx6o+Xs4VA3GibSlYZ81fhHkcTvws5YZVpA4KDz2HPVCCRVuMrlVnKmwGP1AyQKqTBUsVLBGQjvdNpTrrVcjBToNs=

‎LICENSE.txt‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
11
# ServiceClient
2-
Client library for OpenGamma hosted services
2+
3+
[![Build Status](https://travis-ci.org/OpenGamma/ServiceClient.svg?branch=master)](https://travis-ci.org/OpenGamma/ServiceClient) [![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
4+
5+
The OpenGamma service is a platform for the independent calculation of metrics such as margin, fees and balance sheet, to enable firms to optimise execution and clearing of derivatives. The service is available commercially from [OpenGamma](http://www.opengamma.com/).
6+
7+
This repository contains the source code of the client library of the service.
8+
It is released as Open Source Software under the [Apache v2.0 license](http://www.apache.org/licenses/LICENSE-2.0.html).
9+
The client library is only provided in Java, however the service itself can be called from any language.
10+
11+
[![OpenGamma](http://developers.opengamma.com/res/display/default/chrome/masthead_logo.png "OpenGamma")](http://www.opengamma.com)
12+
13+
14+
Using this library
15+
------------------
16+
17+
To use the service client Java SE 8u40 or later is required.
18+
The JAR files are available in [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.opengamma.service%22):
19+
20+
```
21+
<dependency>
22+
<groupId>com.opengamma.service</groupId>
23+
<artifactId>service-client</artifactId>
24+
<version>1.0.0</version>
25+
</dependency>
26+
```

0 commit comments

Comments
 (0)