2 * This document is a part of the source code and related artifacts
3 * for CollectionSpace, an open source collections management system
4 * for museums and related institutions:
6 * http://www.collectionspace.org
7 * http://wiki.collectionspace.org
9 * Copyright © 2009 Regents of the University of California
11 * Licensed under the Educational Community License (ECL), Version 2.0.
12 * You may not use this file except in compliance with this License.
14 * You may obtain a copy of the ECL 2.0 License at
15 * https://source.collectionspace.org/collection-space/LICENSE.txt
17 * Unless required by applicable law or agreed to in writing, software
18 * distributed under the License is distributed on an "AS IS" BASIS,
19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20 * See the License for the specific language governing permissions and
21 * limitations under the License.
23 package org.collectionspace.services.jaxrs;
25 import org.collectionspace.services.account.AccountResource;
26 import org.collectionspace.services.blob.BlobResource;
27 import org.collectionspace.services.collectionobject.CollectionObjectResource;
28 import org.collectionspace.services.id.IDResource;
29 import org.collectionspace.services.media.MediaResource;
30 import org.collectionspace.services.note.NoteResource;
31 import org.collectionspace.services.group.GroupResource;
32 import org.collectionspace.services.intake.IntakeResource;
33 import org.collectionspace.services.loanin.LoaninResource;
34 import org.collectionspace.services.loanout.LoanoutResource;
35 import org.collectionspace.services.objectexit.ObjectExitResource;
36 import org.collectionspace.services.batch.BatchResource;
37 import org.collectionspace.services.imports.ImportsResource;
38 import org.collectionspace.services.location.LocationAuthorityResource;
39 import org.collectionspace.services.place.PlaceAuthorityResource;
40 import org.collectionspace.services.concept.ConceptAuthorityResource;
41 import org.collectionspace.services.taxonomy.TaxonomyAuthorityResource;
42 import org.collectionspace.services.movement.MovementResource;
43 import org.collectionspace.services.relation.RelationResource;
44 import org.collectionspace.services.report.ReportResource;
45 import org.collectionspace.services.acquisition.AcquisitionResource;
46 import org.collectionspace.services.dimension.DimensionResource;
47 import org.collectionspace.services.servicegroup.ServiceGroupResource;
48 import org.collectionspace.services.contact.ContactResource;
49 import org.collectionspace.services.vocabulary.VocabularyResource;
50 import org.collectionspace.services.organization.OrgAuthorityResource;
51 import org.collectionspace.services.person.PersonAuthorityResource;
52 import org.collectionspace.services.workflow.WorkflowResource;
54 //import org.collectionspace.services.query.QueryResource;
56 import javax.servlet.ServletContext;
57 import javax.ws.rs.core.Application;
58 import javax.ws.rs.core.Context;
60 import java.util.HashMap;
61 import java.util.HashSet;
65 //import org.collectionspace.services.common.FileUtils;
66 import org.collectionspace.services.authorization.PermissionResource;
67 import org.collectionspace.services.authorization.RoleResource;
68 import org.collectionspace.services.common.*;
69 import org.collectionspace.services.common.security.SecurityInterceptor;
70 import org.jboss.resteasy.core.Dispatcher;
71 import org.jboss.resteasy.spi.ResteasyProviderFactory;
72 //import org.collectionspace.services.common.document.DocumentUtils;
73 //import org.collectionspace.services.common.imaging.nuxeo.NuxeoImageUtils;
74 //import org.collectionspace.services.common.profile.Profiler;
77 * CollectionSpaceJaxRsApplication, the root application
78 * for enumerating Resource classes in the Services Layer,
79 * which in turn respond to and route REST-based requests.
81 * $LastChangedRevision$
84 public class CollectionSpaceJaxRsApplication extends Application
85 implements ResourceMapHolder, UriTemplateRegistryHolder {
87 private Set<Object> singletons = new HashSet<Object>();
88 private Set<Class<?>> empty = new HashSet<Class<?>>();
89 private ResourceMap resourceMap = new ResourceMapImpl();
90 private static UriTemplateRegistry uriTemplateRegistry = new UriTemplateRegistry();
91 private ServletContext servletContext = null;
93 public CollectionSpaceJaxRsApplication() {
95 // Instantiate all our JaxRS resources
97 singletons.add(new SecurityInterceptor());
99 singletons.add(new AccountResource());
100 singletons.add(new RoleResource());
101 singletons.add(new PermissionResource());
102 singletons.add(new ServiceGroupResource());
103 singletons.add(new ImportsResource());
106 addResourceToMapAndSingletons(new VocabularyResource());
107 addResourceToMapAndSingletons(new PersonAuthorityResource());
108 addResourceToMapAndSingletons(new OrgAuthorityResource());
109 addResourceToMapAndSingletons(new LocationAuthorityResource());
110 addResourceToMapAndSingletons(new ConceptAuthorityResource());
111 addResourceToMapAndSingletons(new TaxonomyAuthorityResource());
112 addResourceToMapAndSingletons(new PlaceAuthorityResource());
113 addResourceToMapAndSingletons(new AcquisitionResource());
114 addResourceToMapAndSingletons(new ContactResource());
115 addResourceToMapAndSingletons(new CollectionObjectResource());
116 addResourceToMapAndSingletons(new GroupResource());
117 addResourceToMapAndSingletons(new IntakeResource());
118 addResourceToMapAndSingletons(new DimensionResource());
119 addResourceToMapAndSingletons(new RelationResource());
120 addResourceToMapAndSingletons(new NoteResource());
121 addResourceToMapAndSingletons(new LoaninResource());
122 addResourceToMapAndSingletons(new LoanoutResource());
123 addResourceToMapAndSingletons(new ObjectExitResource());
124 addResourceToMapAndSingletons(new BatchResource());
125 addResourceToMapAndSingletons(new MediaResource());
126 addResourceToMapAndSingletons(new BlobResource());
127 addResourceToMapAndSingletons(new MovementResource());
128 addResourceToMapAndSingletons(new ReportResource());
130 singletons.add(new IDResource());
132 buildUriTemplateRegistry();
133 // FIXME: Temporary for CSPACE-5271 - please remove once
134 // that issue is resolved
135 uriTemplateRegistry.dump();
138 singletons.add(new WorkflowResource());
140 // singletons.add(new QueryResource());
141 // singletons.add(new DomainIdentifierResource());
142 // singletons.add(new PingResource());
145 private void addResourceToMapAndSingletons(ResourceBase resource) {
146 singletons.add(resource);
147 resourceMap.put(resource.getServiceName(), resource);
151 * Build a registry of URI templates by querying each resource
152 * for its own entry in the registry.
154 * That entry consists of a tenant-qualified map of URI templates, each
155 * associated with a specific document type
157 private void buildUriTemplateRegistry() {
158 ResourceBase resource = null;
159 ResourceMap resources = getResourceMap();
160 for (Map.Entry<String, ResourceBase> entry : resources.entrySet()) {
161 resource = entry.getValue();
162 System.out.println(resource.getServiceName()); // for debugging
163 getUriTemplateRegistry().putAll(resource.getUriRegistryEntries());
164 getUriTemplateRegistry().dump(); // for debugging
166 // Contacts itself should not have an entry in the URI template registry;
167 // there should be a Contacts entry in that registry only for use in
168 // building URIs for resources that have contacts as a sub-resource
170 // FIXME: There may be a more elegant way to filter this out; or it may
171 // fall out during implementation of CSPACE-2698
173 // final String CONTACT_DOCTYPE = "Contact";
174 // uriTemplateRegistry.remove(CONTACT_DOCTYPE);
179 public Set<Class<?>> getClasses() {
184 public Set<Object> getSingletons() {
188 public ResourceMap getResourceMap() {
192 public UriTemplateRegistry getUriTemplateRegistry() {
193 return uriTemplateRegistry;
196 public void setServletContext(ServletContext servletContext) {
197 this.servletContext = servletContext;
200 public ServletContext getServletContext() {
201 return this.servletContext;