Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Close the session within resteasy boundaries (#15193)
Closes #15192
- Loading branch information
Showing
10 changed files
with
240 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
...main/java/org/keycloak/quarkus/runtime/integration/jaxrs/TransactionalResponseFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/* | ||
* Copyright 2022 Red Hat, Inc. and/or its affiliates | ||
* and other contributors as indicated by the @author tags. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.keycloak.quarkus.runtime.integration.jaxrs; | ||
|
||
import java.io.IOException; | ||
import java.util.stream.Stream; | ||
import javax.annotation.Priority; | ||
import javax.ws.rs.container.ContainerRequestContext; | ||
import javax.ws.rs.container.ContainerResponseContext; | ||
import javax.ws.rs.container.ContainerResponseFilter; | ||
import javax.ws.rs.container.PreMatching; | ||
import javax.ws.rs.core.StreamingOutput; | ||
import javax.ws.rs.ext.Provider; | ||
import org.keycloak.common.util.Resteasy; | ||
import org.keycloak.models.KeycloakSession; | ||
import org.keycloak.quarkus.runtime.transaction.TransactionalSessionHandler; | ||
|
||
@Provider | ||
@PreMatching | ||
@Priority(1) | ||
public class TransactionalResponseFilter implements ContainerResponseFilter, TransactionalSessionHandler { | ||
|
||
@Override | ||
public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext) | ||
throws IOException { | ||
Object entity = responseContext.getEntity(); | ||
|
||
if (shouldDelaySessionClose(entity)) { | ||
return; | ||
} | ||
|
||
close(Resteasy.getContextData(KeycloakSession.class)); | ||
} | ||
|
||
private static boolean shouldDelaySessionClose(Object entity) { | ||
// do not close the session if the response entity is a stream | ||
// that is because we need the session open until the stream is transformed as it might require access to the database | ||
return entity instanceof Stream || entity instanceof StreamingOutput; | ||
} | ||
} |
48 changes: 48 additions & 0 deletions
48
...java/org/keycloak/quarkus/runtime/integration/jaxrs/TransactionalResponseInterceptor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
/* | ||
* Copyright 2022 Red Hat, Inc. and/or its affiliates | ||
* and other contributors as indicated by the @author tags. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.keycloak.quarkus.runtime.integration.jaxrs; | ||
|
||
import java.io.IOException; | ||
import javax.annotation.Priority; | ||
import javax.ws.rs.ConstrainedTo; | ||
import javax.ws.rs.RuntimeType; | ||
import javax.ws.rs.WebApplicationException; | ||
import javax.ws.rs.ext.Provider; | ||
import javax.ws.rs.ext.WriterInterceptor; | ||
import javax.ws.rs.ext.WriterInterceptorContext; | ||
import org.keycloak.common.util.Resteasy; | ||
import org.keycloak.models.KeycloakSession; | ||
import org.keycloak.quarkus.runtime.transaction.TransactionalSessionHandler; | ||
|
||
@Provider | ||
@ConstrainedTo(RuntimeType.SERVER) | ||
@Priority(10000) | ||
public class TransactionalResponseInterceptor implements WriterInterceptor, TransactionalSessionHandler { | ||
@Override | ||
public void aroundWriteTo(WriterInterceptorContext context) throws IOException, WebApplicationException { | ||
KeycloakSession session = Resteasy.getContextData(KeycloakSession.class); | ||
|
||
try { | ||
context.proceed(); | ||
} finally { | ||
// make sure response is closed after writing to the response output stream | ||
// this is needed in order to support streams from endpoints as they need access to underlying resources like database | ||
close(session); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
...e/src/main/java/org/keycloak/quarkus/runtime/transaction/TransactionalSessionHandler.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
/* | ||
* Copyright 2022 Red Hat, Inc. and/or its affiliates | ||
* and other contributors as indicated by the @author tags. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.keycloak.quarkus.runtime.transaction; | ||
|
||
import static org.keycloak.services.resources.KeycloakApplication.getSessionFactory; | ||
|
||
import org.keycloak.models.KeycloakSession; | ||
import org.keycloak.models.KeycloakSessionFactory; | ||
import org.keycloak.models.KeycloakTransactionManager; | ||
import org.keycloak.services.DefaultKeycloakSession; | ||
|
||
/** | ||
* <p>A {@link TransactionalSessionHandler} is responsible for managing transaction sessions and its lifecycle. Its subtypes | ||
* are usually related to components available from the underlying stack that runs on top of the request processing chain | ||
* as well as at the end in order to create transaction sessions and close them accordingly, respectively. | ||
*/ | ||
public interface TransactionalSessionHandler { | ||
|
||
/** | ||
* Creates a transactional {@link KeycloakSession}. | ||
* | ||
* @return a transactional keycloak session | ||
*/ | ||
default KeycloakSession create() { | ||
KeycloakSessionFactory sessionFactory = getSessionFactory(); | ||
KeycloakSession session = sessionFactory.create(); | ||
KeycloakTransactionManager tx = session.getTransactionManager(); | ||
tx.begin(); | ||
return session; | ||
} | ||
|
||
/** | ||
* Closes a transactional {@link KeycloakSession}. | ||
* | ||
* @param session a transactional session | ||
*/ | ||
default void close(KeycloakSession session) { | ||
if (DefaultKeycloakSession.class.cast(session).isClosed()) { | ||
return; | ||
} | ||
|
||
KeycloakTransactionManager tx = session.getTransactionManager(); | ||
|
||
try { | ||
if (tx.isActive()) { | ||
if (tx.getRollbackOnly()) { | ||
tx.rollback(); | ||
} else { | ||
tx.commit(); | ||
} | ||
} | ||
} finally { | ||
session.close(); | ||
} | ||
} | ||
} |
Oops, something went wrong.