Skip to content

Commit 20f09ab

Browse files
Merge pull request #73 from softlayer/remove_travisci
Remove Travis CI config. Prep version 0.3.3.
2 parents 2d0a85a + a1e38e9 commit 20f09ab

File tree

8 files changed

+66
-75
lines changed

8 files changed

+66
-75
lines changed

.github/workflows/maven.yml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,15 @@ jobs:
99
runs-on: ubuntu-latest
1010
strategy:
1111
matrix:
12-
java: [8, 11, 15]
12+
java: [8, 11, 16]
1313
steps:
14-
- uses: actions/checkout@v2
15-
- name: Set up JDK
16-
uses: actions/setup-java@v1
17-
with:
18-
java-version: ${{matrix.java}}
19-
- name: Build with Maven
20-
run: mvn -B package --file pom.xml
14+
- name: Checkout
15+
uses: actions/checkout@v2
16+
- name: Set up JDK
17+
uses: actions/setup-java@v2.3.0
18+
with:
19+
distribution: 'temurin'
20+
java-version: ${{matrix.java}}
21+
cache: 'maven'
22+
- name: Build with Maven
23+
run: mvn verify -B -e -V --file pom.xml -Dgpg.skip=true

.github/workflows/pages.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Publish Pages
2+
on:
3+
push:
4+
branches:
5+
- master
6+
jobs:
7+
build-and-deploy:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v2
12+
13+
- name: Build
14+
run: |
15+
apt-get update && apt-get install -y pandoc
16+
mkdir ghpages
17+
pandoc -o ghpages/index.html README.md
18+
19+
- name: Deploy
20+
uses: JamesIves/github-pages-deploy-action@4.1.5
21+
with:
22+
branch: gh-pages
23+
folder: ghpages

.travis.yml

Lines changed: 0 additions & 31 deletions
This file was deleted.

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# SoftLayer API Client for Java
22

3-
![Java CI](https://github.com/softlayer/softlayer-java/workflows/Java%20CI/badge.svg)
3+
[![Java CI](https://github.com/softlayer/softlayer-java/actions/workflows/maven.yml/badge.svg)](https://github.com/softlayer/softlayer-java/actions/workflows/maven.yml)
44
[![Maven Central](https://img.shields.io/maven-central/v/com.softlayer.api/softlayer-api-client)](https://search.maven.org/artifact/com.softlayer.api/softlayer-api-client)
55
[![Javadocs](https://www.javadoc.io/badge/com.softlayer.api/softlayer-api-client.svg)](https://www.javadoc.io/doc/com.softlayer.api/softlayer-api-client)
66

77
## Introduction
88

9-
This library provides a JVM client for the [SoftLayer API](http://sldn.softlayer.com/article/SoftLayer-API-Overview). It
9+
This library provides a JVM client for the [SoftLayer API](https://sldn.softlayer.com/article/getting-started/). It
1010
has code generated and compiled via Maven. The client can work with any Java 8+ runtime. It uses the code generation
1111
project in `gen/` to generate the service and type related code. Although likely to work in resource-constrained
1212
environments (i.e. Android, J2ME, etc), using this is not recommended; Use the
13-
[REST](http://sldn.softlayer.com/article/REST) API instead.
13+
[REST](https://sldn.softlayer.com/article/rest/) API instead.
1414

1515
By default the HTTP client is the Java `HttpUrlConnection` and the JSON marshalling is done by
16-
[Gson](https://code.google.com/p/google-gson/). Both of these pieces can be exchanged for alternative implementations
16+
[Gson](https://github.com/google/gson). Both of these pieces can be exchanged for alternative implementations
1717
(see below).
1818

1919
The `examples/` project has sample uses of the API. It can be executed from Maven while inside the `examples/` folder
@@ -40,20 +40,20 @@ additions to the SoftLayer API.
4040
<dependency>
4141
<groupId>com.softlayer.api</groupId>
4242
<artifactId>softlayer-api-client</artifactId>
43-
<version>0.3.2</version>
43+
<version>0.3.3</version>
4444
</dependency>
4545
```
4646

4747
### Gradle
4848

4949
```groovy
50-
implementation 'com.softlayer.api:softlayer-api-client:0.3.2'
50+
implementation 'com.softlayer.api:softlayer-api-client:0.3.3'
5151
```
5252

5353
### Kotlin
5454

5555
```kotlin
56-
compile("com.softlayer.api:softlayer-api-client:0.3.2")
56+
compile("com.softlayer.api:softlayer-api-client:0.3.3")
5757
```
5858

5959
### Creating a Client
@@ -74,21 +74,23 @@ ApiClient client = new RestApiClient().withCredentials(myUser, myApiKey);
7474
```
7575

7676
#### Access Token
77-
Information on how to get a temoprary api token can be found on the SLDN [Authenticating to the SoftLayer API](https://sldn.softlayer.com/article/authenticating-softlayer-api/#temp-token) article.
77+
Information on how to get a temoprary api token can be found on the SLDN
78+
[Authenticating to the SoftLayer API](https://sldn.softlayer.com/article/authenticating-softlayer-api/#temp-token)
79+
article.
7880

7981
```java
8082
import com.softlayer.api.*;
81-
ApiClient client = new RestApiClient().withBearerToken("qqqqwwwweeeaaassddd....");
83+
ApiClient client = new RestApiClient().withBearerToken(myBearerToken);
8284
```
8385

8486
If the end point isn't at the normal SoftLayer API, you can provide the prefix to the constructor of the
85-
`RestApiClient`. By default it is set to the public API endpoint, `https://api.softlayer.com/rest/v3.1/`.
87+
`RestApiClient`. By default, it is set to the public API endpoint, `https://api.softlayer.com/rest/v3.1/`.
8688

8789
If you are using the classic infrastructure private network, you can communicate with the API over that network by using the service URL instead:
8890

8991
```java
9092
ApiClient client = new RestApiClient(RestApiClient.BASE_SERVICE_URL)
91-
.withCredentials("my user", "my api key");
93+
.withCredentials(myUser, myApiKey);
9294
```
9395

9496
### Making API Calls
@@ -170,7 +172,7 @@ for (Vlan vlan : service.getObject().getNetworkVlans()) {
170172

171173
All values of a type can be masked upon. If a value represents a primitive or collection of primitives, the same mask
172174
it is called on is returned. Otherwise the mask of the other type is given. These translate into SoftLayer's
173-
[string-based object mask format](http://sldn.softlayer.com/article/Object-Masks). A string or an instance of a mask
175+
[string-based object mask format](https://sldn.softlayer.com/article/object-masks/). A string or an instance of a mask
174176
can be given directly by calling `setMask` on the service. Note, when object masks are added on a service object, they
175177
will be sent with every service call unless removed via `clearMask` or overwritten via `withNewMask` or `setMask`.
176178

examples/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<artifactId>softlayer-api-client-examples</artifactId>
66
<packaging>jar</packaging>
77
<!-- Please keep version in sync with README -->
8-
<version>0.3.2</version>
8+
<version>0.3.3</version>
99
<name>softlayer-api-client-examples</name>
1010
<url>http://sldn.softlayer.com</url>
1111
<licenses>
@@ -36,7 +36,7 @@
3636
<plugin>
3737
<groupId>org.codehaus.mojo</groupId>
3838
<artifactId>exec-maven-plugin</artifactId>
39-
<version>1.6.0</version>
39+
<version>3.0.0</version>
4040
<executions>
4141
<execution>
4242
<goals>

gen/pom.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<artifactId>softlayer-api-client-gen</artifactId>
66
<packaging>jar</packaging>
77
<!-- Please keep version in sync with README -->
8-
<version>0.3.2</version>
8+
<version>0.3.3</version>
99
<name>softlayer-api-client-gen</name>
1010
<url>http://sldn.softlayer.com</url>
1111
<licenses>
@@ -29,12 +29,12 @@
2929
<dependency>
3030
<groupId>com.google.code.gson</groupId>
3131
<artifactId>gson</artifactId>
32-
<version>2.8.6</version>
32+
<version>2.8.8</version>
3333
</dependency>
3434
<dependency>
3535
<groupId>junit</groupId>
3636
<artifactId>junit</artifactId>
37-
<version>4.13.1</version>
37+
<version>4.13.2</version>
3838
<scope>test</scope>
3939
</dependency>
4040
</dependencies>
@@ -43,7 +43,7 @@
4343
<plugin>
4444
<groupId>org.codehaus.mojo</groupId>
4545
<artifactId>exec-maven-plugin</artifactId>
46-
<version>1.6.0</version>
46+
<version>3.0.0</version>
4747
<executions>
4848
<execution>
4949
<goals>
@@ -58,7 +58,7 @@
5858
<plugin>
5959
<groupId>org.apache.maven.plugins</groupId>
6060
<artifactId>maven-javadoc-plugin</artifactId>
61-
<version>3.1.1</version>
61+
<version>3.3.1</version>
6262
<configuration>
6363
<source>${java.version}</source>
6464
</configuration>

ghpages_secret.enc

-1.64 KB
Binary file not shown.

pom.xml

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
<artifactId>softlayer-api-client</artifactId>
55
<packaging>jar</packaging>
66
<!-- Please keep version in sync with README -->
7-
<version>0.3.2</version>
7+
<version>0.3.3</version>
88
<name>SoftLayer API Client for Java</name>
99
<description>API client for accessing the SoftLayer API</description>
10-
<url>http://sldn.softlayer.com</url>
10+
<url>https://sldn.softlayer.com</url>
1111
<licenses>
1212
<license>
1313
<name>The MIT License (MIT)</name>
14-
<url>http://opensource.org/licenses/MIT</url>
14+
<url>https://opensource.org/licenses/MIT</url>
1515
<distribution>repo</distribution>
1616
</license>
1717
</licenses>
@@ -28,7 +28,7 @@
2828
<id>camporter</id>
2929
<name>Cameron Porter</name>
3030
<organization>IBM</organization>
31-
<organizationUrl>http://ibm.com/cloud</organizationUrl>
31+
<organizationUrl>https://ibm.com/cloud</organizationUrl>
3232
<roles>
3333
<role>owner</role>
3434
<role>developer</role>
@@ -40,18 +40,12 @@
4040
<connection>scm:git:git@github.com:softlayer/softlayer-java.git</connection>
4141
<developerConnection>scm:git:git@github.com:softlayer/softlayer-java.git</developerConnection>
4242
<url>git@github.com:softlayer/softlayer-java.git</url>
43-
<tag>0.3.2</tag>
43+
<tag>0.3.3</tag>
4444
</scm>
4545
<properties>
4646
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
4747
<java.version>8</java.version>
4848
</properties>
49-
<repositories>
50-
<repository>
51-
<id>jcenter</id>
52-
<url>https://jcenter.bintray.com/</url>
53-
</repository>
54-
</repositories>
5549
<distributionManagement>
5650
<snapshotRepository>
5751
<id>ossrh</id>
@@ -66,12 +60,12 @@
6660
<dependency>
6761
<groupId>com.google.code.gson</groupId>
6862
<artifactId>gson</artifactId>
69-
<version>2.8.6</version>
63+
<version>2.8.8</version>
7064
</dependency>
7165
<dependency>
7266
<groupId>junit</groupId>
7367
<artifactId>junit</artifactId>
74-
<version>4.13.1</version>
68+
<version>4.13.2</version>
7569
<scope>test</scope>
7670
</dependency>
7771
<dependency>
@@ -108,7 +102,7 @@
108102
<plugin>
109103
<groupId>org.apache.maven.plugins</groupId>
110104
<artifactId>maven-javadoc-plugin</artifactId>
111-
<version>3.1.1</version>
105+
<version>3.3.1</version>
112106
<configuration>
113107
<!-- SLDN documentation contains HTML, but it isn't well formatted. -->
114108
<!-- Java 8 will error if we don't skip doclint here -->
@@ -128,7 +122,7 @@
128122
<plugin>
129123
<groupId>org.apache.maven.plugins</groupId>
130124
<artifactId>maven-gpg-plugin</artifactId>
131-
<version>1.6</version>
125+
<version>3.0.1</version>
132126
<executions>
133127
<execution>
134128
<id>sign-artifacts</id>
@@ -142,7 +136,7 @@
142136
<!-- Generate services -->
143137
<plugin>
144138
<artifactId>maven-invoker-plugin</artifactId>
145-
<version>3.2.1</version>
139+
<version>3.2.2</version>
146140
<executions>
147141
<execution>
148142
<id>generate-services</id>
@@ -164,7 +158,7 @@
164158
<plugin>
165159
<groupId>org.jacoco</groupId>
166160
<artifactId>jacoco-maven-plugin</artifactId>
167-
<version>0.8.6</version>
161+
<version>0.8.7</version>
168162
<configuration>
169163
<excludes>
170164
<exclude>**/*com/softlayer/api/service/**/*</exclude>

0 commit comments

Comments
 (0)