Skip to content

Commit

Permalink
Merge pull request #16 from getyoti/package-names
Browse files Browse the repository at this point in the history
Artefact, module and folder names update
  • Loading branch information
davidgoate authored Sep 17, 2017
2 parents 177a464 + 344434b commit 6278349
Show file tree
Hide file tree
Showing 106 changed files with 60 additions and 60 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,13 @@ If you are using Maven, you need to add the following dependency:
```xml
<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-impl</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-impl</artifactId>
<version>1.3</version>
</dependency>
```
If you are using Gradle, here is the dependency to add:

`compile group: 'com.yoti', name: 'java-sdk-impl', version: '1.2'`
`compile group: 'com.yoti', name: 'yoti-sdk-impl', version: '1.3'`

You will find all classes packaged under `com.yoti.api`

Expand Down Expand Up @@ -184,15 +184,15 @@ Interacting with the `com.yoti.api.client.YotiClient` to get `com.yoti.api.clien

By default the Yoti Client will block indefinitely when connecting to the remote server or reading data. Consequently it is **possible that your application thread could be blocked**.

Since version 1.1 of the `java-sdk-impl` you can set the following two system properties to control this behaviour:
Since version 1.1 of the `yoti-sdk-impl` you can set the following two system properties to control this behaviour:

* `yoti.client.connect.timeout.ms` - the number of milliseconds that you are prepared to wait for the connection to be established. Zero is interpreted as an infinite timeout.
* `yoti.client.read.timeout.ms` - the number of milliseconds that you are prepared to wait for data to become available to read in the response stream. Zero is interpreted as an infinite timeout.

## Modules

The SDK is split into a number of modules for easier use and future extensibility.
### java-sdk-api
### yoti-sdk-api
Being the only interface you need to explicitly couple your code to this module exposes the core classes:
#### HumanProfile
The set of attributes the user has configured for the transaction.
Expand All @@ -202,13 +202,13 @@ Builds a YotiClient instance by automatically selecting the available implementa
Allows your app to retrieve a user profile, given an encrypted token.
#### KeyPairSource and its implementations
A set of classes responsible for working with different sources (e.g. files, classpath resources, URLs) to load the private/public keypair.
### java-sdk-dummy
### yoti-sdk-dummy
Dummy implementation without connectivity to any platform services. Can be used for testing purposes.
### java-sdk-impl
### yoti-sdk-impl
Real SDK implementation that takes care of decrypting the token, fetching the user profile from Yoti servers by issuing a signed request and finally decrypting the fetched profile.
### java-sdk-spring-boot-auto-config
### yoti-sdk-spring-boot-auto-config
A module that can be used in Spring Boot applications to automatically configure the YotiClient and KeyPairSource with standard application properties.
### java-sdk-spring-security
### yoti-sdk-spring-security
A module that can be used in Spring applications that use Spring Security to add Yoti authentication.

## Spring Boot Auto Configuration
Expand All @@ -219,15 +219,15 @@ For more information and to see an example of this in use take a look at the Spr

## Spring Security Integration

If you use Spring Security you can use the `java-sdk-spring-security` module to make integration easier. You are provided with some classes that fit into Spring Security's existing authentication model.
If you use Spring Security you can use the `yoti-sdk-spring-security` module to make integration easier. You are provided with some classes that fit into Spring Security's existing authentication model.

Combining this with the Spring Boot Auto Configuration can make integration very easy with very little code needing to be written.

## Misc

* By default, Yoti SDKs fetch profiles from [https://api.yoti.com/api/v1](https://api.yoti.com/api/v1).
If necessary, this can be overridden by setting the `yoti.api.url` system property.
* Yoti Java SDK uses AES-256 encryption. If you are using the Oracle JDK, this key length is not enabled by default. The following stack overflow question explains how to fix this: [http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters](http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters)
* This SDK uses AES-256 encryption. If you are using the Oracle JDK, this key length is not enabled by default. The following stack overflow question explains how to fix this: [http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters](http://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters)
* To find out how to set up your Java project in order to use this SDK, you can check the Spring Boot example in this repo.

## Known Issues
Expand Down
18 changes: 9 additions & 9 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.yoti</groupId>
<artifactId>java-sdk</artifactId>
<artifactId>yoti-sdk</artifactId>
<packaging>pom</packaging>
<version>1.0</version>
<name>Yoti Java SDK</name>
<name>Yoti SDK</name>
<description>Java SDK for simple integration with the Yoti platform</description>
<url>https://github.com/getyoti/java</url>

Expand All @@ -28,12 +28,12 @@
</developers>

<modules>
<module>java-sdk-api</module>
<module>java-sdk-dummy</module>
<module>java-sdk-impl</module>
<module>java-sdk-spring-boot-auto-config</module>
<module>java-sdk-spring-security</module>
<module>java-sdk-springboot-example</module>
<module>yoti-sdk-api</module>
<module>yoti-sdk-dummy</module>
<module>yoti-sdk-impl</module>
<module>yoti-sdk-spring-boot-auto-config</module>
<module>yoti-sdk-spring-security</module>
<module>yoti-sdk-spring-boot-example</module>
</modules>
<build>
<plugins>
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions java-sdk-api/pom.xml → yoti-sdk-api/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-api</artifactId>
<version>1.2</version>
<name>Yoti Java SDK API</name>
<artifactId>yoti-sdk-api</artifactId>
<version>1.3</version>
<name>Yoti SDK API</name>
<description>Java SDK for simple integration with the Yoti platform</description>
<url>https://github.com/getyoti/java</url>

Expand Down
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions java-sdk-dummy/pom.xml → yoti-sdk-dummy/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-dummy</artifactId>
<version>1.1</version>
<name>Yoti Java SDK mock testing package</name>
<artifactId>yoti-sdk-dummy</artifactId>
<version>1.2</version>
<name>Yoti SDK mock testing package</name>
<description>Java SDK for simple integration with the Yoti platform</description>
<url>https://github.com/getyoti/java</url>

Expand Down Expand Up @@ -116,8 +116,8 @@
<dependencies>
<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-api</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-api</artifactId>
<version>1.3</version>
</dependency>
</dependencies>

Expand Down
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions java-sdk-impl/pom.xml → yoti-sdk-impl/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-impl</artifactId>
<version>1.2</version>
<name>Yoti Java SDK implementation package</name>
<artifactId>yoti-sdk-impl</artifactId>
<version>1.3</version>
<name>Yoti SDK implementation package</name>
<description>Java SDK for simple integration with the Yoti platform</description>
<url>https://github.com/getyoti/java</url>

Expand Down Expand Up @@ -80,8 +80,8 @@
</dependency>
<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-api</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-api</artifactId>
<version>1.3</version>
</dependency>
<!-- Testing dependencies -->
<dependency>
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Yoti Spring Boot Auto Configuration Java SDK Module

This module aims to make integration of the Yoti Java SDK client into Spring Boot projects more simple by reducing the
This module aims to make integration of the Yoti SDK client into Spring Boot projects more simple by reducing the
amount of boilerplate code required by the client application and allows the developer to simply provide two properties.

## Requirements
Expand All @@ -17,16 +17,16 @@ If you are using Maven, you need to add the following dependencies:
```xml
<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-spring-boot-auto-config</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-spring-boot-auto-config</artifactId>
<version>1.3</version>
</dependency>
```


If you are using Gradle, here is the dependency to add:

```
compile group: 'com.yoti', name: 'java-sdk-spring-boot-auto-config', version: '1.2'
compile group: 'com.yoti', name: 'yoti-sdk-spring-boot-auto-config', version: '1.3'
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
</properties>

<groupId>com.yoti</groupId>
<artifactId>java-sdk-spring-boot-auto-config</artifactId>
<version>1.2</version>
<name>Yoti Java Spring Boot Integration</name>
<artifactId>yoti-sdk-spring-boot-auto-config</artifactId>
<version>1.3</version>
<name>Yoti Spring Boot Integration</name>
<description>Library to integrate the Java Yoti SDK with Spring Boot Applications</description>
<url>https://github.com/getyoti/java</url>

Expand Down Expand Up @@ -58,13 +58,13 @@

<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-api</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-api</artifactId>
<version>1.3</version>
</dependency>
<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-impl</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-impl</artifactId>
<version>1.3</version>
</dependency>

<dependency>
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Before you start, you'll need to create an Application in [Dashboard](https://ww
```xml
<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-impl</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-impl</artifactId>
<version>1.3</version>
</dependency>
```

Expand All @@ -28,7 +28,7 @@ Before you start, you'll need to create an Application in [Dashboard](https://ww
1. Run `mvn clean package` to build the project.

## Running
* You can run your server-app by executing `java -jar target/java-sdk-springboot-example-1.2.jar`
* You can run your server-app by executing `java -jar target/yoti-sdk-spring-boot-example-1.3.jar`
* Your endpoint is listening under `https://localhost/login`.

In order to receive calls on your /login endpoint, you need to expose your server-app to the outside world. We require that you use the domain from the Callback URL and HTTPS.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-springboot-example</artifactId>
<version>1.2</version>
<name>Yoti Java Spring Boot Example</name>
<artifactId>yoti-sdk-spring-boot-example</artifactId>
<version>1.3</version>
<name>Yoti Spring Boot Example</name>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
Expand Down Expand Up @@ -33,8 +33,8 @@
<dependencies>
<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-spring-boot-auto-config</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-spring-boot-auto-config</artifactId>
<version>1.3</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@ If you are using Maven, you need to add the following dependencies:
```xml
<dependency>
<groupId>com.yoti</groupId>
<artifactId>yoti-java-sdk-spring-security</artifactId>
<artifactId>yoti-sdk-spring-security</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
```

If you are using Gradle, here is the dependency to add:

```
compile group: 'com.yoti', name: 'yoti-java-sdk-spring-security', version: '1.0-SNAPSHOT'
compile group: 'com.yoti', name: 'yoti-sdk-spring-security', version: '1.0-SNAPSHOT'
```

### Provide a `YotiClient` instance

This can be achieved as outlined in the `java-sdk-spring-boot-auto-config` module.
This can be achieved as outlined in the `yoti-sdk-spring-boot-auto-config` module.

### Provide a `YotiUserService` instance

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</properties>

<groupId>com.yoti</groupId>
<artifactId>yoti-java-sdk-spring-security</artifactId>
<artifactId>yoti-sdk-spring-security</artifactId>
<version>1.0-SNAPSHOT</version>
<name>Spring Security Integration For The Yoti SDK</name>
<description>Library to integrate the Java Yoti SDK with Spring Security</description>
Expand Down Expand Up @@ -52,13 +52,13 @@

<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-api</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-api</artifactId>
<version>1.3</version>
</dependency>
<dependency>
<groupId>com.yoti</groupId>
<artifactId>java-sdk-impl</artifactId>
<version>1.2</version>
<artifactId>yoti-sdk-impl</artifactId>
<version>1.3</version>
</dependency>

<dependency>
Expand Down

0 comments on commit 6278349

Please sign in to comment.