Calling REST Controller from maven dependency - spring-boot

Suppose I have a SpringBoot 2.2.6 WebApp calls app-client and a Maven module calls common-crud where I need to insert some commons Controller. For just an example suppose that the common-crud has just a package with just the follow Controller:
#GetMapping("/sayHelloFromModule")
public ResponseEntity<String> sayHello() {
return new ResonseEntity<String>("Hello", HttpStatus.OK);
}
the .pom.xml of the common-crud maven module is as follows:
<project..
<groupId>com.common</groupId>
<artifactId>common-crud</artifactId>
<version>0.0.1</version>
<packaging>jar</packaging>
<name>common-crud</name>
<properties>
...
</properties>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.6.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>
The app-client is a SpringBoot app and have it's main and so on.. the .pom.xml is:
<project..
<groupId>com.mainapp</groupId>
<artifactId>app-client</artifactId>
<version>0.0.1</version>
<packaging>war</packaging>
<name>app-client</name>
<properties>
...
</properties>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.6.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.common</groupId>
<artifactId>common-crud</artifactId>
<version>0.0.1</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
The main-app is deployed on external Tomcat 8.5.53 with contextRoot mainapp. Now if I open a browser and call:
http://localhost:8080/app-client/<some-controller-inside-mainapp>
It clearly works with no problem.. if I call:
http://localhost:8080/app-client/sayHelloFromModule
throws me Error 404. I don't know if I can realize it in some ways or it is just a bad practice and cannot work in any circumstances.
Clearly the real scenario is more complex.. and the library module should use to profile different type of SpringSecurity Authentication (SAML, JWT, Oauth2.. and so on).
Is there a way to achieve this??
Thank you

It was easier than they appear. In the Main class of mainapp
#SpringBootApplication
#ComponentScan({
"com.client.oauth",
"com.client.resources",
"com.client.security.config",
"com.auth0.core.common",
"com.auth0.core.provider"
})
public class OauthClientApplication extends SpringBootServletInitializer {}
the dependencies packages should be imported

Related

Spring Security Authorization Server (experimental) - Sample projects, from Gradle to Maven (Dependencies)

As recommended here I now want to try the sample projects given in the experimental Authorization Server project.
I use Maven, don't know much about Gradle. I assume, that the samples folder is independent of any other artifact in the Authorization Server project?
I created via start.spring.io the 3 projects, added the missing dependencies manually, and the pom.xml look like this:
authorizationserver
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>authorizationserver</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>authorizationserver</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>15</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.security.experimental</groupId>
<artifactId>spring-security-oauth2-authorization-server</artifactId>
<version>0.1.2</version>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
resourceserver
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>resourceserver</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>resourceserver</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>15</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-oauth2-resource-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
client
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>client</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>client</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>15</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.thymeleaf.extras</groupId>
<artifactId>thymeleaf-extras-springsecurity5</artifactId>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webflux</artifactId>
<version>5.3.9</version>
</dependency>
<dependency>
<groupId>io.projectreactor.netty</groupId>
<artifactId>reactor-netty</artifactId>
<version>1.0.10</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>webjars-locator-core</artifactId>
<version>0.47</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>bootstrap</artifactId>
<version>5.1.0</version>
</dependency>
<dependency>
<groupId>org.webjars</groupId>
<artifactId>jquery</artifactId>
<version>3.6.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
Are these pom.xml correct? Is anything missing, are the versions OK to use, etc.?
I want to change my webservice (Spring Boot, REST controllers) from Basic Auth to OAuth2. My webservice is build with Spring Boot 2.5.3 and OpenJDK 15 (might change to 16) and Maven. That's why I use the latest versions in the pom.xml. But sample projects don't specify versions or use older version, that's why I don't know what versions are OK to use.
Is auth-server necessary or can it be replaced with 127.0.0.1?
AS
return new ProviderSettings().issuer("http://auth-server:9000")
->
return new ProviderSettings().issuer("http://127.0.0.1:9000")
RS
issuer-uri: http://auth-server:9000
->
issuer-uri: http://127.0.0.1:9000
Client
issuer-uri: http://auth-server:9000
->
issuer-uri: http://127.0.0.1:9000
Also, at https://github.com/spring-projects-experimental/spring-authorization-server/tree/main/samples/boot/oauth2-integration there are 4 projects.
The README says
Run Authorization Server
Run Resource Server
Run Client
what for is the project authorizationserver-custom-consent-page ?
I'm asking about the versions I use, latest in fact, because for example I need OpenJDK 15 as I'm using """ all over the place in my webservice project (which will be the Resource Server in context of OAuth2). I cannot therefore switch to versions like Java 8 or so, as stated here:
Prerequisites
Git and the JDK8 build.
Be sure that your JAVA_HOME environment variable points to the jdk1.8.0 folder extracted from the JDK download.
I'm not sure if my problems are related to newer versions of dependencies I use.
Meanwhile, with Maven all 3 projects compile and start, but I'm stuck at the login page. After giving the username and password, it remains on the login page. It seems to accept the user credentials, but loads the login page again. If I misspell the username or password, it complains bad credentials. This is with samples from the downloaded sources of 0.1.2.
It is not stated why auth-server has to be used, and therefore I did the replacements described earlier.
What value will be replaced for registrationId in redirect-uri: "http://127.0.0.1:8080/login/oauth2/code/{registrationId}" ?

Spring boot: error asking to implement all methods in JpaRepository

Why is this happening? It didn't happen when I worked on a spring project in STS few months back.
I have imported the following in the class:
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
Following is my pom.xml:
<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.abcd</groupId>
<artifactId>abcd</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>abcd</name>
<description></description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
A Custom Repository has to be an interface and this has to extend from JpaRepository or CrudRepository or PagingAndSortingRepository or MongoRepository, so update by following way:
#Repository
public interface UserRepository extends JpaRepository<User, Long> {....}
REFERENCES
Official documentation on repositories core concepts

spring boot security properties not working

i am not able to access /beans endpoint after adding the security properties in application.properties.
my all files are like this.
SpringActuator.java
package com.spring.actuator;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
#SpringBootApplication
public class SpringActuatorApp {
public static void main(String[] args) {
SpringApplication.run(SpringActuatorApp.class, args);
}
}
application.properties
management.security.enabled=true
security.user.name=act
security.user.password=act
management.security.roles=ACTUATOR
management.context-path=/manage
pom.xml
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.spring.actuator</groupId>
<artifactId>SpringActuator</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>war</packaging>
<name>SpringActuator</name>
<url>http://maven.apache.org</url>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.6.RELEASE</version>
<relativePath />
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
In all tutorials, configurations are just like this and everybody got running their actuator endpoint. but i am not able do that. please point out any mistake i made.
thanks

why #HystrixCommand which is the annotation of spring injected is failed?

The pom file of my service which is maven project as follow:
<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>hello</groupId>
<artifactId>reading</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-hystrix</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Camden.SR5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
And the part source code of my service as follows:
#HystrixCommand(fallbackMethod = "reliable")
public String readingList(){
URI uri = URI.create("http://localhost:8090/recommended");
return this.restTemplate.getForObject(uri, String.class);
}
My question is, when I import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand, it is not recognized. Anyone encountered this same problem?
Please tell me about how did you resolved it.
Thanks.
According to the latest POM file, it has been deprecated in favour of spring-cloud-starter-netflix-hystrix. STS didn't help me to add the import either, so you might need to add it manually:
import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;

Spring boot app showing 404 for index.html

I have a Spring boot application and a static index.html file located in src/main/resources/static
my controller is straight forward and looks like this
#Controller
#Log4j
public class StartController {
#Autowired
OwnerRepository ownerRepository;
#RequestMapping("/")
public String index() {
return "index";
}
}
my only configuration is the main one and it only has the #SpringBootApplication
Im getting 404 when I hit the URL, as per my understanding no further configuration is needed
by the way in the logs on the startup im seeing the following
URI Template variables for request [/index] are {}
here is my POM
<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.datasol</groupId>
<artifactId>alquifacil</artifactId>
<version>1.0</version>
<packaging>jar</packaging>
<name>AlquiFacil</name>
<description>spring boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.3.1.RELEASE</version>
<relativePath /> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.6</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
On your pom.xml i didn't see any template engine like Thymeleaf, Velocity ecc but you have spring-boot-starter-web, so basically you resource folder its configurated, but you should put your file index.html on templates folder. Static folder serve to contain your asset files.
If you are working local, try:
localhost:8080/ or localhost:8080/alquifacil/ assuming you are using port 8080 or add a template engine dependency in pom.xml like Thymeleaf
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
html is a static resource
so you can access by "localhost:8080/index.html"
or
use "forward" keyword
#RequestMapping("/")
public String index() {
//has to be without blank spaces
return "forward:index.html";
}
please delete the target file and run again. it can be a cashing problem.

Resources