Commit 7b5c03333460fe5993fd808261030ceda784dcf5
1 parent
7d9c853267
Exists in
master
update readme.md
Showing
1 changed file
with
18 additions
and
81 deletions
Show diff stats
README.md
| ... | ... | @@ -3,93 +3,30 @@ |
| 3 | 3 | Simple, easy to use ORCiD client written in Java. Supports the public and Tier2 API with OAuth. Natural object mapping - The entire ORCiD message schema is represented as a hirearchical graph of POJOs with JAXB support for serialisation. |
| 4 | 4 | This work is based on Tom Demeranville Orcid Java Client that is available at [GitHub](https://github.com/TomDemeranville/orcid-java-client) |
| 5 | 5 | |
| 6 | -# Build .jar client | |
| 7 | - | |
| 8 | -You should use maven, version 3, to build the package. | |
| 9 | - | |
| 10 | - mvn clean package | |
| 11 | - | |
| 12 | -A new jar file will be generated on ./target directory: | |
| 13 | - | |
| 14 | - degois-orcid-client-2.0-rc1.jar | |
| 15 | - | |
| 16 | -This jar will include the source code as well as will build all POJOs classes based on XSD schema files using JAXB. | |
| 17 | 6 | |
| 18 | 7 | |
| 19 | 8 | # Requirements to use this client in your project |
| 20 | 9 | |
| 21 | 10 | ## Maven dependencies you will require |
| 22 | - | |
| 23 | -In Maven <properties> section you must indicate the versions of the dependencies | |
| 24 | - | |
| 25 | - <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | |
| 26 | - <java.version>1.8</java.version> | |
| 27 | - <jersey.version>2.22.1</jersey.version> | |
| 28 | - <jaxb2-basics.version>0.9.5</jaxb2-basics.version> | |
| 29 | - <log4j.version>2.4</log4j.version> | |
| 30 | - | |
| 31 | - | |
| 32 | -In Maven <dependencies> section you must include the log4j, jersey client, jaxb, javax dependencies in your project | |
| 33 | - | |
| 34 | - <!-- Log4J --> | |
| 35 | - <dependency> | |
| 36 | - <groupId>org.apache.logging.log4j</groupId> | |
| 37 | - <artifactId>log4j-core</artifactId> | |
| 38 | - <version>${log4j.version}</version> | |
| 39 | - </dependency> | |
| 40 | - | |
| 41 | - <!-- Jersey Client --> | |
| 42 | - <dependency> | |
| 43 | - <groupId>org.glassfish.jersey.core</groupId> | |
| 44 | - <artifactId>jersey-client</artifactId> | |
| 45 | - <version>${jersey.version}</version> | |
| 46 | - </dependency> | |
| 47 | - <dependency> | |
| 48 | - <groupId>org.glassfish.jersey.containers</groupId> | |
| 49 | - <artifactId>jersey-container-servlet</artifactId> | |
| 50 | - <version>${jersey.version}</version> | |
| 51 | - </dependency> | |
| 52 | - <dependency> | |
| 53 | - <groupId>org.glassfish.jersey.media</groupId> | |
| 54 | - <artifactId>jersey-media-json-jackson</artifactId> | |
| 55 | - <version>${jersey.version}</version> | |
| 56 | - </dependency> | |
| 57 | - <dependency> | |
| 58 | - <groupId>org.glassfish.jersey.media</groupId> | |
| 59 | - <artifactId>jersey-media-jaxb</artifactId> | |
| 60 | - <version>${jersey.version}</version> | |
| 61 | - </dependency> | |
| 62 | - | |
| 63 | - <!-- JAXB2 Commons --> | |
| 64 | - <dependency> | |
| 65 | - <groupId>org.jvnet.jaxb2_commons</groupId> | |
| 66 | - <artifactId>jaxb2-basics-runtime</artifactId> | |
| 67 | - <version>${jaxb2-basics.version}</version> | |
| 68 | - </dependency> | |
| 69 | - | |
| 70 | - <!-- javax --> | |
| 71 | - <dependency> | |
| 72 | - <groupId>javax.servlet</groupId> | |
| 73 | - <artifactId>javax.servlet-api</artifactId> | |
| 74 | - <version>3.1.0</version> | |
| 75 | - <scope>provided</scope> | |
| 76 | - </dependency> | |
| 77 | - <dependency> | |
| 78 | - <groupId>javax.ws.rs</groupId> | |
| 79 | - <artifactId>javax.ws.rs-api</artifactId> | |
| 80 | - <version>2.0.1</version> | |
| 81 | - </dependency> | |
| 11 | +```xml | |
| 12 | + <dependency> | |
| 13 | + <groupId>org.um.dsi.gavea</groupId> | |
| 14 | + <artifactId>degois-orcid-client</artifactId> | |
| 15 | + <version>2.0</version> | |
| 16 | + <type>pom</type> | |
| 17 | + </dependency> | |
| 18 | +``` | |
| 19 | +for now you can use the jfrog repository: | |
| 20 | +```xml | |
| 21 | + <repositories> | |
| 22 | + <repository> | |
| 23 | + <id>RCAAP artifactory</id> | |
| 24 | + <name>RCAAP Artifacts-releases</name> | |
| 25 | + <url>https://rcaap.jfrog.io/rcaap/libs-release/</url> | |
| 26 | + </repository> | |
| 27 | + </repositories> | |
| 28 | +``` | |
| 82 | 29 | |
| 83 | - | |
| 84 | -## Maven deploy | |
| 85 | - | |
| 86 | -It will deploy your jar into your localhost /tmp/repo path: | |
| 87 | - | |
| 88 | - mvn deploy:deploy-file -Durl=file:///tmp/repo/ \ | |
| 89 | - -DrepositoryId=localhost \ | |
| 90 | - -Dfile=target/degois-orcid-client-2.0-rc1.jar \ | |
| 91 | - -DpomFile=pom.xml | |
| 92 | - | |
| 93 | 30 | |
| 94 | 31 | ## Java imports in your project |
| 95 | 32 | ... | ... |