Skip to content

DRYD-2233: Update Resteasy Configuration #583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mikejritter wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

DRYD-2233: Update Resteasy Configuration #583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d288515
Add resteasy-servlet-initializer dependency
mikejritter Sep 14, 2026
f72b6b6
Prefer ApplicationPath over servlet-mapping
mikejritter Sep 14, 2026
ce3ee5e
Implement jaxrs Feature instead of ResteasyBoostrap
mikejritter Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions services/JaxRsServiceProvider/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,10 @@
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-multipart-provider</artifactId>
</dependency>
<dependency>
<groupId>org.jboss.resteasy</groupId>
<artifactId>resteasy-servlet-initializer</artifactId>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
Expand Down
92 changes: 46 additions & 46 deletions ...iceProvider/src/main/java/org/collectionspace/services/jaxrs/CSpaceResteasyBootstrap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,24 @@

import static org.nuxeo.elasticsearch.ElasticSearchConstants.ES_ENABLED_PROPERTY;

import javax.servlet.ServletContextEvent;
import java.io.File;
import java.io.InputStream;
import java.lang.reflect.Constructor;
import java.net.URI;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.List;
import java.util.Set;
import javax.ws.rs.core.Feature;
import javax.ws.rs.core.FeatureContext;
import javax.ws.rs.core.PathSegment;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;

import org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap;
import org.jboss.resteasy.specimpl.PathSegmentImpl;
import org.apache.commons.io.IOUtils;
import org.collectionspace.authentication.AuthN;
import org.collectionspace.authentication.CSpaceTenant;
Expand All @@ -32,7 +43,6 @@
import org.collectionspace.services.common.config.TenantBindingConfigReaderImpl;
import org.collectionspace.services.common.query.UriInfoImpl;
import org.collectionspace.services.common.vocabulary.AuthorityResource;

import org.collectionspace.services.config.service.AuthorityInstanceType;
import org.collectionspace.services.config.service.ServiceBindingType;
import org.collectionspace.services.config.service.ServiceBindingType.AuthorityInstanceList;
Expand All @@ -45,27 +55,22 @@
import org.collectionspace.services.jaxb.AbstractCommonList.ListItem;
import org.collectionspace.services.nuxeo.util.NuxeoUtils;
import org.collectionspace.services.report.ReportResource;
import org.jboss.resteasy.core.ResteasyContext;
import org.jboss.resteasy.specimpl.PathSegmentImpl;
import org.jboss.resteasy.spi.Dispatcher;
import org.jboss.resteasy.spi.ResteasyDeployment;
import org.nuxeo.elasticsearch.ElasticSearchComponent;
import org.nuxeo.elasticsearch.api.ElasticSearchService;
import org.nuxeo.runtime.api.Framework;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.InputStream;
import java.lang.reflect.Constructor;
import java.net.URI;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.List;
import java.util.Set;

public class CSpaceResteasyBootstrap extends ResteasyBootstrap {
/**
* Note: this isn't really a proper {@link Feature}, but is just being used as a way to do work once the
* RESTEasyDeployment is available. Previously, this extended ResteasyBootstrap which was causing multiple instances of
* our JaxRsApplication to be created.
*/
public class CSpaceResteasyBootstrap implements Feature {
private static final Logger logger = LoggerFactory.getLogger(CSpaceResteasyBootstrap.class);

private static final String RESET_AUTHORITIES_PROPERTY = "org.collectionspace.services.authorities.reset";
Expand All @@ -77,40 +82,40 @@ public class CSpaceResteasyBootstrap extends ResteasyBootstrap {
private static final String BATCH_PROPERTY = "batch";

@Override
public void contextInitialized(ServletContextEvent event) {
public boolean configure(FeatureContext featureContext) {
try {
//
// This call to super instantiates and initializes our JAX-RS application class.
// The application class is org.collectionspace.services.jaxrs.CollectionSpaceJaxRsApplication.
//
logger.info("Starting up the CollectionSpace Services JAX-RS application.");
super.contextInitialized(event);
CollectionSpaceJaxRsApplication app = (CollectionSpaceJaxRsApplication)deployment.getApplication();
ResteasyDeployment deployment = ResteasyContext.getContextData(ResteasyDeployment.class);
CollectionSpaceJaxRsApplication app = (CollectionSpaceJaxRsApplication) deployment.getApplication();
Dispatcher disp = deployment.getDispatcher();
disp.getDefaultContextObjects().put(ResourceMap.class, app.getResourceMap());

// Property can be set in the tomcat/bin/setenv.sh (or setenv.bat) file
String quickBoot = System.getProperty(QUICK_BOOT_PROPERTY, Boolean.FALSE.toString());

if (Boolean.valueOf(quickBoot) == false) {
if (!Boolean.parseBoolean(quickBoot)) {
// The below properties can be set in the tomcat/bin/setenv.sh (or setenv.bat) file.
String resetAuthsString = System.getProperty(RESET_AUTHORITIES_PROPERTY, Boolean.FALSE.toString());
String resetElasticsearchIndexString = System.getProperty(RESET_ELASTICSEARCH_INDEX_PROPERTY, Boolean.FALSE.toString());
String resetBatchJobsString = System.getProperty(RESET_BATCH_JOBS_PROPERTY, Boolean.TRUE.toString());
String resetReportsString = System.getProperty(RESET_REPORTS_PROPERTY, Boolean.TRUE.toString());

initializeAuthorities(app.getResourceMap(), Boolean.valueOf(resetAuthsString));
initializeAuthorities(app.getResourceMap(), Boolean.parseBoolean(resetAuthsString));

if (Boolean.valueOf(resetElasticsearchIndexString) == true) {
if (Boolean.parseBoolean(resetElasticsearchIndexString)) {
resetElasticSearchIndex();
}

if (Boolean.valueOf(resetReportsString) == true) {
resetReports();
if (Boolean.parseBoolean(resetReportsString)) {
resetReports(app);
}

if (Boolean.valueOf(resetBatchJobsString) == true) {
resetBatchJobs();
if (Boolean.parseBoolean(resetBatchJobsString)) {
resetBatchJobs(app);
}
}

Expand All @@ -119,17 +124,11 @@ public void contextInitialized(ServletContextEvent event) {
e.printStackTrace();
throw new RuntimeException(e);
}
}


@Override
public void contextDestroyed(ServletContextEvent event) {
logger.info("Shutting down the CollectionSpace Services JAX-RS application.");
//Do something if needed.
logger.info("CollectionSpace Services JAX-RS application stopped.");
return true;
}

public void resetReports() throws Exception {
public void resetReports(CollectionSpaceJaxRsApplication app) throws Exception {
logger.info("Resetting reports");

TenantBindingConfigReaderImpl tenantBindingConfigReader = ServiceMain.getInstance().getTenantBindingConfigReader();
Expand Down Expand Up @@ -161,17 +160,17 @@ public void resetReports() throws Exception {
if (reportNames.size() > 0) {
CSpaceTenant tenant = new CSpaceTenant(tenantBinding.getId(), tenantBinding.getName());

resetTenantReports(tenant, reportNames);
resetTenantReports(tenant, reportNames, app);
}
}
}

private void resetTenantReports(CSpaceTenant tenant, Set<String> reportNames) throws Exception {
private void resetTenantReports(CSpaceTenant tenant, Set<String> reportNames, CollectionSpaceJaxRsApplication app)
throws Exception {
logger.info("Resetting reports for tenant {}", tenant.getId());

AuthZ.get().login(tenant);

CollectionSpaceJaxRsApplication app = (CollectionSpaceJaxRsApplication) deployment.getApplication();
ResourceMap resourceMap = app.getResourceMap();
ReportResource reportResource = (ReportResource) resourceMap.get(ReportClient.SERVICE_NAME);

Expand Down Expand Up @@ -245,7 +244,7 @@ private void resetTenantReports(CSpaceTenant tenant, Set<String> reportNames) th
}
}

public void resetBatchJobs() throws Exception {
public void resetBatchJobs(CollectionSpaceJaxRsApplication app) throws Exception {
logger.info("Resetting batch jobs");

TenantBindingConfigReaderImpl tenantBindingConfigReader = ServiceMain.getInstance().getTenantBindingConfigReader();
Expand Down Expand Up @@ -277,17 +276,17 @@ public void resetBatchJobs() throws Exception {
if (batchNames.size() > 0) {
CSpaceTenant tenant = new CSpaceTenant(tenantBinding.getId(), tenantBinding.getName());

resetTenantBatchJobs(tenant, batchNames);
resetTenantBatchJobs(tenant, batchNames, app);
}
}
}

private void resetTenantBatchJobs(CSpaceTenant tenant, Set<String> batchNames) throws Exception {
private void resetTenantBatchJobs(CSpaceTenant tenant, Set<String> batchNames, CollectionSpaceJaxRsApplication app)
throws Exception {
logger.info("Resetting batch jobs for tenant {}", tenant.getId());

AuthZ.get().login(tenant);

CollectionSpaceJaxRsApplication app = (CollectionSpaceJaxRsApplication) deployment.getApplication();
ResourceMap resourceMap = app.getResourceMap();
BatchResource batchResource = (BatchResource) resourceMap.get(BatchClient.SERVICE_NAME);

Expand Down Expand Up @@ -388,7 +387,8 @@ public void resetElasticSearchIndex() throws Exception {
Boolean isElasticsearchIndexed = serviceBinding.isElasticsearchIndexed();
String servicesRepoDomainName = serviceBinding.getRepositoryDomain();

if (isElasticsearchIndexed && servicesRepoDomainName != null && servicesRepoDomainName.trim().isEmpty() == false) {
if (isElasticsearchIndexed && servicesRepoDomainName != null && !servicesRepoDomainName.trim()
.isEmpty()) {
String repositoryName = ConfigUtils.getRepositoryName(tenantBinding, servicesRepoDomainName);
String docType = NuxeoUtils.getTenantQualifiedDocType(tenantBinding.getId(), serviceBinding.getObject().getName());

Expand All @@ -410,7 +410,7 @@ public void initializeAuthorities(ResourceMap resourceMap, boolean reset) throws
Hashtable<String, TenantBindingType> tenantBindingsTable = tenantBindingConfigReader.getTenantBindings(false);
for (TenantBindingType tenantBindings : tenantBindingsTable.values()) {
CSpaceTenant tenant = new CSpaceTenant(tenantBindings.getId(), tenantBindings.getName());
if (shouldInitializeAuthorities(tenant, reset) == true) {
if (shouldInitializeAuthorities(tenant, reset)) {
logger.info("Initializing vocabularies and authorities of tenant '{}'.", tenant.getId());
for (ServiceBindingType serviceBinding : tenantBindings.getServiceBindings()) {
AuthorityInstanceList element = serviceBinding.getAuthorityInstanceList();
Expand Down Expand Up @@ -453,7 +453,7 @@ private boolean shouldInitializeAuthorities(CSpaceTenant cspaceTenant, boolean r
// we're not being asked to reset them, we'll return 'false'
// making any changes
//
return tenantState.isAuthoritiesInitialized() == false || reset == true;
return !tenantState.isAuthoritiesInitialized() || reset;
}

private void setAuthoritiesInitialized(CSpaceTenant cspaceTenant, boolean initState) {
Expand Down
5 changes: 3 additions & 2 deletions ...der/src/main/java/org/collectionspace/services/jaxrs/CollectionSpaceJaxRsApplication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@
import org.collectionspace.services.logout.LogoutResource;

import javax.servlet.ServletContext;
import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;

import java.util.HashSet;
Expand All @@ -109,10 +110,10 @@
* $LastChangedRevision$
* $LastChangedDate$
*/
@ApplicationPath("/")
public class CollectionSpaceJaxRsApplication extends Application implements ResourceMapHolder {

private Set<Object> singletons = new HashSet<>();
private Set<Class<?>> empty = new HashSet<>();
private ResourceMap resourceMap = new ResourceMapImpl();
private ServletContext servletContext = null;

Expand Down Expand Up @@ -203,7 +204,7 @@ private void addResourceToMapAndSingletons(NuxeoBasedResource resource) {

@Override
public Set<Class<?>> getClasses() {
return empty;
return Set.of(CSpaceResteasyBootstrap.class);
}

@Override
Expand Down
17 changes: 0 additions & 17 deletions services/JaxRsServiceProvider/src/main/webapp/WEB-INF/web.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,6 @@
<env-entry-value>CSpaceLoggingContext</env-entry-value>
</env-entry>

<context-param>
<param-name>javax.ws.rs.Application</param-name>
<param-value>org.collectionspace.services.jaxrs.CollectionSpaceJaxRsApplication</param-value>
</context-param>

<context-param>
<param-name>resteasy.servlet.mapping.prefix</param-name>
<param-value>/</param-value>
Expand Down Expand Up @@ -151,22 +146,10 @@
</listener-class>
</listener>

<!-- The CollectionSpace listener that starts up the RESTEasy/JAX-RS service framework. -->
<listener>
<listener-class>
org.collectionspace.services.jaxrs.CSpaceResteasyBootstrap
</listener-class>
</listener>

<servlet>
<servlet-name>Resteasy</servlet-name>
<servlet-class>
org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Resteasy</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>

</web-app>